.. highlight:: shell

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


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

To install cellmaps_utils, run this command in your terminal:

.. code-block:: console

    $ pip install cellmaps_utils

This is the preferred method to install cellmaps_utils, 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 cellmaps_utils can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/idekerlab/cellmaps_utils

Or download the `tarball`_:

.. code-block:: console

    $ curl  -OL https://github.com/idekerlab/cellmaps_utils/tarball/master

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

.. code-block:: console

    $ python setup.py install


.. note::
    For installation, we suggest a virtual environment like Anaconda_
    set to Python_ 3.8 like so: ``conda create -n cellmaps_env python=3.8``


.. _Github repo: https://github.com/idekerlab/cellmaps_utils
.. _tarball: https://github.com/idekerlab/cellmaps_utils/tarball/master
.. _Python:  https://python.org
.. _Anaconda: https://www.anaconda.com