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

Requirements
------------

Genemap has been tested on Python 2.7 and 3.4+.

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

To install genemap, run this command in your terminal:

.. code-block:: console

    $ pip install https://github.com/jrderuiter/genemap/archive/0.2.0.tar.gz

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

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/jrderuiter/genemap

Or download the `tarball`_:

.. code-block:: console

    $ curl  -OL https://github.com/jrderuiter/genemap/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/jrderuiter/genemap
.. _tarball: https://github.com/jrderuiter/genemap/tarball/master