GWSumm: the gravitational-wave summary information system

PyPI version Conda version

DOI License Supported Python versions

The gwsumm package is a tool used by the Laser Interferometer Gravitational-wave Observatory (LIGO) to collect, aggregate, and visually summarise the sundry data produced throughout the experiment in order to characterise instrument performance.

The output of this package, known internally as the ‘summary pages’, give an archive of a number of figures or merit, including time-series amplitude trends, frequency spectra and spectrograms, and transient event triggers.

This package includes a collection of command-line utilities and a python module:

import gwsumm

Installation

GWSumm is best installed with conda:

conda install -c conda-forge gwsumm

but can also be installed with pip:

python -m pip install gwsumm

Note, users with LIGO.ORG credentials have access to a software container with a regularly-updated build of GWSumm. For more information please refer to the LSCSoft Conda documentation.

Contributing

All code should follow the Python Style Guide outlined in PEP 0008; users can use the pep8 package to check their code for style issues before submitting.

See the contributions guide for the recommended procedure for proposing additions/changes.

The GWSumm project is hosted on GitHub:

License

GWSumm is distributed under the GNU General Public License.