.. highlight:: shell

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


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

To install roman_snpit_utils, run this command in your terminal:

.. code-block:: console

    $ pip install snpit_utils

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

You can either clone the public repository:

.. code-block:: console

    $ git clone git@github.com:Roman-Supernova-PIT/snpit_utils.git

Or download the `tarball`_:

.. code-block:: console

    $ curl -OJL https://github.com/Roman-Supernova-PIT/snpit_utils/tarball/master

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

.. code-block:: console

    $ pip install .

If you would like to do an editable install:

.. code-block:: console

    $ pip install -e .
    $ pip install -e .[docs]  # install document build packages during install


.. _Github repo: https://github.com/Roman-Supernova-PIT/snpit_utils
.. _tarball: https://github.com/Roman-Supernova-PIT/snpit_utils/tarball/master