.. highlight:: shell

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


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

For a conda environment with necessary packages:

.. code-block:: console

    $ conda env create -f environment.yml


To install celltraj, run this command in your terminal:
    
.. code-block:: console
    
    $ pip install celltraj
    
This is the preferred method to install celltraj, as it will always install the most recent 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 celltraj can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/jcopperm/celltraj

Or download the `tarball`_:

.. code-block:: console

    $ curl -OJL https://github.com/jcopperm/celltraj/tarball/master


.. _Github repo: https://github.com/jcopperm/celltraj
.. _tarball: https://github.com/jcopperm/celltraj/tarball/master