dirigent - Documentation

Contents:

• About
  • Glossary
• Installation
  • Dependencies
  • Clone the repository
  • Python environment
  • Set up Ph2 ACF
• Dirigent Configuration
  • dirigent.toml
    • Global settings
    • Ph2_ACF definition and support files
    • Monitoring information
    • Calibration settings
  • Instruments.json
    • Instruments
    • channels
  • modules.json
  • Commenting in config files
  • Alternative file types
  • Additional settings (footnote)
• Running Calibrations with Dirigent
  • Setting up the environment
  • Calibrations
  • Troubleshooting
• Monitors
  • How to set monitors
  • InfluxDB Upload (Only for Expert users)
• Writing a new Calibration
  • Adding Configuration Parameters
  • Accessing Instruments
  • Calling Ph2ACF/CMSITminiDAQ
  • Modifying CMSIT.xml or CMSIT_RD53_ROCn.txt config parameters
  • Queueing saves
  • Uploading using Felis
• ICICLE Instrument Control Library
  • Connecting an Instrument
    • Preparation Steps
    • Using Command Line Utilities
    • Using Instrument Classes in Python Scripts
  • Implementing a New Instrument
    • SCPI-style commands
    • Other VISA-compliant communication protocol
    • Other non-VISA protocol
    • Adding a CLI Interface
• API Reference - module_testing
  • calibrations
  • config
    • calibration_config
    • calibration_config_base
  • dataflow
  • legacy
    • control_arduino
    • control_coolingbox
    • control_multimeter
    • control_xray
  • monitors
    • climate_monitor
    • coldbox_monitor
    • leakage_monitor
    • monitor
    • monitoring
    • supply_monitor
    • temperature_monitor
• API Reference - icicle
  • adc_board
    • ADCBoard
  • adc_board_cli
  • binder_climate_chamber
    • Binder
  • binder_climate_chamber_cli
  • cli_utils
    • print_output
    • verbosity
    • with_instrument
    • InContextObjectField
    • MonitoringLogger
  • dummy
    • DummyInstrument
  • eth_probecard
    • ETHProbecard
  • eth_probecard_cli
  • hmp4040
    • HMP4040
  • hmp4040_cli
  • hp34401a
    • HP34401A
  • hp34401a_cli
    • humid_converter_factory
    • null_converter_factory
    • shh_converter_factory
  • instrument
    • acquire_lock
    • retry_on_fail
    • Flock
    • Instrument
    • LOCK_NOT_ACQUIRED
    • Multiton
    • Singleton
    • ChannelError
    • InstrumentTimeoutError
    • SettingError
  • instrument_cluster
    • DummyInstrument
    • InstrumentCluster
    • InstrumentNotInstantiated
    • BadStatusForOperationError
    • MissingRequiredInstrumentError
  • instrument_cluster_cli
  • itkdcsinterlock
    • ITkDCSInterlock
  • keithley2000
    • Keithley2000
  • keithley2000_cli
    • humid_converter_factory
    • null_converter_factory
    • shh_converter_factory
  • keithley6500
    • Keithley6500
  • keithley6500_cli
    • humid_converter_factory
    • null_converter_factory
    • shh_converter_factory
  • keithley2410
    • Keithley2410
  • keithley2410_cli
  • keysighte3633a
    • KeysightE3633A
  • keysighte3633a_cli
  • lauda
    • Lauda
  • lauda_cli
  • measurechannel_cli
  • mp1
    • mp1_set_requires_readback
    • MP1
  • mp1_cli
  • mqtt_client
    • MQTTClient
  • mqtt_instrument
    • MQTTInstrument
  • pidcontroller
    • PIDController
  • powerchannel_cli
  • psi_coldbox
    • PSIColdbox
  • psi_coldbox_cli
    • set_or_query
  • psi_probecard
    • PSIProbecard
  • psi_probecard_cli
  • relay_board
    • RelayBoard
    • RelayBoardDOUBLE
    • RelayBoardQUAD
    • RelayBoardRD53A
  • relay_board_cli
  • scpi_instrument
    • is_in
    • is_integer
    • is_numeric
    • map_to
    • truthy
    • verifier_or
    • SCPIInstrument
    • ValidationError
  • tpx4sc
    • tpx4_parse_stop_run
    • TPX4SC
  • tpx4sc_cli
  • tti
    • TTI
  • tti_cli
  • ttitsx
    • TTITSX
  • ttitsx_cli
  • parser_utils
    • bitfield_bool
    • catch_failure
    • float_list
    • float_or_strings
    • int_map
    • numeric_bool
    • numeric_float
    • numeric_int
    • str_map
    • string_bool
    • strip_float
    • strip_str
    • truthy_bool
    • PassOriginalValueOnError
  • visa_instrument
    • retry_on_fail_visa
    • VisaInstrument
  • parser_utils
    • bitfield_bool
    • catch_failure
    • float_list
    • float_or_strings
    • int_map
    • numeric_bool
    • numeric_float
    • numeric_int
    • str_map
    • string_bool
    • strip_float
    • strip_str
    • truthy_bool
    • PassOriginalValueOnError

Indices and tables

• Index

• Module Index

• Search Page