.. _install:

Installation
######################

After cloning the ``gpilib2`` git repository, navigate to the top-level directory of the repository and execute:

.. code-block::

    pip install --user -e .

This will install both the ``gpilib2`` package as well as all of its dependencies.  The ``-e`` flag installs the package in developer (editable) mode, such that any changes made in the local copy of the codebase will be reflected at runtime with no need to reinstall.

Environment Variables
------------------------

The following environment variables must be set in order for ``gpilib2`` to function properly:

* ``TLC_ROOT``: Full path to TLC root directory, which contains the ``src``, ``config`` and ``bin`` directories.  For operating GPI, this should point to a mount to the :term:`TLC` itself. For simulated operation, this should point to a clone of the TLC git repository.
* ``CAL_ROOT``: Full path to CAL root directory, which contains the ``config`` and ``data`` directories. For operating GPI, this must point to a mount on the :term:`CAL`. For simulated operation it is unused.

For finer control, the following environment values can be used:

* ``TLC_BIN_DIR``: Full path to the directory that contains all compiled TLC executables.  By default, this is ``$TLC_ROOT/bin/linux64``.
* ``TLC_CONFIG_DIR``: Full path to the directory that contains all TLC configuration files.  By default, this is ``$TLC_ROOT/config``.
* ``TLC_LOG_DIR``: Full path to the directory that contains all TLC logs.  By default, this is ``$TLC_ROOT/log``.