.. highlight:: shell

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


Stable release
--------------
For a conda environment with necessary packages:
.. code-block:: console

    $ conda env create -f environment.yml

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

You can either clone the public repository:

.. code-block:: console

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

Or download the `tarball`_:

.. code-block:: console

    $ curl -OJL https://github.com/jcopperm/syncell/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/jcopperm/syncell
.. _tarball: https://github.com/jcopperm/syncell/tarball/master