Skip to content

Commit eac2853

Browse files
committed
Add dependencies to the readme.
1 parent 4612bd6 commit eac2853

1 file changed

Lines changed: 38 additions & 10 deletions

File tree

README.rst

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,40 @@ Herr (2010) [Geyer2010]_.
2020

2121
The included Autolev model was originally written by Ton van den Bogert and
2222
adapted by Jason K. Moore. The SymPy Mechanics model was created by Jason to
23-
match the Autolev model results for use with PyDy and opty.
23+
match the Autolev model results and then futher extended for use with PyDy and
24+
opty.
2425

25-
Speed
26-
=====
26+
Dependencies
27+
============
28+
29+
Run time dependencies:
30+
31+
- matplotlib
32+
- numpy
33+
- pydy
34+
- python
35+
- pyyaml
36+
- symmeplot
37+
- sympy
38+
39+
Build dependencies:
40+
41+
- cython [with a C compiler]
42+
- numpy
43+
- python
44+
- setuptools
2745

28-
The cythonized Autolev C code takes about 5 micro seconds per rhs eval and the
29-
PyDy Cython version takes about 15 microseconds (the PyDy version is slower
30-
because of the Python level linear solve on the full mass matrix, but only for
31-
forward dynamics).
46+
Development dependencies:
47+
48+
- pytest
49+
- sphinx
50+
- sphinx_gallery
51+
52+
Dependencies used in the examples:
53+
54+
- cython [with a C compiler]
55+
- opty
56+
- scipy
3257

3358
Install
3459
=======
@@ -48,18 +73,21 @@ Usage
4873
pygait2d
4974
--------
5075

51-
See ``examples/run.py``.
76+
See ``examples/plot_forward_sim.py`` for a basic use example.
5277

5378
algait2de
5479
---------
5580

56-
To manually build the Autolev model and make use of it in Python::
81+
To manually rebuild the Autolev model and make use of it in Python::
5782

5883
$ cd algait2d
5984
$ al gait2de.al
6085
$ python autolevclean.py
6186
$ cd ..
62-
$ python setup.py build_ext --inplace
87+
$ python -m pip install --no-deps --no-build-isolation --editable .
88+
89+
The above will install algait2de and then it is importable and used with::
90+
6391
$ python
6492
>>> from algait2de import gait2de
6593
>>> gait2de.evaluate_autolev_rhs(...)

0 commit comments

Comments
 (0)