=============
 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| can be obtained from the
   repository located at |repository_versioned|.

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

   .. code-block:: sh

      mkdir -p build && cd build
      cmake -DCMAKE_BUILD_TYPE=debug -DCMAKE_INSTALL_PREFIX=$prefix ..
      make
      make install

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

.. note::

   See the :ref:`tutorial` for notes on how to use the newly installed
   modules from the different supported languages.

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 ``/etc/apt/sources.list``::

  deb http://packages.cor-lab.de/ubuntu/ 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
===============