Metadata-Version: 2.4
Name: segwo
Version: 2.0.0
Summary: Sensitivity Estimation for Gravitational-Wave Observatories
Project-URL: Repository, https://gitlab.com/j2b.bayle/segwo
Project-URL: Documentation, https://j2b.bayle.gitlab.io/segwo
Project-URL: Download, https://gitlab.com/j2b.bayle/segwo/-/releases
Project-URL: Issues, https://gitlab.com/j2b.bayle/segwo/-/issues
Author-email: Jean-Baptiste Bayle <j2b.bayle@gmail.com>, Olaf Hartwig <olaf.hartwig@aei.mpg.de>
Maintainer-email: Jean-Baptiste Bayle <j2b.bayle@gmail.com>
License: BSD 3-Clause
License-File: LICENSE
Keywords: covariance matrix,gravitational-wave,sensitivity curve
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Requires-Dist: attrs>=26.1.0
Requires-Dist: healpy>=1.18.1
Requires-Dist: lisaconstants<3.0.0,>=2.0.1; python_version < '4.0'
Requires-Dist: matplotlib>=3.10.8
Requires-Dist: numpy>=2.2.4
Requires-Dist: pytdi>=1.3.1
Requires-Dist: scipy>=1.15.2
Requires-Dist: sympy>=1.13.3
Provides-Extra: notebooks
Requires-Dist: lisaorbits>=2.4.2; extra == 'notebooks'
Description-Content-Type: text/markdown

# 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

```bash
pip install segwo
```

The documentation for the latest stable release can be found
[on this page](https://j2b.bayle.gitlab.io/segwo).

## 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):

```bash
uv run <your-command>
```

You can manually create and synchronize the virtual environment with

```bash
uv sync
```

Refer to the [uv documentation](https://docs.astral.sh/uv/) for more
information.

### Pre-commit hooks

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

```bash
uv run pre-commit install
```

You can manually run the pre-commit hooks with

```bash
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

```bash
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

```bash
uv run pytest
```
