# 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 stationnarity; 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
[here](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 Poetry 2 for dependency management. To install the
dependencies and the project itself, run the following command:
```bash
poetry install
```
We recommend you install pre-commit hooks to detect errors before you even
commit.
```bash
pre-commit install
```
You can now run commands inside a dedicated virtual environment by running
```bash
poetry run <your-command>
```
Refer to the [Poetry documentation](https://python-poetry.org/docs/) for more
information.
### Syntax
We enforce PEP 8 (Style Guide for Python Code) with Pylint syntax checking, and
code formatting with Black. Both are implemented in the continuous integration
system, and merge requests cannot be merged if it fails. Pre-commit hooks will
also run Black before you commit.
You can run them locally with
```bash
poetry run pylint segwo
poetry run black .
```
### 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
poetry run pytest
```
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/j2b.bayle/segwo",
"name": "segwo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "gravitational-wave, sensitivity curve, noise budget",
"author": "Jean-Baptiste Bayle",
"author_email": "j2b.bayle@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7c/1e/7659baa5fedac65407843c69552255b436608aae19d7d0be68991f1869d6/segwo-1.0.0.tar.gz",
"platform": null,
"description": "# Sensitivity Estimation for Gravitational-Wave Observatories\n\nEasily build the noise and sensitivity curves for your favorite\ngravitational-wave detector!\n\nThis package provides tools to build time and frequency-dependent noise\ncovariance matrices under the assumption of local stationnarity; to compute the\nresponse of a gravitational-wave detector with an arbitrary number of links, and\nsky average the response; to transform the noise and the signal to an arbitrary\nset of observables; and finally, to compute the optimal sensitivity for a given\nset of observables.\n\n## Install\n\nThe package is available on PyPI. You can install it with\n\n```bash\npip install segwo\n```\n\nThe documentation for the latest stable release can be found\n[here](https://j2b.bayle.gitlab.io/segwo).\n\n## Contributing\n\n### Report an issue\n\nWe use the issue-tracking management system associated with the project provided\nby Gitlab. If you want to report a bug or request a feature, open an issue at\n<https://gitlab.com/j2b.bayle/segwo/-/issues>. You may also thumb-up\nor comment on existing issues.\n\n### Development environment\n\nThis project uses Poetry 2 for dependency management. To install the\ndependencies and the project itself, run the following command:\n\n```bash\npoetry install\n```\n\nWe recommend you install pre-commit hooks to detect errors before you even\ncommit.\n\n```bash\npre-commit install\n```\n\nYou can now run commands inside a dedicated virtual environment by running\n\n```bash\npoetry run <your-command>\n```\n\nRefer to the [Poetry documentation](https://python-poetry.org/docs/) for more\ninformation.\n\n### Syntax\n\nWe enforce PEP 8 (Style Guide for Python Code) with Pylint syntax checking, and\ncode formatting with Black. Both are implemented in the continuous integration\nsystem, and merge requests cannot be merged if it fails. Pre-commit hooks will\nalso run Black before you commit.\n\nYou can run them locally with\n\n```bash\npoetry run pylint segwo\npoetry run black .\n```\n\n### Unit tests\n\nCorrection of the code is checked by the pytest testing framework. It is\nimplemented in the continuous integration system, but we recommend you run the\ntests locally before you commit, with\n\n```bash\npoetry run pytest\n```\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "Sensitivity Estimation for Gravitational-Wave Observatories",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://j2b.bayle.gitlab.io/segwo",
"Download": "https://gitlab.com/j2b.bayle/segwo/-/releases",
"Homepage": "https://gitlab.com/j2b.bayle/segwo",
"Issue Tracker": "https://gitlab.com/j2b.bayle/segwo/-/issues",
"Repository": "https://gitlab.com/j2b.bayle/segwo"
},
"split_keywords": [
"gravitational-wave",
" sensitivity curve",
" noise budget"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "39439208f73ff889ba37b415c1759119f3cbd95da1296e54fa4bf78eaca795e4",
"md5": "1c0adb7a4893186ac7afdff30e8d93ed",
"sha256": "fbb752e227568473b538a340bbb4e28681343b06842e8005752782f1756d0414"
},
"downloads": -1,
"filename": "segwo-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c0adb7a4893186ac7afdff30e8d93ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 20257,
"upload_time": "2025-06-25T00:33:48",
"upload_time_iso_8601": "2025-06-25T00:33:48.628235Z",
"url": "https://files.pythonhosted.org/packages/39/43/9208f73ff889ba37b415c1759119f3cbd95da1296e54fa4bf78eaca795e4/segwo-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7c1e7659baa5fedac65407843c69552255b436608aae19d7d0be68991f1869d6",
"md5": "427bfdffc80cc720bbfc2da10b234fe6",
"sha256": "dbb460a5669cc32dd56e6dbb15ce353b06b974ed5b578e478b1a1c1f97a6d449"
},
"downloads": -1,
"filename": "segwo-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "427bfdffc80cc720bbfc2da10b234fe6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 19025,
"upload_time": "2025-06-25T00:33:49",
"upload_time_iso_8601": "2025-06-25T00:33:49.772526Z",
"url": "https://files.pythonhosted.org/packages/7c/1e/7659baa5fedac65407843c69552255b436608aae19d7d0be68991f1869d6/segwo-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-06-25 00:33:49",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "j2b.bayle",
"gitlab_project": "segwo",
"lcname": "segwo"
}
JSON