API Reference - module_testing
Dirigent top-level package.
- This is the overarching module_testing package designed to provide safe, robust, and effective classes and command structures to perform automated calibration using Ph2ACF’s CMSITminiDAQ, or a similar DAQ program. The package is split into modular components each describing on aspect of a full calibration:
dirigent: general context management and control libraries, and the main dirigent command.
instruments: DCS/instrument libraries.
dataflow: config and results file management and upload process (specific to Ph2DB/Ph2ACF).
monitors: active monitoring parallel to calibration.
calibrations: dynamically loaded calibration commands (specific to Ph2_ACF).
config: module configuration files (specific to Ph2_ACF).
legacy: legacy instrument interface libraries.
This package generally revolves around python-style context managers, each extending an __enter__(...) and __exit__(...) method that perform the majority of the hard work, allowing things like instrument connection initialisation and directory preparation to be delayed from instantiation of the actual objects. These are designed to be used with with(...): statements, and will generally cascade each other to enforce correct initialisation and destruction order of associated resources.
Calibrations are contained in the module_testing.calibrations subpackage, and are dynamically loaded by the dirigent Click command as required. New calibrations are best added by copying and adjusting existing ones, making sure to meet all requirements in terms of naming conventions for the click command and calibration module.
This package contains all calibrations accessible via dirigent. |
|
This package contains both the base structure and implementation of Ph2ACF config parsing. |
|
Package containing config and result dataflow classes for Dirigent. |
|
Package containing calibration-independent Monitors and the Monitoring context manager. |