.. highlight:: shell

============
Installation
============


Stable release
--------------

To install TauFactor, run this command in your terminal:

.. code-block:: console

    $ pip install taufactor

This is the preferred method to install TauFactor, as it will always install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


Development
########

These instructions are for running TauFactor in a development environment (i.e. not using the PyPI package)

To access the most recent development branch, run::

    git clone --recursive https://github.com/tldr-group/taufactor.git
    cd taufactor
    pip install .

.. _Github repo: https://github.com/tldr-group/taufactor
.. _tarball: https://github.com/tldr-group/taufactor/tarball/master