diff --git a/doc/source/installation.rst b/doc/source/installation.rst index da57ce3c6ee12613dc94652b935cf9791db28bb0..4cdb2ddae5d91f246b32d03d2dc93ce63e572422 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -1,13 +1,82 @@ +.. _installation: + Installation -=============== +============= -You can get a development copy of the gstlal software suite from git. Doing this at minimum will require a development copy of lalsuite. - * https://git.ligo.org/lscsoft/gstlal - * https://git.ligo.org/lscsoft/lalsuite +There are various ways to get started with GstLAL: + + * :ref:`Install the latest release <install-release>`. Pre-built packages are available through various mechanisms. + * :ref:`Use a version provided in an IGWN reference distribution <install-igwn>`. This option is available to members of the International Gravitational-Wave Obervatory Network (IGWN). + * :ref:`Building the package from source <install-source>`. This is needed for users who wish to contribute to the project. + +.. _install-release: + +Installing the latest release +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Docker container (recommended) +"""""""""""""""""""""""""""""" + +The following should pull a GstLAL container and enter an environment with GstLAL and all its dependencies pre-installed: + +.. code:: bash + + $ docker run -it --rm containers.ligo.org/lscsoft/gstlal:latest + +Note that you will need `Docker <https://docs.docker.com/get-docker/>`_ installed. If that is not an option (Docker requires sudo privileges), you can instead use `Singularity <https://sylabs.io/guides/3.7/user-guide/quick_start.html>`_ in place of Docker, which is available on many shared computing resources such as XSEDE and the OSG: + +.. code:: bash + + $ singularity run docker://containers.ligo.org/lscsoft/gstlal:latest + +Conda installation +""""""""""""""""""" + +Install conda using the `miniconda <https://docs.conda.io/projects/conda/en/latest/user-guide/install/>`_ installer, then run: + +.. code:: bash + + $ conda install -c conda-forge gstlal-inspiral + +In order to check your installation, you can use: -Source tarballs for GstLAL packages and all the LIGO/Virgo software dependencies are available here: http://software.ligo.org/lscsoft/source/ +.. code:: bash + + $ conda list gstlal-inspiral # to check which version is installed + $ gstlal_play --help + + +.. _install-igwn: + +IGWN distributions of GstLAL +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you are an IGWN member and have access to shared computing resources, up-to-date GstLAL libraries are available in the set of reference software environments maintained by the IGWN Computing and Software Working Group. + +LIGO Data Grid (LDG) +""""""""""""""""""""" + +GstLAL packages are installed and available by default on the LDG. You can start using the GstLAL library immediately: + +.. code:: bash + + $ gstlal_play --help + +IGWN Conda Distribution +"""""""""""""""""""""""" + +GstLAL is also available on the IGWN Conda Distrubution in a variety of pre-packaged environments. For more information, see `computing.docs.ligo.org/conda/ <https://computing.docs.ligo.org/conda/>`_. + +.. _install-source: + +Building from source +^^^^^^^^^^^^^^^^^^^^^ + +You can get a development copy of the gstlal software suite from git. + + * https://git.ligo.org/lscsoft/gstlal -Limited binary packages are available here: https://wiki.ligo.org/Computing/DASWG/SoftwareDownloads +Source tarballs for GstLAL packages and all the LIGO/Virgo software dependencies are available here: http://software.igwn.org/lscsoft/source/ Building and installing from source follows the normal GNU build procedures involving: