GWOLLUM  4.2.0
Tools for gravitational-wave analyses

The GWOLLUM package contains a set of software tools designed to perform gravitational-wave analyses:

  • Utilities: C++ utilities, Fourier transform interface, plotting interface, signal processing and filtering...
  • Time segment management (Segments class)
  • GW frame data interface (ffl class)
  • Network of gravitational-wave detectors
  • Software injections of signal waveforms in the data (InjEct class)
  • Triggers management (MakeTriggers and ReadTriggers classes)
  • Coincidence between triggers (Coinc2 class)

The source code of GWOLLUM is written with the C++ language. It relies on the CERN ROOT libraries (also C++).

User programs

GWOLLUM comes with a collection of user programs using GWOLLUM libraries:

Develop a project on top of GWOLLUM libraries

GWOLLUM offers a set of C++ classes to run gravitational-wave analyses. The corresponding libraries can be used to develop user programs or projects:

Install GWOLLUM (conda)

Install GWOLLUM from the conda-forge channel:

conda create -c conda-forge --name gwollum gwollum

Simply activate your gwollum environment to use GWOLLUM libraries and programs:

conda activate gwollum

Build GWOLLUM from sources

First, define your source and installation directories. For example:


You can download the GWOLLUM source tarball from gitlab:

 tar -xzf GWOLLUM-[X.Y.Z].tar.gz

where [X.Y.Z] is the GWOLLUM version of your choice.

Alternatively, you can get a development copy of the GWOLLUM software using git and select a release tag:

 git clone
 git checkout [X.Y.Z]

The GWOLLUM package relies on several external packages which you must install on your machine:

  • ROOT libraries are used for plotting and data management. ROOT (version 6) must be installed. The ROOT environment must be sourced with ${ROOTSYS}/bin/
  • The FFTW libraries are required to perform fast Fourier transforms.
  • The HDF5 C++ libraries are required to support the hdf5 file format.
  • The Fr package must be installed to supprt the GW frame file format.
  • CMake is used to build GWOLLUM.
  • Doxygen is used to build the GWOLLUM documentation. This package is optional.

Here, we give step-by-step instructions to build GWOLLUM for UNIX (bash/sh) systems.

# go to the source directory

# create the build directory
mkdir ./build/; cd ./build/

# configure GWOLLUM

# compile GWOLLUM

# install GWOLLUM
make install

An environment script has been generated. It must be sourced before using GWOLLUM:


You can test that GWOLLUM is correctly installed by typing:

gwl-print-channels version

If you have the Doxygen software installed in your machine, you can access GWOLLUM documentation with a web browser at file://${GWOLLUM_INSTALLDIR}/share/doc/GWOLLUM/html/index.html.

Documentation and links


Related pages

See all documentation pages in the Related Pages


Florent Robinet - Laboratoire de Physique des 2 Infinis Irène Joliot-Curie (IJCLab) Orsay, France - contact