dqr-configuration 0.2.0

DQR manager

dqr-configuration

Data Quality Report (DQR) Configuration Manager

This package manages the analysis tasks that create LIGO/Virgo/KAGRA Data Quality Reports. It reads configuration files and produces htCondor DAG submit files that orchestrate the full DQR pipeline for GraceDB events.

Full documentation is available at: https://dqr-builder.docs.ligo.org/dqr-configuration/

---

Installation

From PyPI

pip install dqr-configuration

From source (git.ligo.org)

git clone https://git.ligo.org/dqr-builder/dqr-configuration.git
cd dqr-configuration
pip install .

We recommend installing into a dedicated conda environment, such as an IGWN conda environment:

conda activate igwn-py311
pip install dqr-configuration

---

Requirements

• Python >= 3.11
• numpy
• astropy
• gwpy
• h5py
• ligo-gracedb
• ciecplib (provides ecp-get-cert and ecp-cert-info CLI tools)

---

Command-line Tools

Command	Description
dqr-create-dag	Create an htCondor DAG for one or more GraceDB events or GPS times
dqr-config2json	Convert a DQR configuration file to JSON
gdb2json	Copy a GraceDB event to a local JSON file (useful for offline testing)
show-dqr-env	Display the current DQR environment and configuration
wait4frames	Wait for frame files to become available before proceeding

Basic usage

# Process a GraceDB superevent
dqr-create-dag --graceid S230601a

# Process a GPS time
dqr-create-dag -g 1369785617.0

# Process events listed in a file
dqr-create-dag --ev-file my_events.txt

# Create and immediately submit the DAG to condor
dqr-create-dag --graceid S230601a --submit-dag

---

Documentation

• HTML User's Manual
• PDF User's Manual
• HTML API Reference
• PDF API Reference

Building the docs locally

cd docs
make html        # Output: build/html/index.html
make latexpdf    # Output: build/latex/dqrconfiguration.pdf (requires texlive)

---

Contributing

Contributions are welcome! Please open a branch or fork and submit a Merge Request. See the contribution guide for details.

Repository: https://git.ligo.org/dqr-builder/dqr-configuration

---

License

This project is licensed under the GNU General Public License v3 or later (GPLv3+).