.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/grl_create.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_examples_grl_create.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_grl_create.py:


How to generate a good run list and retrieve any QAQC variables or defect
=========================================================================

The following example shows how to use the `Calculator` class.

.. GENERATED FROM PYTHON SOURCE LINES 7-39

.. code-block:: Python

    from km3dq_common.grl_library import get_good_run_list


    # The list of detectors and data quality tags are available at the
    # location: https://btrocme.pages.km3net.de/km3dq_perf/all_tags.html

    detector = "D0ORCA015"
    dataquality_tag = "default"

    # It is possible to retrieve for each run any QAQC variables or defect.
    # The QAQC files are available at the location:
    # https://sftp.km3net.de/data/quality/
    # The assigned defects are available at the location:
    # https://btrocme.pages.km3net.de/km3dq_perf/

    additional_variables = ["HRV", "MEAN_Rate_Hz", "RMS_Rate_Hz"]

    g = get_good_run_list(detector, dataquality_tag, additional_variables)

    # Print the conditions used to derive the good run list
    print(f"Veto conditions       : {g['var_prop']['veto_thresholds']}")
    print(f"Qscore conditions     : {g['var_prop']['qsco_thresholds']}")
    print(f"Good runs conditions  : {g['var_prop']['good_thresholds']}")

    # Print the good run list
    print(f"Run list: {g['good']['run_list']}")
    print(f"Livetime: {g['good']['livetime_s']}")

    # Print the additional info of a random run
    run_number = 15500
    for i_var in additional_variables:
        print(f"Run {run_number}: {i_var} = {g['add_info'][i_var][run_number]:.2f}")


.. _sphx_glr_download_auto_examples_grl_create.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: grl_create.ipynb <grl_create.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: grl_create.py <grl_create.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: grl_create.zip <grl_create.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_