Welcome to dqrtasks’s documentation!

This is documentation for the dqrtasks repository. The code repository can be found on git.ligo.org at https://git.ligo.org/detchar/dqrtasks.

This codebase is designed to include tasks that will be used to validate gravitational wave event candidates. These tasks will identify data quality concerns that could impact the detection or analysis of the candidates.

This repository is intended to work with the data quality report.

Contents:

• Installation
• Code overview
• Running a simple DQR workflow
  • Installing the DQR and dependencies
  • Writing configuration files
  • Setting up the task-specific config files
  • Setting up the results page configuration
  • Generating the DAG file and submitting
  • Running this example at different locations
• Writing a new DQR task
  • Starting off
  • Data access
  • Data analysis
  • Calculating the p-value
  • Plotting the results
  • Saving the results
  • Displaying the results
  • Setting up the command-line
  • Documentation
• Running your own production DQR
  • Running the low-latency version of the DQR
  • Full code details
  • Triggering the production DQR to run automatically
• JSON requirements
  • Required fields
  • Optional fields
  • JSON example

Tasks in package:

• Stationarity task
• Glitch average task
• Glitch Find task
• GSpyNetTree task
• HVeto task
• iDQ task
• Lock check task
• Loudest amplitude task
• Omegascan Power Overlap task
• PEMcheck task
• Range check task
• Rayleigh spectrogram task

Additional tasks:

• Bristol task
• gwdetchar-omega task
• GPS numerology task
• pyslide-dqr-check task

Module summary

dqrtasks

dqrtasks: tasks for the IGWN data quality report

Indices and tables

• Index

• Module Index

• Search Page