km3dq_common.common_library¶
Functions¶
|
Returns the det id |
|
Extract the current detector names from the database by checking the highest run number |
|
For a given detector / detector, returns the path for QAQC files both on sps and sftp |
|
Retrieve run properties from the database with the km3db package |
|
For a given detector, returns the run numbers, their lengths, time counter... as retrieved from the |
|
Retrieve the run start/stop by combining db and QAQC quantities to get the most accurate timing. |
|
Extract the all runs acquired in the last nweeks of running |
|
Returns the site (ORCA or ARCA) |
|
Retrieve the range of active DUs |
|
Retrieve the number of variables in the QAQC file |
|
Create a ttree from qaqc sftp file and defect variables stored on git |
|
Computes the veto/Q-score for a detector/tag using a QAQC source. |
|
Write the run range and run list on disk |
|
sftp QAQC file reading |
|
Decode the source of degradation stored in the TTree |
Module Contents¶
- km3dq_common.common_library.get_det_id(det)[source]¶
Returns the det id
=== Input: - det [string]: D1ORCA024, D0ARCA030… === Outputs: - detector id [integer]
- km3dq_common.common_library.get_current_detector(site)[source]¶
Extract the current detector names from the database by checking the highest run number By default, it is retrieved from the KM3NeT DB but in some rare cases (typically at a detector change) it can be forced to a different one by modifying the km3dq_lw_db/Common/current_detector.toml file that is available on sftp.
=== Input: - site [string]: ARCA / ORCA === Outputs: - detector [string]: D1ORCA024, D0ARCA030…
- km3dq_common.common_library.get_file_paths(detector, qaqc_name)[source]¶
For a given detector / detector, returns the path for QAQC files both on sps and sftp
=== Input: - det [string]: D1ORCA024, D0ARCA030… === Outputs: - detector id [integer]
- km3dq_common.common_library.get_run_properties_from_db(det, filt='PHYS', filt_target='Run')[source]¶
Retrieve run properties from the database with the km3db package
=== Inputs: - det [string]: D1ORCA024, D0ARCA030… - filt [string]: accepted run types (PHYS, COMM…) separated by a space - filt_target [string]: accepted target (run, on…) separated by a space === Outputs: - properties [dict of dict]: all DB content in a single dictionnary with the run numbers as key
- km3dq_common.common_library.get_run_properties_from_qaqc(det, dq_tag, origin='qaqc_sftp', startrun=0, endrun=1000000000.0)[source]¶
For a given detector, returns the run numbers, their lengths, time counter… as retrieved from the QAQC file
=== Inputs: - det [string]: D1ORCA024, D0ARCA030… - dq_tag [DQ tag]: as configured in config_library - origin [string]: “qaqc_sftp” or “qaqc_sps” - startrun [integer]: first run - endrun [integer]: last run === Outputs: - run properties: TOBEDETAILED - error: should be empty
- km3dq_common.common_library.get_run_timerange(det, filt='PHYS')[source]¶
Retrieve the run start/stop by combining db and QAQC quantities to get the most accurate timing. If QAQC data exist (normally for all PHYS runs), use them, otherwise use the DB ones So far used only in km3net_lw_db_interface
=== Inputs: - det: string like (e.g: D0ARCA030, D1ORCA024…) - filt: string containing the accepted run type (PHYS, COMM…) separated by a space
=== Outputs: - dictionary with run as key and a list of [run_start, run_stop, source, runtype] with source = 0 (QAQC) or 1 (DB only)
- km3dq_common.common_library.get_last_n_weeks_runs_qaqc(det, nweeks=2)[source]¶
Extract the all runs acquired in the last nweeks of running
- km3dq_common.common_library.get_site(det)[source]¶
Returns the site (ORCA or ARCA)
=== Inputs: - det [string]: D1ORCA024, D0ARCA030… === Ouputs: - site [string]: ARCA/ORCA
- km3dq_common.common_library.get_active_dus_range(det)[source]¶
Retrieve the range of active DUs To be improved with database information
=== Inputs: - det [string]: D1ORCA024, D0ARCA030… === Ouputs: - site [string]: ARCA/ORCA
- km3dq_common.common_library.get_nb_qaqc_variables(qaqc_vers)[source]¶
Retrieve the number of variables in the QAQC file
=== Inputs - qaqc_vers [string]: “v16.0.3”, “v17.3.2”, “V19.2.0”…
=== Output === - Number of QAQC variables [integer]
- km3dq_common.common_library.create_ttree_from_qaqc(det, var_to_fill, source, tag, append_veto_qsco=False)[source]¶
Create a ttree from qaqc sftp file and defect variables stored on git It includes some advanced check about the QAQC file integrity.
=== Inputs - det : detector name - [string] - Ex: “D0ARCA021”, “D0ORCA018”… - var_to_fill : QAQC variables or defect to fill - [array of string] -
Ex: [‘run’, ‘timestampdiff’, ‘def_operation’, ‘def_oos’] Obsolete - To be removed at some point
source : QAQC source, a priori “qaqc_sftp” - [string]
- tagdata-quality tag (not its name) as created by
configure_dataquality_tag
append_veto_qsco: append the veto and Qscore - [boolean]
=== Outputs - TTree - Error log
- km3dq_common.common_library.compute_veto_qscore(var_prop, var_val)[source]¶
Computes the veto/Q-score for a detector/tag using a QAQC source.
- km3dq_common.common_library.log_run_range(det, run_0, run_1, log_file)[source]¶
Write the run range and run list on disk
- km3dq_common.common_library.read_qaqc_file(det, source, qaqc_name, run_range)[source]¶
sftp QAQC file reading
=== Arguments === - det : detector name - [string] - Ex: “D0ARCA021”, “D0ORCA018”… - source : QAQC source, a priori “qaqc_sftp” - [string] - qaqc_name : - run_range : string as defined in DQ tag “[min_run]-[max_run]” (inclusive)
=== Output === - TTree - Error log