.. _installation:

************
Installation
************

Install Using Pip
=================

If you have `Pip <http://www.pip-installer.org/>`_ type the following to install ``atsim.potentials``:

.. code:: sh
	
	pip install atsim.potentials


Install from Source
===================

The source is hosted on `github`_ and can be cloned using `git`_ as follows:

.. code:: sh

	git clone https://github.com/mjdrushton/atsim-potentials.git



alternatively a tarball of the source can be downloaded `here <https://github.com/mjdrushton/atsim-potentials/archive/master.zip>`_ 

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

.. code:: sh

	python setup.py install


Build the Documentation
-----------------------

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

.. code:: sh

	sphinx-build docs html


This will place documents in ``html`` within the project directory. 

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


.. _github: https://github.com/mjdrushton/atsim-potentials
.. _git: https://git-scm.com