calibrations

This package contains all calibrations accessible via dirigent.

New calibrations must be added to this package, and a particular naming convention must be used to ensure they are accessible via the dirigent command line interface:

• Calibration scripts must be in files with name <calibration_name>.py

• Each script must contain one main click command with name <calibration_name> with at minimum the decorator:

  @click.command(<calibration_name>)
  def <calibration_name>(cli_ctx, [other click arguments]):
      ...
  

• If a CalibrationContext is desired, use the @request_calibration_context and @with_calibration_context decorators to request and open a calibration context from dirigent:

  @click.command(<calibration_name>)
  @request_calibration_context
  @with_calibration_context
  def <calibration_name>(context, cli_ctx, [other click arguments]):
      ...
  

  The CalibrationContext is now passed as the first argument (context), instruments are accessible via context.instruments, and dirigent configuration is accessible via e.g. context.instruments._default_lv_channel.

• Scripts are called via dirigent <calibration_name> and dynamically loaded on call.

Modules

calibrate_module	This is a "tuning"-type calibration.
crosstalk_method	"openbumps"-type calibration.
custom_calibration	A calibration that allows great control over the Ph2 ACF scans that are run sequentially.
custom_sequence	A "tuning"-type calibration that allows more control over the tests defined in the inner-tracker-tests repo in the TestSequences.py file.
datamerging_quick	Modules which allow data-merging (all 2x2 chip modules) are configured into all different possible data merging modes and an Analog test is performed.
iv_curve	Script to perform an I-V measurement on the sensor of a module.
sldo_vi_curves	An "sldo"-type calibration that measures V-I curves for SLDO for requested ROCs and power domains.
sldo_vi_curves_GADC	An "sldo"-type calibration that is designed to measure SLDO V-I curves by monitoring voltage registers using the RD53B internal GADC.
temperature_check	Reads temperature of CMS Phase 2 IT module ROCs by monitoring INTERNAL_NTC using Ph2 ACF.
test_calibration	Test calibration to demonstrate configuration passing from the main dirigent command.
voltage_trimming	This script measures the optimal settings for the VDDA/D trim bits to reach the desired 1.2 V output for each channel on the chip.
voltage_trimming_GADC	This calibration measures the optimal settings for the VDDA/D trim bits to reach the desired 1.2 V output for each channel on the chip by monitoring voltage registers using the RD53B internal GADC.