Installing / Using
==================

Enviroment
----------

The first step is to set the DSEPRoot enviromental variable. This should
point to a directory which contains DSEPMisc and dsepX (and likely
DSEPDoc). So in your shell profile there should be a line such as

.. code:: bash

   DSEPRoot = "/path/to/folder/with/DSEPMisc/and/dsepX/in/it"

Dependencies
------------

Now you can intall the dependencies

.. code:: bash

   pip install -r requirments.txt

Linux
~~~~~

Additionally, you need the boost libraries for c++. Pysep uses boost to
memory map large files (such as large track files) so that they can be
opened and parsed more efficiently. The exact install directions depend
on your distribution. For Arch derivitive installations

Arch/Manjaro/Garuto/Antegros
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: bash

   sudo pacman -Syu boost
   sudo pacman -Syu boost-libs

Ubuntu/Mint/ElementeryOS
^^^^^^^^^^^^^^^^^^^^^^^^

For ubuntu (and ubuntu derived distos such as mint)

.. code:: bash

   sudo apt-get install libboost-all-dev

Fedorah/CentOS/RHEL
^^^^^^^^^^^^^^^^^^^

For fedorah (and its derived distributions)

.. code:: bash

   sudo yum install boost-devel

macOS
~~~~~

On macOS if you have MacPorts installed you can use

.. code:: bash

   sudo port install boost

or if you prefer to use homebrew you can use

.. code:: bash

   brew install boost 

Package Installation
--------------------

And finally the package itself

.. code:: bash

   python setupy.py install