Welcome to DynamicistToolKit’s documentation!¶
This is a collection of Python modules which contain tools that are helpful for a dynamicist. Right now it is basically a place I place general tools that don’t necessarily need a distribution of their own.
- Generic tools for basic bicycle dynamics analysis.
- Various functions for calculating and manipulating inertial quantities.
- Various tools for common signal processing tasks.
You will need Python 2.7 or 3.3+ and setuptools to install the packages. Its best to install the dependencies first (NumPy, SciPy, matplotlib, Pandas). The SciPy Stack instructions are helpful for this: http://www.scipy.org/stackspec.html.
We recommend installing with conda so that dependency installation is not an issue:
$ conda install -c moorepants dynamicisttoolkit
You can install using pip. Pip will theoretically  get the dependencies for you (or at least check if you have them):
$ pip install DynamicistToolKit
Or download the source with your preferred method and install manually.
$ git clone email@example.com:moorepants/DynamicistToolKit.git $ cd DynamicistToolKit
$ wget https://github.com/moorepants/DynamicistToolKit/archive/master.zip $ unzip master.zip $ cd DynamicistToolKit-master
Then for basic installation:
$ python setup.py install
Or install for development purposes:
$ python setup.py develop
|||You will need all build dependencies and also note that matplotlib doesn’t play nice with pip.|
Run the tests with nose:
A vagrant file and provisioning script are included to test the code on an Ubuntu 13.10 box. To load the box and run the tests simply type:
$ vagrant up
VagrantFile to see what’s going on.
The documentation is hosted at ReadTheDocs:
You can build the documentation (currently sparse) if you have Sphinx and numpydoc:
$ cd docs $ make html $ firefox _build/html/index.html
- Screwed up pypi upload on 0.5.1, so bumping one more time.
- Fixed bug in butterworth function and added tests.
- Removed pandas dependency.
- Improved time vector function.
- Removed gait analysis code (walk.py), now at http://github.com/csu-hmc/Gait-Analysis-Toolkit.
- TravisCI tests now run, added image to readme.
- Added documentation at ReadTheDocs.
- Addition of walking dynamics module.