.. highlight:: shell

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


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

Requirements
************

* **Python 3**
* **click** (https://palletsprojects.com/p/click/)
* **click-log** (https://github.com/click-contrib/click-log)
* **pandas** (https://pandas.pydata.org/)

To install genotype_variants, run this command in your terminal:

.. code-block:: console

    $ pip install genotype_variants

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

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/rhshah/genotype_variants

Or download the `tarball`_:

.. code-block:: console

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