.. highlight:: shell

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


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

Olftrans is not currently served on PyPI.
Refer to section below for building the pacakge from source.

.. To install OlfTrans, run this command in your terminal:

.. .. code-block:: console

..     $ pip install olftrans

.. This is the preferred method to install OlfTrans, 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/


From sources
------------

The sources for OlfTrans can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/FlyBrainLab/olftrans

Or download the `tarball`_:

.. code-block:: console

    $ curl -OJL https://github.com/FlyBrainLab/olftrans/tarball/master

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ python setup.py install


.. _Github repo: https://github.com/FlyBrainLab/olftrans
.. _tarball: https://github.com/FlyBrainLab/olftrans/tarball/master