Installation

Install Using Pip

If you have Pip type the following to install atsim.potentials:

pip install atsim.potentials

Install from Source

The source is hosted on bitbucket and can be cloned using mercurial as follows:

hg clone https://bitbucket.org/mjdr/atsim_potentials

alternatively a tarball of the source can be downloaded from the bitbucket downloads page here

From the source directory install atsim.potentials using the following command:

python setup.py install

Build the Documentation

The documentation (which you are currently reading) can be built from source using (assuming sphinx is installed):

python setup.py build_sphinx

This will place documents in build/sphinx/html within the source tree.

Alternatively this documentation is hosted at http://atsimpotentials.readthedocs.org