sgn-drift 0.1.0__tar.gz

sgn_drift-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+# artifacts
+*.egg-info
+build/
+dist/
+site/
+__pycache__
+_version.py
+.coverage
+
+# IDE specific files
+.vscode/
+.idea/

sgn_drift-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,57 @@
+include:
+  - component: git.ligo.org/computing/gitlab/components/python/sdist@1
+  - component: git.ligo.org/computing/gitlab/components/python/wheel@1
+  - component: git.ligo.org/computing/gitlab/components/python/code-quality@1
+    inputs:
+      requirements: ".[lint]"
+  - component: git.ligo.org/computing/gitlab/components/python/dependency-scanning@1
+#  - component: git.ligo.org/computing/gitlab/components/python/type-checking@1
+  - component: git.ligo.org/computing/gitlab/components/python/test@1
+    inputs:
+      install_extra: test
+      python_versions:
+        - "3.10"
+        - "3.11"
+        - "3.12"
+        - "3.13"
+  - component: git.ligo.org/computing/gitlab/components/mkdocs/build@1
+    inputs:
+      image: python:3.12
+      project_dir: "."
+      requirements: ".[docs]"
+  - component: git.ligo.org/computing/gitlab/components/mkdocs/pages@1
+    inputs:
+      pages_when: "default"
+
+
+python_test:
+  before_script:
+    - echo "Manually installing system dependencies"
+    - |
+      apt-get update
+    - echo "Installing SGN Family libraries"
+    - |
+      pip install -r build_requirements.txt
+
+mkdocs:
+  before_script:
+    - echo "Manually installing system dependencies"
+    - |
+      apt-get update
+    - echo "Upgrading pip"
+    - |
+      pip install --upgrade pip
+    - echo "Installing SGN Family libraries"
+    - |
+      pip install -r build_requirements.txt
+
+
+flake8-code_quality:
+  image: python:3.12
+  before_script:
+    - echo "Manually installing system dependencies"
+    - |
+      apt-get update
+    - echo "Installing SGN Family libraries"
+    - |
+      pip install -r build_requirements.txt

