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-certandecp-cert-infoCLI 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
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+).
Release files for dqr-configuration 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| dqr_configuration-0.3.0.tar.gz | 861.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dqr_configuration-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 923.1 kB
Release files / dqr_configuration-0.3.0.tar.gz
| Download URL | dqr_configuration-0.3.0.tar.gz |
|---|---|
| Size | 861.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b15e9b18bb4172a6c4a8e68befc37f67cb78d81b0f10e4d2c0e2de838d3f96c7
|
|
BLAKE2b-256 checksum How to use checksums |
189a0dcd18433e9eafbbcdfb5fe07765bb47d861fd853c7b995c200d9410c203
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.8
|
Release files / dqr_configuration-0.3.0-py3-none-any.whl
| Download URL | dqr_configuration-0.3.0-py3-none-any.whl |
|---|---|
| Size | 61.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b5b31a735b2415bc7dcc0241c55a34944abb7eb5980432736ad4c2e05bf86097
|
|
BLAKE2b-256 checksum How to use checksums |
4e500cdd0a5211adffb20a44dbe17edc8ed222bb9726f5e8972758aeeaef1ba6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.8
|
