Metadata-Version: 2.4
Name: DQRbuild
Version: 0.3.0
Summary: Umbrella package that pins compatible versions of the DQRbuild toolkit
Author-email: LIGO-Virgo-KAGRA Detector Characterization Groups <detchar@ligo.org>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://git.ligo.org/dqr-builder/dqrbuild
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dqr-configuration==0.2.0
Provides-Extra: tasks
Requires-Dist: dqrtasks[all]==0.7.0; extra == "tasks"
Provides-Extra: database
Requires-Dist: basedb==0.2.0; extra == "database"
Requires-Dist: dqrdb==0.2.0; extra == "database"
Provides-Extra: alert
Requires-Dist: dqralert==0.5.0; extra == "alert"
Provides-Extra: xfer
Requires-Dist: dqrxfer==0.3.0; extra == "xfer"
Provides-Extra: all
Requires-Dist: dqrbuild[tasks]; extra == "all"
Requires-Dist: dqrbuild[database]; extra == "all"
Requires-Dist: dqrbuild[alert]; extra == "all"
Requires-Dist: dqrbuild[xfer]; extra == "all"
Provides-Extra: test
Requires-Dist: pytest>=7; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Dynamic: license-file

# DQRbuild

[![PyPI version](https://img.shields.io/pypi/v/DQRbuild.svg)](https://pypi.org/project/DQRbuild/)
[![License: GPL v3](https://img.shields.io/badge/License-GPL_v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Docs](https://img.shields.io/badge/docs-dqr--builder.docs.ligo.org-blue.svg)](https://dqr-builder.docs.ligo.org/dqrbuild/)

`DQRbuild` is the umbrella package for the Data Quality Report (DQR) Builder toolkit.
It pins compatible versions of all toolkit packages so that a single install command
gives you a tested, coherent set of dependencies.

## Toolkit packages

| Package | Description |
|---------|-------------|
| [`dqr-configuration`](https://git.ligo.org/dqr-builder/dqr-configuration) | Reads config files and generates HTCondor DAGs for GraceDB events |
| [`dqrtasks`](https://git.ligo.org/dqr-builder/dqrtasks) | Analysis tasks (glitch-find, hveto, iDQ, …) that run as DAG nodes |
| [`basedb`](https://git.ligo.org/dqr-builder/dqr_basedb) | Thin Python abstraction layer over MariaDB/MySQL |
| [`dqrdb`](https://git.ligo.org/dqr-builder/dqrdb) | Database of completed DQR results |
| [`dqralert`](https://git.ligo.org/dqr-builder/dqralert) | IGWN-alert listener that triggers the pipeline on GraceDB events |
| [`dqrxfer`](https://git.ligo.org/dqr-builder/dqrxfer) | Transfers DQR results from remote sites to the central node |

## Installation

Install only the components you need:

```bash
pip install dqrbuild              # dqr-configuration only (always included)
pip install "dqrbuild[tasks]"     # + dqrtasks
pip install "dqrbuild[database]"  # + basedb, dqrdb
pip install "dqrbuild[alert]"     # + dqralert
pip install "dqrbuild[xfer]"      # + dqrxfer
pip install "dqrbuild[all]"       # everything
```

### From source

```bash
git clone https://git.ligo.org/dqr-builder/dqrbuild.git
cd dqrbuild
pip install -e ".[all]"
```

## Documentation

Full documentation is available at:

**<https://dqr-builder.docs.ligo.org/dqrbuild/>**

## License

`DQRbuild` is distributed under the [GNU General Public License v3 or later](LICENSE).
