==============================
Bicycleparameters Installation
==============================
Dependencies
============
These are the versions that I tested the code with, but the code will most
likely work with older versions.
Required
--------
- `Python 2.7 `_
- `Scipy >= 0.9.0 `_
- `Numpy >= 1.6.1 `_
- `Matplotlib >= 1.1.1 `_
- `Uncertainties >= 2.0.0 `_
- `yeadon >= 1.1.0 `_
- `DynamicistToolKit >= 0.1.0
`_
Optional
--------
These are required to bulid the documentation:
- `Sphinx `_
- `Numpydoc `_
Installation
============
The easiest method to download and install is with ``pip``::
$ pip install BicycleParameters
There are currently two options for getting the source code:
1. Clone the source code with Git: ``git clone
git://github.com/moorepants/BicycleParameters.git``
2. `Download the source from Github`__.
3. Dowload the source from pypi__.
.. __: https://github.com/moorepants/BicycleParameters
.. __: http://pypi.python.org/pypi/BicycleParameters
Once you have the source code navigate to the directory and run::
>>> python setup.py install
This will install the software into your system and you should be able to
import it with::
>>> import bicycleparameters