DQRbuild 0.3.0

Umbrella package that pins compatible versions of the DQRbuild toolkit

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	Reads config files and generates HTCondor DAGs for GraceDB events
dqrtasks	Analysis tasks (glitch-find, hveto, iDQ, …) that run as DAG nodes
basedb	Thin Python abstraction layer over MariaDB/MySQL
dqrdb	Database of completed DQR results
dqralert	IGWN-alert listener that triggers the pipeline on GraceDB events
dqrxfer	Transfers DQR results from remote sites to the central node

Installation

Install only the components you need:

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

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.