toolbox_scs.mnemonics_machinery

Handling ToolBox mnemonics sub-routines

Copyright (2021) SCS Team.

(contributions preferrably comply with pep8 code structure guidelines.)

Module Contents

Functions

mnemonics_for_run(prop_or_run[, runNB])

Returns the availble ToolBox mnemonics for a give extra_data
toolbox_scs.mnemonics_machinery.mnemonics_for_run(prop_or_run, runNB=None)[source]

Returns the availble ToolBox mnemonics for a give extra_data DataCollection, or a given proposal + run number.

Parameters

  • prop_or_run (extra_data DataCollection or int) – The run (DataCollection) to check for mnemonics. Alternatively, the proposal number (int), for which the runNB is also required.

  • runNB (int) – The run number. Only used if the first argument is the proposal number.

Returns

mnemonics – The dictionnary of mnemonics that are available in the run.

Return type

dict

Example

>>> import toolbox_scs as tb
>>> tb.mnemonics_for_run(2212, 213)