=============
 Preparation
=============

.. _installation:

Installing |project|
====================

There are currently two ways to install the |version| version of
|project|:

* From source
* Debian Packages

.. _installation-from-source:

From Source
-----------

#. The whole source tree of |project|, included all sub-projects, can
   be obtained from the repository located at:

   .. parsed-literal::

      $ git clone -b |version| --recursive |repository|

#. After that, |project| can be built and installed like this:

   .. parsed-literal::

      $ mkdir -p build && cd build
      $ cmake -DCMAKE_BUILD_TYPE=debug -DCMAKE_INSTALL_PREFIX= :samp:`{PREFIX}` ..
      $ make
      $ make install

   where :samp:`{PREFIX}` is the desired install prefix.

.. note::

   To use the resulting |project| installation in Python programs, the
   :envvar:`PYTHONPATH` environment variable has to contain the
   ``site-packages`` directory of the installation prefix, e.g.::

     /usr/local/lib/python2.6/site-packages

   when installing to prefix ``/usr/local/``.

Debian Packages
---------------

Debian packages for several versions of |ubuntu| are available from
the `CoR-Lab package repository
<http://packages.cor-lab.de/ubuntu/dists/>`_. The following repository
source line has to be added to :file:`/etc/apt/sources.list`:

.. parsed-literal::

   deb http://packages.cor-lab.de/ubuntu/ :samp:`{RELEASENAME}` testing

where :samp:`{RELEASENAME}` is the appropriate Ubuntu release name.

.. warning::

   This installation method only works with |ubuntu|.

.. note::

   More information can be found `here
   <https://support.cor-lab.org/projects/ciserver/wiki/RepositoryUsage>`_.

Testing the Installation
========================

Troubleshooting
===============