.. _installation_instructions:

Installation Instructions
*************************

The streamm package is written for `python2.7 <https://www.python.org/download/releases/2.7/>`_.
You can install python on most systems using `Anaconda <https://www.anaconda.com/>`_.

pip install
===========

To install the streamm package with pip run::

    $ pip install streamm

This will create an egg file and place it in your package management  directory of the default version of python on your machine.

Github
======

You can also install the streamm package from source  by cloning the `Github <https://github.com/>`_ repo::

    $ git clone https://github.com/NREL/streamm-tools
    
By navigating to the package directory::
    
    $ cd streamm-tools
    
and running::

    $ python setup.py install 

The tests can be run using ::

    $ python setup.py test

The package is open-source and can be forked and modified from the repository: `streamm-tools <https://github.com/NREL/streamm-tools>`_.