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

Shifterator requires Python 3.6 or higher.

The following packages are also required:

- `Matplotlib <https://matplotlib.org/index.html>`_
- `NumPy <https://numpy.org/>`_

Install Latest Release
----------------------

The latest release of :code:`shifterator` is available via :code:`pip`.

.. code-block:: bash

    pip install shifterator

Install Development Version
---------------------------

The latest development branch of :code:`shifterator` is available `on Github <https://github.com/ryanjgallagher/shifterator>`_:

.. code-block:: bash

    git clone https://github.com/ryanjgallagher/shifterator.git
    cd shifterator
    pip install -e .