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