Add Double Crystal Monochromator to I07 (#1648)

* Make DSpacing metadata optional

* Refactor to rename and separate common and base DCM

* Update src/dodal/devices/common_dcm.py

Co-authored-by: Victor Rogalev <[email protected]>

* Update src/dodal/beamlines/i18.py

Co-authored-by: Victor Rogalev <[email protected]>

* Test fixes for DCMs

* Return to separate dcm with d spacing

* Move energy conversion tests from i09 in to common test

* Tests fixed

* Add DCM to i07

* Typo correction

Co-authored-by: Dominic Oram <[email protected]>

* Comment update, also removed dspacing from i15 dcm

* Import fixed

* Standardise electron volts as eV (note capital V)

* Response to review

* Test rename

* Test rename

---------

Co-authored-by: Fajin Yuan <[email protected]>
Co-authored-by: Victor Rogalev <[email protected]>
Co-authored-by: Dominic Oram <[email protected]>
Co-authored-by: oliwenmandiamond <[email protected]>

Author: 5 people

src/dodal/beamlines/i07.py

@@ -0,0 +1,21 @@
+from dodal.common.beamlines.beamline_utils import device_factory
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.devices.i07.dcm import DCM
+from dodal.log import set_beamline as set_log_beamline
+from dodal.utils import BeamlinePrefix, get_beamline_name
+
+BL = get_beamline_name("i07")
+set_log_beamline(BL)
+set_utils_beamline(BL)
+PREFIX = BeamlinePrefix(BL)
+
+
+@device_factory()
+def dcm() -> DCM:
+    """Instantiate DCM using two PV bases"""
+    dcm = DCM(
+        f"{PREFIX.beamline_prefix}-MO-DCM-01:",
+        f"{PREFIX.beamline_prefix}-DI-DCM-01:",
+        "dcm",
+    )
+    return dcm

src/dodal/beamlines/i09.py

@@ -43,7 +43,7 @@ def dcm() -> DoubleCrystalMonochromatorWithDSpacing:
 
 @device_factory()
 def energy_source() -> DualEnergySource:
-    return DualEnergySource(dcm().energy_in_ev, pgm().energy.user_readback)
+    return DualEnergySource(dcm().energy_in_eV, pgm().energy.user_readback)
 
 
 # Connect will work again after this work completed

src/dodal/beamlines/i09_1.py

@@ -34,7 +34,7 @@ def dcm() -> DoubleCrystalMonochromatorWithDSpacing:
 
 @device_factory()
 def energy_source() -> EnergySource:
-    return EnergySource(dcm().energy_in_ev)
+    return EnergySource(dcm().energy_in_eV)
 
 
 # Connect will work again after this work completed

src/dodal/devices/b07_1/ccmc.py

@@ -62,7 +62,7 @@ def __init__(
             )
 
         # energy derived signal as property
-        self.energy_in_ev = derived_signal_r(
+        self.energy_in_eV = derived_signal_r(
             self._convert_pos_to_ev, pos_signal=self.crystal
         )
         super().__init__(name=name)

src/dodal/devices/common_dcm.py

@@ -53,9 +53,9 @@ def __init__(
     ) -> None:
         with self.add_children_as_readables():
             # Virtual motor PV's which set the physical motors so that the DCM produces requested energy
-            self.energy_in_kev = Motor(prefix + "ENERGY")
-            self.energy_in_ev = derived_signal_r(
-                self._convert_keV_to_eV, energy_signal=self.energy_in_kev.user_readback
+            self.energy_in_keV = Motor(prefix + "ENERGY")
+            self.energy_in_eV = derived_signal_r(
+                self._convert_keV_to_eV, energy_signal=self.energy_in_keV.user_readback
             )
 
             self._make_crystals(prefix, xtal_1, xtal_2)

src/dodal/devices/i03/undulator_dcm.py

@@ -58,7 +58,7 @@ def __init__(
     async def set(self, value: float):
         await self.undulator_ref().raise_if_not_enabled()
         await asyncio.gather(
-            self.dcm_ref().energy_in_kev.set(value, timeout=ENERGY_TIMEOUT_S),
+            self.dcm_ref().energy_in_keV.set(value, timeout=ENERGY_TIMEOUT_S),
             self.undulator_ref().set(value),
         )
 

src/dodal/devices/i07/__init__.py

@@ -0,0 +1,33 @@
+from ophyd_async.epics.core import epics_signal_r
+from ophyd_async.epics.motor import Motor
+
+from dodal.devices.common_dcm import (
+    DoubleCrystalMonochromator,
+    PitchAndRollCrystal,
+    StationaryCrystal,
+)
+
+
+class DCM(DoubleCrystalMonochromator[PitchAndRollCrystal, StationaryCrystal]):
+    """
+    Device for i07's DCM, including temperature monitors and vertical motor which were
+    included in GDA.
+    """
+
+    def __init__(
+        self,
+        motor_prefix: str,
+        xtal_prefix: str,
+        name: str = "",
+    ) -> None:
+        super().__init__(motor_prefix, PitchAndRollCrystal, StationaryCrystal, name)
+        with self.add_children_as_readables():
+            self.vertical_in_mm = Motor(motor_prefix + "PERP")
+
+            # temperatures
+            self.xtal1_temp = epics_signal_r(float, xtal_prefix + "PT100-2")
+            self.xtal2_temp = epics_signal_r(float, xtal_prefix + "PT100-3")
+            self.xtal1_holder_temp = epics_signal_r(float, xtal_prefix + "PT100-1")
+            self.xtal2_holder_temp = epics_signal_r(float, xtal_prefix + "PT100-4")
+            self.gap_motor = epics_signal_r(float, xtal_prefix + "TC-1")
+            self.white_beam_stop_temp = epics_signal_r(float, xtal_prefix + "WBS:TEMP")

src/dodal/devices/i07/dcm.py

@@ -33,7 +33,7 @@ class DCM(DoubleCrystalMonochromatorBase[ThetaRollYZCrystal, ThetaYCrystal]):
 
     def __init__(self, prefix: str, name: str = "") -> None:
         with self.add_children_as_readables():
-            self.calibrated_energy_in_kev = Motor(prefix + "CAL")
+            self.calibrated_energy_in_keV = Motor(prefix + "CAL")
             self.x1 = Motor(prefix + "X1")
 
         super().__init__(prefix, ThetaRollYZCrystal, ThetaYCrystal, name)

src/dodal/devices/i15/dcm.py

@@ -107,7 +107,7 @@ async def describe(self) -> dict[str, DataKey]:
 
     async def read(self) -> dict[str, Reading]:
         default_reading = await super().read()
-        energy: float = default_reading[f"{self.name}-energy_in_kev"]["value"]
+        energy: float = default_reading[f"{self.name}-energy_in_keV"]["value"]
         if energy > 0.0:
             wavelength = _CONVERSION_CONSTANT / energy
         else: