.. dqrtasks documentation master file, created by
   sphinx-quickstart on Thu Sep 23 20:50:08 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

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. 

.. image:: https://www.ligo.org/science/Publication-GW170817BNS/images/bns_figure2.png
  :width: 400
  :alt: GW170817 glitch

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   code-overview
   example-dqr
   example-task
   custom-rrt-overview
   json-requirements

.. toctree::
   :maxdepth: 1
   :caption: Tasks in package:

   stationarity
   glitchaverage
   glitchfind
   gspynettree
   hveto
   idq
   lockcheck
   loudestamp
   omegascan-overlap
   pemcheck
   rangecheck
   rayleigh

.. toctree::
   :maxdepth: 1
   :caption: Additional tasks:

   bristol
   gwdetchar-omega
   gps_numerology
   pyslide-dqr-check

Module summary
==============

.. autosummary:: 
   :toctree: _autosummary
   :caption: API:
   :recursive:

   dqrtasks

   



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`