km3dq_common.config_library
===========================

.. py:module:: km3dq_common.config_library


Functions
---------

.. autoapisummary::

   km3dq_common.config_library.read_configuration
   km3dq_common.config_library.get_detx_caract
   km3dq_common.config_library.configure_var_name
   km3dq_common.config_library.configure_dataquality_tag
   km3dq_common.config_library.configure_defect
   km3dq_common.config_library.configure_def_var_name
   km3dq_common.config_library.configure_fact
   km3dq_common.config_library.configure_det_fact
   km3dq_common.config_library.configure_var_unit
   km3dq_common.config_library.configure_var_bit
   km3dq_common.config_library.configure_var_thresholds
   km3dq_common.config_library.get_grl_html_descr


Module Contents
---------------

.. py:function:: read_configuration(filename, source, raise_missing=True)

   
















   ..
       !! processed by numpydoc !!

.. py:function:: get_detx_caract(det, source='sftp')

   
   Return the number of DOMs (incl base module so far) and PMts

   - source: either "sftp" (hosted in https://sftp.km3net.de/data/km3dq_lw_db/Common/),
   either the directory absolute-path.















   ..
       !! processed by numpydoc !!

.. py:function:: configure_var_name(v_prop)

   
   Description of JQAQC variables
















   ..
       !! processed by numpydoc !!

.. py:function:: configure_dataquality_tag(tag, source='sftp')

   
   TOMl configuration of the data quality tags
   === Arguments ===
   - tag   : tag name - [string] - Ex: "default", "calibration"...
   - source: either "sftp" (hosted in https://sftp.km3net.de/data/km3dq_lw_db/Common/),
   either the directory absolute-path.
   === Output ===
   - Dictionnary with all tag characteristics for all detectors
















   ..
       !! processed by numpydoc !!

.. py:function:: configure_defect(source='sftp')

   
   TOMl configuration of the defects

   - source: either "sftp" (hosted in https://sftp.km3net.de/data/km3dq_lw_db/Common/),
   either the directory absolute-path.















   ..
       !! processed by numpydoc !!

.. py:function:: configure_def_var_name(v_prop)

   
   Description of defect variables
















   ..
       !! processed by numpydoc !!

.. py:function:: configure_fact(source='sftp')

   
   TOMl configuration of the facts

   - source: either "sftp" (hosted in https://sftp.km3net.de/data/km3dq_lw_db/Common/),
   either the directory absolute-path.















   ..
       !! processed by numpydoc !!

.. py:function:: configure_det_fact(source='sftp')

   
   TOMl configuration of the detector facts

   - source: either "sftp" (hosted in https://sftp.km3net.de/data/km3dq_lw_db/Common/),
   either the directory absolute-path.















   ..
       !! processed by numpydoc !!

.. py:function:: configure_var_unit(v_prop)

   
   Description of variables
















   ..
       !! processed by numpydoc !!

.. py:function:: configure_var_bit(v_prop)

   
   Bit of variables contributing to the veto//Qscore degradation
   used to store in the TTree
















   ..
       !! processed by numpydoc !!

.. py:function:: configure_var_thresholds(v_prop, det, dqt, source='sftp')

   
   Configure various variables for the analysis of the TTree derived from
   the JQAQC file
   TOMl configuration

   - source: either "sftp" (hosted in https://sftp.km3net.de/data/km3dq_lw_db/Common/),
   either the directory absolute-path.















   ..
       !! processed by numpydoc !!

.. py:function:: get_grl_html_descr(dq_tag_0)

   
   Returns the grl description in an html for the summary webpage
   The grl may depend on the detector due to missing variables. This is
   by-passed by passing a dummy value to the configure_var_thresholds
   function. In this way, no variable is discarded
















   ..
       !! processed by numpydoc !!