From 63a20e792e89c8271c8da7da54a4be32d62112d3 Mon Sep 17 00:00:00 2001 From: appel_c Date: Mon, 5 Jan 2026 12:02:08 +0100 Subject: [PATCH] mcs readme --- csaxs_bec/devices/epics/mcs_card/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 csaxs_bec/devices/epics/mcs_card/README.md diff --git a/csaxs_bec/devices/epics/mcs_card/README.md b/csaxs_bec/devices/epics/mcs_card/README.md new file mode 100644 index 0000000..d76f8a3 --- /dev/null +++ b/csaxs_bec/devices/epics/mcs_card/README.md @@ -0,0 +1,13 @@ +# MCS Card implementation at the CSAXS beamline + +This module provides an ophyd device implementation for the SIS3820 Multi-Channel Scaler (MCS) card, used at the cSAXS beamline for time-resolved data acquisition. It interfaces with the EPICS IOC for the SIS3820 MCS card. +Information about the EPICS driver can be found here (https://millenia.cars.aps.anl.gov/software/epics/mcaStruck.html). + +# Important Notes +Operation of the MCS card requires proper configuration as some of the parameters are interdependent. In addition, empirical adjustments have been found to be necessary for optimal performance at the beamline. In its current implementation, comments about these dependencies are highlighted in the source code of the ophyd device classes [MCSCard](./mcs_card.py) and [MCSCardCSAXS](./mcs_card_csaxs.py). It is highly recommended to review these comments before refactoring, modifying, or extending the code. + +## Ophyd Device Implementation + +The ophyd device implementation is provided [MCSCard](./mcs_card.py). This class provides a basic interface to the MCS PVs, including configuration of parameters such as number of channels, dwell time, and control of acquisition start/stop. Please check the source code of the class for more details of the implementation. + +The [MCSCardCSAXS](./mcs_card_csaxs.py) class extends the basic MCSCard implementation with cSAXS-specific logic and configurations. Please be aware that this is also linked to the implementation of other devices, most notably the [delay generator integration](../delay_generator/README.md), which is used as the trigger source for the MCS card during operation. \ No newline at end of file