segwo 0.2.0__tar.gz

segwo-0.2.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Olaf Hartwig and Jean-Baptiste Bayle.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

segwo-0.2.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.3
+Name: segwo
+Version: 0.2.0
+Summary: Sensitivity Estimation for Gravitational-Wave Observatories
+License: BSD 3-Clause
+Keywords: gravitational-wave,sensitivity curve,noise budget
+Author: Jean-Baptiste Bayle
+Author-email: j2b.bayle@gmail.com
+Requires-Python: >=3.11,<4.0
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Dist: healpy (>=1.18.1,<2.0.0)
+Requires-Dist: lisaconstants (>=1.3.6,<2.0.0)
+Requires-Dist: matplotlib (>=3.10.1,<4.0.0)
+Requires-Dist: numpy (>=2.2.4,<3.0.0)
+Requires-Dist: pytdi (>=1.3.1,<2.0.0)
+Requires-Dist: scipy (>=1.15.2,<2.0.0)
+Requires-Dist: sympy (>=1.13.3,<2.0.0)
+Project-URL: Documentation, https://j2b.bayle.gitlab.io/segwo
+Project-URL: Download, https://gitlab.com/j2b.bayle/segwo/-/releases
+Project-URL: Issue Tracker, https://gitlab.com/j2b.bayle/segwo/-/issues
+Project-URL: Repository, https://gitlab.com/j2b.bayle/segwo
+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 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
+```
+

segwo-0.2.0/README.md

@@ -0,0 +1,80 @@
+# 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
+```

segwo-0.2.0/pyproject.toml

@@ -0,0 +1,86 @@
+[project]
+name = "segwo"
+description = "Sensitivity Estimation for Gravitational-Wave Observatories"
+authors = [
+    {name = "Jean-Baptiste Bayle", email = "j2b.bayle@gmail.com"},
+    {name = "Olaf Hartwig", email = "olaf.hartwig@aei.mpg.de"},
+]
+keywords = [ "gravitational-wave", "sensitivity curve", "noise budget" ]
+license = {text = "BSD 3-Clause"}
+readme = "README.md"
+requires-python = ">=3.11,<4.0"
+classifiers = [
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Astronomy",
+    "Topic :: Scientific/Engineering :: Physics",
+]
+dependencies = [
+    "numpy (>=2.2.4,<3.0.0)",
+    "scipy (>=1.15.2,<2.0.0)",
+    "matplotlib (>=3.10.1,<4.0.0)",
+    "healpy (>=1.18.1,<2.0.0)",
+    "pytdi (>=1.3.1,<2.0.0)",
+    "lisaconstants (>=1.3.6,<2.0.0)",
+    "sympy (>=1.13.3,<2.0.0)",
+]
+dynamic = []
+version = "0.2.0"
+
+[project.urls]
+repository = "https://gitlab.com/j2b.bayle/segwo"
+documentation = "https://j2b.bayle.gitlab.io/segwo"
+"Download" = "https://gitlab.com/j2b.bayle/segwo/-/releases"
+"Issue Tracker" = "https://gitlab.com/j2b.bayle/segwo/-/issues"
+
+[tool.poetry]
+
+[tool.poetry.group.dev.dependencies]
+ipython = "^9.0.2"
+black = {extras = ["jupyter"], version = "^25.1.0"}
+mypy = "^1.15.0"
+pylint = "^3.3.6"
+pytest = "^8.3.5"
+pre-commit = "^4.2.0"
+isort = "^6.0.1"
+anybadge = "^1.16.0"
+pytest-cov = "^6.1.1"
+nb-clean = "^4.0.1"
+
+[tool.poetry.group.test.dependencies]
+pytest = "^8.3.5"
+pytest-cov = "^6.1.1"
+pytest-mock = "^3.14.0"
+
+[tool.poetry.group.docs.dependencies]
+sphinx = "^8.2.3"
+sphinx-rtd-theme = "^3.0.2"
+sphinx-autodoc-typehints = "^3.1.0"
+sphinxcontrib-bibtex = "^2.6.3"
+esbonio = "^0.16.5"
+myst-nb = "^1.2.0"
+papermill = "^2.6.0"
+setuptools = "^78.1.0"
+
+[tool.poetry.group.notebooks]
+optional = true
+
+[tool.poetry.group.notebooks.dependencies]
+lisaorbits = "^2.4.2"
+
+[tool.isort]
+profile = "black"
+
+[tool.mypy]
+disable_error_code = "import-untyped"
+
+[tool.poetry-dynamic-versioning]
+enable = false
+vcs = "git"
+style = "semver"
+
+[tool.poetry.requires-plugins]
+poetry-dynamic-versioning = { version = ">=1.0.0,<2.0.0", extras = ["plugin"] }
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
+build-backend = "poetry_dynamic_versioning.backend"

segwo-0.2.0/segwo/__init__.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""SEGWO package."""
+
+import importlib.metadata
+
+from . import cov, response, sensitivity, sym
+
+__copyright__ = "2025, Olaf Hartwig and Jean-Baptiste Bayle"
+__author__ = "Olaf Hartwig and Jean-Baptiste Bayle"
+__version__ = importlib.metadata.version("segwo")