sgn_drift-0.1.0/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: sgn-drift
+Version: 0.1.0
+Summary: PSD Drift Data Quality Extensions for the SGN Framework
+Author-email: James Kennington <jmk7376@psu.edu>, Zach Yarbrough <jmk7376@psu.edu>, Joshua Black <jmk7376@psu.edu>
+License-Expression: MPL-2.0
+Project-URL: Homepage, https://git.ligo.org/james.kennington/sgn-drift
+Project-URL: Documentation, https://docs.ligo.org/james.kennington/sgn-drift
+Project-URL: Issues, https://git.ligo.org/james.kennington/sgn-drift/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: gwpy
+Requires-Dist: h5py
+Requires-Dist: igwn-ligolw
+Requires-Dist: igwn-segments
+Requires-Dist: lalsuite>=7.26
+Requires-Dist: scipy<1.17
+Requires-Dist: sgn>=0.4
+Requires-Dist: sgn-ts>=0.4
+Requires-Dist: sgn-ligo
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-freezer; extra == "test"
+Requires-Dist: pytest-markdown-docs; extra == "test"
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocstrings; extra == "docs"
+Requires-Dist: mkdocstrings-python; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: pymdown-extensions; extra == "docs"
+Provides-Extra: lint
+Requires-Dist: black; extra == "lint"
+Requires-Dist: flake8; extra == "lint"
+Requires-Dist: flake8-bandit; extra == "lint"
+Requires-Dist: flake8-black; extra == "lint"
+Requires-Dist: flake8-bugbear; extra == "lint"
+Requires-Dist: flake8-future-annotations; extra == "lint"
+Requires-Dist: flake8-isort; extra == "lint"
+Requires-Dist: flake8-logging-format; extra == "lint"
+Requires-Dist: flake8-pyproject; extra == "lint"
+Requires-Dist: isort; extra == "lint"
+Requires-Dist: mypy; extra == "lint"
+Requires-Dist: mypy-extensions; extra == "lint"
+Provides-Extra: dev
+Requires-Dist: sgn-drift[docs]; extra == "dev"
+Requires-Dist: sgn-drift[lint]; extra == "dev"
+Requires-Dist: sgn-drift[test]; extra == "dev"
+
+# SGN-Drift
+
+**Geometric Spectral Diagnostics for Gravitational Wave Detectors.**
+
+`sgn-drift` is an extension to the [SGN](https://git.ligo.org/greg/sgn) framework designed to quantify the stability of
+the detector noise floor using Information Geometry.
+
+## Installation
+
+```bash
+pip install sgn-drift
+```
+
+## Example Usage
+
+### Command Line
+
+```bash
+sgn-drift-estimate --detector L1 --start 1263085000 --end 1263089096 --output drift_L1.csv --bands "low:10:50,mid:50:300"
+```
+
+### Python API
+
+```python
+from sgndrift.bin.estimate_drift import estimate_drift
+
+bands = {
+    "v_low": (10, 50),
+    "v_mid": (50, 300)
+}
+
+estimate_drift(
+    start=1262600000,
+    end=1262604096,
+    detector="L1",
+    output_drift="analysis.csv",
+    bands=bands,
+    verbose=True
+)
+```

sgn_drift-0.1.0/README.md

@@ -0,0 +1,40 @@
+# SGN-Drift
+
+**Geometric Spectral Diagnostics for Gravitational Wave Detectors.**
+
+`sgn-drift` is an extension to the [SGN](https://git.ligo.org/greg/sgn) framework designed to quantify the stability of
+the detector noise floor using Information Geometry.
+
+## Installation
+
+```bash
+pip install sgn-drift
+```
+
+## Example Usage
+
+### Command Line
+
+```bash
+sgn-drift-estimate --detector L1 --start 1263085000 --end 1263089096 --output drift_L1.csv --bands "low:10:50,mid:50:300"
+```
+
+### Python API
+
+```python
+from sgndrift.bin.estimate_drift import estimate_drift
+
+bands = {
+    "v_low": (10, 50),
+    "v_mid": (50, 300)
+}
+
+estimate_drift(
+    start=1262600000,
+    end=1262604096,
+    detector="L1",
+    output_drift="analysis.csv",
+    bands=bands,
+    verbose=True
+)
+```

sgn_drift-0.1.0/build_requirements.txt

@@ -0,0 +1,9 @@
+# Build requirements for SGN family of packages
+
+stillsuit @ git+https://git.ligo.org/greg/stillsuit.git@main
+gw-strike @ git+https://git.ligo.org/greg/strike.git@main
+sgn @ git+https://git.ligo.org/greg/sgn.git@main
+sgn-event @ git+https://git.ligo.org/greg/sgn-event.git@main
+sgn-ts @ git+https://git.ligo.org/greg/sgn-ts.git@main
+sgn-ligo @ git+https://git.ligo.org/greg/sgn-ligo.git@main
+zlw @ git+https://git.ligo.org/james.kennington/zlw.git@main

sgn_drift-0.1.0/docs/api/sinks/drift_sink.md

@@ -0,0 +1 @@
+::: sgndrift.sinks.drift_sink

sgn_drift-0.1.0/docs/api/transforms/drift.md

@@ -0,0 +1 @@
+::: sgndrift.transforms.drift

sgn_drift-0.1.0/docs/api/transforms/psd.md

@@ -0,0 +1 @@
+::: sgndrift.transforms.psd

sgn_drift-0.1.0/docs/api/util/drift.md

@@ -0,0 +1 @@
+::: sgndrift.psd.drift

sgn_drift-0.1.0/docs/api/util/psd_estimators.md

@@ -0,0 +1 @@
+::: sgndrift.psd.estimators

sgn_drift-0.1.0/docs/index.md

@@ -0,0 +1,24 @@
+# SGN-Drift Documentation
+
+**SGN-Drift** provides a specialized toolkit for analyzing the non-stationarity of gravitational wave detector noise. It
+builds upon the `sgn-ligo` ecosystem to provide real-time and offline estimates of spectral stability.
+
+## Key Features
+
+* **Fisher Velocity Metric:** Implements the rigorous geometric definition of spectral drift (Paper A2).
+* **Band-Limited Analysis:** Decompose instability into frequency bands (e.g., distinguishing Scattering from Whistles).
+* **Recursive Estimators:** Includes fast, infinite-impulse-response (IIR) PSD estimators for low-latency tracking.
+* **SGN Integration:** Fully compatible with GStreamer-based pipelines via the `sgn` framework.
+
+## Component Overview
+
+| Component        | Description                                                             |
+|:-----------------|:------------------------------------------------------------------------|
+| `FisherVelocity` | Transform element that calculates the drift metric between PSD frames.  |
+| `RecursivePSD`   | Fast PSD estimator suitable for tracking rapidly changing noise floors. |
+| `DriftCSVSink`   | Specialized sink for writing sparse drift event data to disk.           |
+
+## Getting Started
+
+Check the [API Reference](api/util/psd_estimators.md) for details on the underlying mathematics, or see the `bin/`
+directory for example scripts.

sgn_drift-0.1.0/mkdocs.yml

@@ -0,0 +1,58 @@
+site_name: SGN-Drift Documentation
+
+nav:
+  - Home: index.md
+  - API Reference:
+    - Utilities:
+      - PSD Estimators: api/util/psd_estimators.md
+      - Drift Estimators: api/util/drift.md
+    - Transforms:
+      - PSD: api/transforms/psd.md
+      - Drift: api/transforms/drift.md
+    - Sinks:
+      - DriftSink: api/sinks/drift_sink.md
+
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_inheritance_diagram: true
+            show_root_heading: true
+            show_root_toc_entry: true
+            show_symbol_type_heading: true
+            heading_level: 1
+
+theme:
+  name: material
+#  logo: assets/img/sgndrift-small.png
+  features:
+    - content.code.copy
+
+extra_css:
+  - assets/css/sgn.css
+  - assets/css/mkdocstrings-custom.css
+  - https://unpkg.com/katex@0/dist/katex.min.css
+
+
+markdown_extensions:
+  - pymdownx.superfences:
+  - toc:
+      permalink: true
+      toc_depth: 4
+  - admonition: {}
+  - pymdownx.arithmatex:
+      generic: true
+
+extra_javascript:
+  - assets/js/katex.js
+  - https://unpkg.com/katex@0/dist/katex.min.js
+  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js
+
+
+extra:
+  analytics:
+    provider: google
+    property: G-FCGJLPECE2
+

sgn_drift-0.1.0/pyproject.toml

@@ -0,0 +1,135 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "setuptools_scm[toml]>=3.4.3",
+    "wheel",
+    "pyproject-flake8",
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sgn-drift"
+dynamic = ["version"]
+dependencies = [
+    "gwpy",
+    "h5py",
+    "igwn-ligolw",
+    "igwn-segments",
+    "lalsuite>=7.26",
+    "scipy < 1.17",
+    "sgn >= 0.4",
+    "sgn-ts >= 0.4",
+    "sgn-ligo",
+]
+requires-python = ">=3.10"
+authors = [
+    { name = "James Kennington", email = "jmk7376@psu.edu" },
+    { name = "Zach Yarbrough", email = "jmk7376@psu.edu" },
+    { name = "Joshua Black", email = "jmk7376@psu.edu" },
+]
+description = "PSD Drift Data Quality Extensions for the SGN Framework"
+readme = "README.md"
+license = "MPL-2.0"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://git.ligo.org/james.kennington/sgn-drift"
+Documentation = "https://docs.ligo.org/james.kennington/sgn-drift"
+Issues = "https://git.ligo.org/james.kennington/sgn-drift/issues"
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "pytest-cov",
+    "pytest-freezer",
+    "pytest-markdown-docs",
+]
+docs = [
+    "mkdocs",
+    "mkdocstrings",
+    "mkdocstrings-python",
+    "mkdocs-material",
+    "pymdown-extensions",
+]
+lint = [
+    "black",
+    "flake8",
+    "flake8-bandit",
+    "flake8-black",
+    "flake8-bugbear",
+    "flake8-future-annotations",
+    "flake8-isort",
+    "flake8-logging-format",
+    "flake8-pyproject",
+    "isort",
+    "mypy",
+    "mypy-extensions",
+]
+dev = [
+    "sgn-drift[docs]",
+    "sgn-drift[lint]",
+    "sgn-drift[test]",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+sgnl = [
+    "py.typed",
+]
+
+[tool.setuptools_scm]
+write_to = "src/sgndrift/_version.py"
+
+[tool.coverage.paths]
+source = [
+    "src/sgndrift/",
+    "*/sgndrift/",
+]
+
+[tool.coverage.report]
+omit = ["_version.py", "tests/*", "examples/*", "setup.py", "*/__init__.py"]
+
+[tool.isort]
+profile = "black"
+
+[tool.mypy]
+ignore_missing_imports = true
+exclude = [
+    "build",
+    "docs",
+]
+
+[tool.pytest.ini_options]
+addopts = "-p no:warnings --cov-config=.coveragerc --cov=sgndrift --cov-report=term-missing --markdown-docs-syntax=superfences"
+
+[tool.flake8]
+max-line-length = 88
+extend-ignore = [
+    "E203",
+    "S101",
+]
+per-file-ignores = [
+    "__init__.py:F401",
+    "_version.py:BLK100",
+    "docs/conf.py:E501",
+    "tests/test_datasource.py:S108",
+    "tests/*.py:E731",
+]
+exclude = [
+    "build",
+    "docs",
+    "_version.py",
+]
+
+[project.scripts]
+sgn-drift-estimate = "sgndrift.bin.estimate_drift:main"
+sgn-drift-plot = "sgndrift.bin.plot_drift:main"
+sgn-drift-plot-comp = "sgndrift.bin.plot_drift_comparison:main"
+sgn-drift-plot-time = "sgndrift.bin.plot_drift_time:main"
+sgn-drift-plot-super = "sgndrift.bin.plot_drift_super:main"
+sgn-drift-plot-super-comp = "sgndrift.bin.plot_drift_super_comp:main"

sgn_drift-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sgn_drift-0.1.0/src/sgn_drift.egg-info/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: sgn-drift
+Version: 0.1.0
+Summary: PSD Drift Data Quality Extensions for the SGN Framework
+Author-email: James Kennington <jmk7376@psu.edu>, Zach Yarbrough <jmk7376@psu.edu>, Joshua Black <jmk7376@psu.edu>
+License-Expression: MPL-2.0
+Project-URL: Homepage, https://git.ligo.org/james.kennington/sgn-drift
+Project-URL: Documentation, https://docs.ligo.org/james.kennington/sgn-drift
+Project-URL: Issues, https://git.ligo.org/james.kennington/sgn-drift/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: gwpy
+Requires-Dist: h5py
+Requires-Dist: igwn-ligolw
+Requires-Dist: igwn-segments
+Requires-Dist: lalsuite>=7.26
+Requires-Dist: scipy<1.17
+Requires-Dist: sgn>=0.4
+Requires-Dist: sgn-ts>=0.4
+Requires-Dist: sgn-ligo
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-freezer; extra == "test"
+Requires-Dist: pytest-markdown-docs; extra == "test"
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocstrings; extra == "docs"
+Requires-Dist: mkdocstrings-python; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: pymdown-extensions; extra == "docs"
+Provides-Extra: lint
+Requires-Dist: black; extra == "lint"
+Requires-Dist: flake8; extra == "lint"
+Requires-Dist: flake8-bandit; extra == "lint"
+Requires-Dist: flake8-black; extra == "lint"
+Requires-Dist: flake8-bugbear; extra == "lint"
+Requires-Dist: flake8-future-annotations; extra == "lint"
+Requires-Dist: flake8-isort; extra == "lint"
+Requires-Dist: flake8-logging-format; extra == "lint"
+Requires-Dist: flake8-pyproject; extra == "lint"
+Requires-Dist: isort; extra == "lint"
+Requires-Dist: mypy; extra == "lint"
+Requires-Dist: mypy-extensions; extra == "lint"
+Provides-Extra: dev
+Requires-Dist: sgn-drift[docs]; extra == "dev"
+Requires-Dist: sgn-drift[lint]; extra == "dev"
+Requires-Dist: sgn-drift[test]; extra == "dev"
+
+# SGN-Drift
+
+**Geometric Spectral Diagnostics for Gravitational Wave Detectors.**
+
+`sgn-drift` is an extension to the [SGN](https://git.ligo.org/greg/sgn) framework designed to quantify the stability of
+the detector noise floor using Information Geometry.
+
+## Installation
+
+```bash
+pip install sgn-drift
+```
+
+## Example Usage
+
+### Command Line
+
+```bash
+sgn-drift-estimate --detector L1 --start 1263085000 --end 1263089096 --output drift_L1.csv --bands "low:10:50,mid:50:300"
+```
+
+### Python API
+
+```python
+from sgndrift.bin.estimate_drift import estimate_drift
+
+bands = {
+    "v_low": (10, 50),
+    "v_mid": (50, 300)
+}
+
+estimate_drift(
+    start=1262600000,
+    end=1262604096,
+    detector="L1",
+    output_drift="analysis.csv",
+    bands=bands,
+    verbose=True
+)
+```

sgn_drift-0.1.0/src/sgn_drift.egg-info/SOURCES.txt

@@ -0,0 +1,39 @@
+.gitignore
+.gitlab-ci.yml
+README.md
+build_requirements.txt
+mkdocs.yml
+pyproject.toml
+docs/index.md
+docs/api/sinks/drift_sink.md
+docs/api/transforms/drift.md
+docs/api/transforms/psd.md
+docs/api/util/drift.md
+docs/api/util/psd_estimators.md
+src/sgn_drift.egg-info/PKG-INFO
+src/sgn_drift.egg-info/SOURCES.txt
+src/sgn_drift.egg-info/dependency_links.txt
+src/sgn_drift.egg-info/entry_points.txt
+src/sgn_drift.egg-info/requires.txt
+src/sgn_drift.egg-info/top_level.txt
+src/sgndrift/__init__.py
+src/sgndrift/_version.py
+src/sgndrift/bin/__init__.py
+src/sgndrift/bin/estimate_drift.py
+src/sgndrift/bin/plot_drift.py
+src/sgndrift/bin/plot_drift_comparison.py
+src/sgndrift/bin/plot_drift_super.py
+src/sgndrift/bin/plot_drift_super_comp.py
+src/sgndrift/bin/plot_drift_time.py
+src/sgndrift/psd/__init__.py
+src/sgndrift/psd/drift.py
+src/sgndrift/psd/estimators.py
+src/sgndrift/sinks/__init__.py
+src/sgndrift/sinks/drift_sink.py
+src/sgndrift/transforms/__init__.py
+src/sgndrift/transforms/drift.py
+src/sgndrift/transforms/psd.py
+tests/test_psd_drift.py
+tests/test_psd_estimators.py
+tests/test_sinks_drift_sink.py
+tests/test_transforms_drift.py

sgn_drift-0.1.0/src/sgn_drift.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sgn_drift-0.1.0/src/sgn_drift.egg-info/entry_points.txt

@@ -0,0 +1,7 @@
+[console_scripts]
+sgn-drift-estimate = sgndrift.bin.estimate_drift:main
+sgn-drift-plot = sgndrift.bin.plot_drift:main
+sgn-drift-plot-comp = sgndrift.bin.plot_drift_comparison:main
+sgn-drift-plot-super = sgndrift.bin.plot_drift_super:main
+sgn-drift-plot-super-comp = sgndrift.bin.plot_drift_super_comp:main
+sgn-drift-plot-time = sgndrift.bin.plot_drift_time:main

sgn_drift-0.1.0/src/sgn_drift.egg-info/requires.txt

@@ -0,0 +1,41 @@
+gwpy
+h5py
+igwn-ligolw
+igwn-segments
+lalsuite>=7.26
+scipy<1.17
+sgn>=0.4
+sgn-ts>=0.4
+sgn-ligo
+
+[dev]
+sgn-drift[docs]
+sgn-drift[lint]
+sgn-drift[test]
+
+[docs]
+mkdocs
+mkdocstrings
+mkdocstrings-python
+mkdocs-material
+pymdown-extensions
+
+[lint]
+black
+flake8
+flake8-bandit
+flake8-black
+flake8-bugbear
+flake8-future-annotations
+flake8-isort
+flake8-logging-format
+flake8-pyproject
+isort
+mypy
+mypy-extensions
+
+[test]
+pytest
+pytest-cov
+pytest-freezer
+pytest-markdown-docs

sgn_drift-0.1.0/src/sgn_drift.egg-info/top_level.txt

@@ -0,0 +1 @@
+sgndrift

sgn_drift-0.1.0/src/sgndrift/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)
+
+__commit_id__ = commit_id = 'ge68e85fce'