Installing RnaChipIntegrator
============================

Installing the latest version
*****************************

The recommended method is to install the latest version of the program
directly from the Python Package Index (PyPI) using::

    pip install RnaChipIntegrator

You may need to have root privileges to install to the system
directories, in which case preface this command with ``sudo`` i.e.::

    sudo pip install RnaChipIntegrator

Alternatively you can use Python's ``virtualenv`` mechanism to install
a non-root version (this example creates one under ``.venv``)::

    virtualenv .venv; . .venv/bin/activate
    pip install RnaChipIntegrator

Installing older versions
*************************

All versions of the program can be found via:

 * https://github.com/fls-bioinformatics-core/RnaChipIntegrator/releases

To install a specific version of the program download the ``.tar.gz`` or
``.zip`` file from the above site and install using one of the ``pip``
recipes above, for example::

    pip install RnaChipIntegrator-0.4.4.tar.gz

Installing directly from GitHub (advanced users/developers)
***********************************************************

``pip`` can be used to install directly from GitHub::

    pip install git+https://github.com/fls-bioinformatics-core/RnaChipIntegrator

To install a specific version (e.g. ``v0.5.0``)::

    pip install git+https://github.com/fls-bioinformatics-core/RnaChipIntegrator@v0.5.0

To install the ``devel`` branch::

    pip install git+https://github.com/fls-bioinformatics-core/RnaChipIntegrator@devel

Uninstalling RnaChipIntegrator
==============================

To remove the program do::

    pip uninstall RnaChipIntegrator

