.. _about: About ===== Glossary -------- Here I have attempted to provide a well-defined list of terms used throughout ``dirigent`` and its documentation. * scan - Specifically refers to `Ph2 ACF `_ scans such as ``thradj`` or ``pixelalive``. * test - Specifically refers to `inner-tracker-tests `_ "scans" such as ``ThresholdAdjustment_2000`` or ``PixelAlive_coupled``. These differ from Ph2 ACF "scans" as they have specific settings (``"TargetThr"=2000``, ``"INJtype"=5``). * sequence - Specifically refers to a list of ``inner-tracker-tests`` tests that are run sequentially. * calibration - (``dirigent/module_testing/calibrations``) More of a loose term that is currently used to describe a ``dirigent`` "scan", "test" (or "sequence", I suppose) that somehow measures/characterises/calibrates/tunes one or many CMS modules. A calibration is defined either when a Ph2 ACF scan does not exist or is not required, such as for IV or SLDO measurements. Or, when some extension to a scan, test (or sequence) is needed that requires other ``dirigent`` features, such as access to the instrument cluster, or uploading to Panthera, for example. * tool - (``dirigent/module_testing/tools``) I use this term to refer to ``dirigent`` calibrations that do not provide measurements/characterisation/calibration/tuning etc. of CMS modules, but instead aid in this process. They exist separately from "scripts" as they require access to ``dirigent`` features, say submodules, access to the instrument cluster, ability to run Ph2 ACF scans etc. * script - (``dirigent/scripts``) Python scripts used inside ``dirigent`` that can also be used as standalone scripts. These typically do not require access to other ``dirigent`` features such as Ph2 ACF scans or the instrument cluster.