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

Collopak is currently available for Linux, with Mac support planned
for an upcoming release.

The easiest way to get started is to :download:`download
<../scripts/collopak_install>` the installation script and run it as follows
(requires an Internet connection when the script is run)::

    $ bash collopak_install <install_location>

``install_location`` refers to a directory that will be created by the
script. After installation, all Collopak programs are available in the
``bin`` subdirectory of ``<install_location>``. For example, the
``collopak_version`` program reports the currently installed Collopak
release::

    $ /home/gregq/collopak/bin/collopak_version
    0.1.39

Upgrading to the most recent release can be done by running the
``collopak_update`` command included in Collopak.

Installation via Conda
----------------------

Collopak is packaged with the `Conda package manager <http://conda.pydata.org/docs/>`_,
so if you are familiar with that ecosystem you can use it directly to install Collopak.
Just use the ``greg9q`` channel hosted at `Anaconda Cloud <https://anaconda.org/>`_::

    $ conda install -c greg9q collopak