Sensitivity Estimation for Gravitational-Wave Observatories

Easily build the noise and sensitivity curves for your favorite gravitational-wave detector!

This package provides tools to build time and frequency-dependent noise covariance matrices under the assumption of local stationarity; to compute the response of a gravitational-wave detector with an arbitrary number of links, and sky average the response; to transform the noise and the signal to an arbitrary set of observables; and finally, to compute the optimal sensitivity for a given set of observables.

Install

The package is available on PyPI. You can install it with

pip install segwo

The documentation for the latest stable release can be found on this page.

Contributing

Report an issue

We use the issue-tracking management system associated with the project provided by Gitlab. If you want to report a bug or request a feature, open an issue at https://gitlab.com/j2b.bayle/segwo/-/issues. You may also thumb-up or comment on existing issues.

Development environment

This project uses uv for dependency management. You can run commands inside a dedicated virtual environment by running (the first time is automatically created and synchronized by uv if necessary):

uv run <your-command>

You can manually create and synchronize the virtual environment with

uv sync

Refer to the uv documentation for more information.

Pre-commit hooks

We recommend you install pre-commit hooks to detect errors before you even commit.

uv run pre-commit install

You can manually run the pre-commit hooks with

uv run pre-commit run --all-files

Syntax

We use Ruff as a linter and formatter. It is implemented in the continuous integration system, but we recommend you run it locally before you commit, with

uv run ruff check . --fix
uv run ruff format .

Unit tests

Correction of the code is checked by the pytest testing framework. It is implemented in the continuous integration system, but we recommend you run the tests locally before you commit, with

uv run pytest