dqrtasks 0.7.0

Tasks for data quality report

dqrtasks

dqrtasks is a Python package of analysis tasks for the IGWN Data Quality Report (DQR), the automated detector characterization pipeline that runs on every gravitational-wave event candidate reported by LIGO, Virgo, and KAGRA.

Each task reads strain or auxiliary channel data, performs a targeted analysis, and writes a machine-readable data.json result and a human-readable index.html page. Tasks run as independent nodes in an HTCondor DAG.

Tasks

Task	Description
dqr-glitch-find	Q-transform excess-power significance
dqr-glitch-average	Omicron trigger rate comparison
dqr-hveto	Hierarchical Veto auxiliary-channel correlation
dqr-pemcheck	PEM coupling-function environmental noise check
dqr-idq	iDQ machine-learning glitch classifier
dqr-gspynettree	GSpyNet CNN glitch/signal discriminator
dqr-omegascan-overlap	Omega-scan time-frequency power overlap
dqr-lockcheck	Interferometer observing-state check
dqr-stationarity	Noise stationarity (PSD variation)
dqr-rangecheck	Binary inspiral range estimation
dqr-rayleigh	Rayleigh spectrum stationarity
dqr-largest-value	Peak amplitude significance

Installation

Install the core package with pip:

pip install dqrtasks

Individual tasks have additional dependencies not installed by default. Install the extras for the tasks you need, for example:

pip install "dqrtasks[glitchfind]"   # gwpy, gwdetchar, pycbc, bilby, scipy
pip install "dqrtasks[hveto]"        # gwpy, gwdetchar, hveto
pip install "dqrtasks[pemcheck]"     # gwpy, gwdetchar, pycbc
pip install "dqrtasks[idq]"          # idq, ligo-scald, gwdetchar
pip install "dqrtasks[all]"          # all optional dependencies

Or from source:

git clone https://github.com/igwn/dqrtasks.git
cd dqrtasks
pip install -e ".[all]"

Requirements

• Python ≥ 3.11
• gwpy and gwdetchar are used by most tasks
• See the documentation for per-task requirements

Documentation

Full documentation, including task descriptions, example configurations, and a guide to writing new tasks, is available at:

https://dqr-builder.docs.ligo.org/dqrtasks/

Running a DQR workflow

The DQR is driven by dqr-create-dag, which reads a .ini configuration file and generates an HTCondor DAG. A step-by-step tutorial is in the documentation.

Contributing

Contributions are welcome. Please open an issue or merge request on the project repository.

License

dqrtasks is distributed under the GNU General Public License v3 or later (GPLv3+).