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 github and can be cloned using git as follows:

git clone

alternatively a tarball of the source can be downloaded here

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

python install

Build the Documentation

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

sphinx-build docs html

This will place documents in html within the project directory.

Alternatively this documentation is hosted at