************
Installation
************

Requirements
============

Donuts has the following requirements:

* `Python <https://www.python.org>`__ 2.7, 3.4 or 3.5
* `Astropy <http://www.astropy.org/>`__ 1.0 or later
* `Numpy <http://www.numpy.org>`__ 1.9 or later
* `Scipy <https://www.scipy.org>`__ 0.15 or later
* `scikit-image <http://scikit-image.org/>`__ 0.12 or later

Installation from pip
=====================

The package is released as ``donuts`` on pip::

    pip install donuts

Installation from source
========================

If you wish to install the latest version from the git repository, either run::

    pip install git+https://github.com/jmccormac01/Donuts

or clone the source somewhere, and install through ``setup.py``::

    git clone https://github.com/jmccormac01/Donuts
    cd Donuts
    git checkout <branch>       # optionally check out a branch
    python setup.py install