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

Conda Installation
==================

The simplest means of installing Gravelamps is via the conda package manager.
The latest tagged release of Gravelamps is maintained within the conda-forge
channel and may be installed with

.. code-block:: console

   conda install -c conda-forge gravelamps

Docker Containers
=================

.. note::
   To use the docker containers requires the ability to sign into LVK
   Collaboration services

A docker container containing the latest tagged release of Gravelamps for the
currently supported versions of python are located at

    `containers.ligo.org/gravelamps/gravelamps:python-${VERSION}` 

replacing `${VERSION}` with the desired python version, e.g. `3.12`. An example
of how to pull and run the container would be

.. code-block:: console

   docker login containers.ligo.org
   docker pull containers.ligo.org/gravelamps/gravelamps:python-3.12
   docker -i -t containers.ligo.org/gravelamps/gravelamps:python-3.12 /bin/bash

Manual Installation
===================

Manual installation whilst more difficult has been written to be as easily done
as possible. To begin, clone the git repository

.. code-block:: console

   git clone git@git.ligo.org:gravelamps/gravelamps.git

Next ensure that the following requirements are installed.

  #. ``make``
  #. ``cmake``
  #. ``g++`` (This is included in the `cxx-compiler` package for conda users)
  #. ``libflint``
  #. ``openmp`` (Specifically libgomp)
  #. ``boost``
  #. ``python >= 3.10``
  #. ``pip``

With the pre-requisites installed, the next step is to build and install the
Gravelamps C++ code. This may be done as following from within the Gravelamps
repository folder

.. code-block:: console

   cmake -B build src
   cmake --build build --target install

If installing in a conda environment, in the first line, please also include
the argument `-DCMAKE_INSTALL_PREFIX=${CONDA_PREFIX}` to ensure that Gravelamps
is correctly installed within the environment. With the C++ code installed, the
python code may be installed using the standard

.. code-block:: console

   pip install .