.. _installation:

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

.. seealso::

   :ref:`C++ Tutorial <user-tutorial-cpp>`
     Using installed |project| in a C++ project

   :ref:`Java Tutorial <user-tutorial-java>`
     Using installed |project| in a Java project

   :ref:`Python Tutorial <user-tutorial-python>`
     Using installed |project| in a Python project

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

* From source
* Debian Packages

.. _installation-from-source:

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

#. Install the RSC library (Explained as part of :ref:`installing RSB
   <rsb:install-cpp>`).

#. The whole source tree of |project|, including all sub-projects, can
   be obtained by executing the command:

   .. parsed-literal::

      $ git clone |clone_options| |repository|

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

   .. parsed-literal::

      $ cd rst/rst-proto # after "git clone" command
      $ mkdir -p build && cd build
      $ cmake -DCMAKE_BUILD_TYPE=debug -DCMAKE_INSTALL_PREFIX=\ :samp:`{PREFIX}` ..
      $ make
      $ make install

   where :samp:`{PREFIX}` is the directory into which |project| should
   be installed (which is sometimes called "install prefix").

   .. note::

      In case you decided to install |project| into a different prefix than RSC,
      you need to inform `cmake`_ where RSC can be found. This can be achieved by
      adding the following argument to the `cmake`_ call:

      .. parsed-literal::

         -DRSC_DIR=\ :samp:`{RSC_PREFIX}`/share/rsc

#. Optional: Install :term:`converters <converter>` bundled with
   |project|

   .. parsed-literal::

      $ cd rst/rst-converters # from same directory as "git clone" command
      $ mkdir -p build && cd build
      $ cmake -DCMAKE_BUILD_TYPE=debug -DCMAKE_INSTALL_PREFIX=\ :samp:`{PREFIX}` ..
      $ make
      $ make install

   where :samp:`{PREFIX}` is the directory into which the |project|
   :term:`converters <converter>` should be installed.

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

Debian packages for several versions of |ubuntu| are available from
the `CoR-Lab package repository <http://packages.cor-lab.de>`_.

#. The following repository source line has to be added to
   :file:`/etc/apt/sources.list`:

   ..
      edit-on-version-bump
      replace "main testing" with "main" in the released version

   .. parsed-literal::

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

   where :samp:`{RELEASENAME}` is one of |debian_versions|.

#. After that, packages can be installed via

   .. parsed-literal::

      $ sudo apt-get install |debian_package_names|

   Of course, it also possible to only install a subset of the above
   packages.

.. note::

   This installation method only works with |ubuntu|. More information
   can be found `here
   <https://support.cor-lab.org/projects/ciserver/wiki/RepositoryUsage>`_.