dls-dodal 1.69.0__py3-none-any.whl → 2.0.0__py3-none-any.whl

dodal/beamlines/i09.py

@@ -1,26 +1,19 @@
 from ophyd_async.core import InOut
 
-from dodal.common.beamlines.beamline_utils import (
-    device_factory,
-)
+from dodal.beamlines.i09_1_shared import devices as i09_1_shared_devices
+from dodal.beamlines.i09_2_shared import devices as i09_2_shared_devices
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.common_dcm import (
-    DoubleCrystalMonochromatorWithDSpacing,
-    PitchAndRollCrystal,
-    StationaryCrystal,
-)
-from dodal.devices.electron_analyser.base import (
-    DualEnergySource,
-)
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.i09.enums import LensMode, PassEnergy, PsuMode
+from dodal.devices.common_dcm import DoubleCrystalMonochromatorWithDSpacing
+from dodal.devices.electron_analyser.base import DualEnergySource
 from dodal.devices.electron_analyser.vgscienta import VGScientaDetector
 from dodal.devices.fast_shutter import DualFastShutter, GenericFastShutter
-from dodal.devices.i09 import Grating, LensMode, PassEnergy, PsuMode
+from dodal.devices.motors import XYZPolarAzimuthStage
 from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.selectable_source import SourceSelector
 from dodal.devices.synchrotron import Synchrotron
-from dodal.devices.temperture_controller import (
-    Lakeshore336,
-)
+from dodal.devices.temperture_controller import Lakeshore336
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
 
@@ -30,74 +23,84 @@ J_PREFIX = BeamlinePrefix(BL, suffix="J")
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
+devices = DeviceManager()
+devices.include(i09_1_shared_devices)
+devices.include(i09_2_shared_devices)
 
-@device_factory()
+
+@devices.factory()
 def synchrotron() -> Synchrotron:
     return Synchrotron()
 
 
-@device_factory()
+@devices.factory()
 def source_selector() -> SourceSelector:
     return SourceSelector()
 
 
-@device_factory()
-def pgm() -> PlaneGratingMonochromator:
-    return PlaneGratingMonochromator(
-        prefix=f"{J_PREFIX.beamline_prefix}-MO-PGM-01:", grating=Grating
-    )
-
-
-@device_factory()
-def dcm() -> DoubleCrystalMonochromatorWithDSpacing:
-    return DoubleCrystalMonochromatorWithDSpacing(
-        f"{I_PREFIX.beamline_prefix}-MO-DCM-01:", PitchAndRollCrystal, StationaryCrystal
-    )
-
-
-@device_factory()
-def dual_energy_source() -> DualEnergySource:
+@devices.factory()
+def dual_energy_source(
+    dcm: DoubleCrystalMonochromatorWithDSpacing,
+    pgm: PlaneGratingMonochromator,
+    source_selector: SourceSelector,
+) -> DualEnergySource:
     return DualEnergySource(
-        dcm().energy_in_eV,
-        pgm().energy.user_readback,
-        source_selector().selected_source,
+        dcm.energy_in_eV,
+        pgm.energy.user_readback,
+        source_selector.selected_source,
     )
 
 
-@device_factory()
+@devices.factory()
 def fsi1() -> GenericFastShutter[InOut]:
     return GenericFastShutter[InOut](
-        f"{I_PREFIX.beamline_prefix}-EA-FSHTR-01:CTRL", InOut.OUT, InOut.IN
+        f"{I_PREFIX.beamline_prefix}-EA-FSHTR-01:CTRL",
+        open_state=InOut.OUT,
+        close_state=InOut.IN,
     )
 
 
-@device_factory()
+@devices.factory()
 def fsj1() -> GenericFastShutter[InOut]:
     return GenericFastShutter[InOut](
-        f"{J_PREFIX.beamline_prefix}-EA-FSHTR-01:CTRL", InOut.OUT, InOut.IN
+        f"{J_PREFIX.beamline_prefix}-EA-FSHTR-01:CTRL",
+        open_state=InOut.OUT,
+        close_state=InOut.IN,
     )
 
 
-@device_factory()
-def dual_fast_shutter() -> DualFastShutter[InOut]:
-    return DualFastShutter[InOut](fsi1(), fsj1(), source_selector().selected_source)
+@devices.factory()
+def dual_fast_shutter(
+    fsi1: GenericFastShutter, fsj1: GenericFastShutter, source_selector: SourceSelector
+) -> DualFastShutter[InOut]:
+    return DualFastShutter[InOut](fsi1, fsj1, source_selector.selected_source)
 
 
-# Connect will work again after this work completed
-# https://jira.diamond.ac.uk/browse/I09-651
-@device_factory()
-def ew4000() -> VGScientaDetector[LensMode, PsuMode, PassEnergy]:
+# CAM:IMAGE will fail to connect outside the beamline network,
+# see https://github.com/DiamondLightSource/dodal/issues/1852
+@devices.factory()
+def ew4000(
+    dual_fast_shutter: DualFastShutter,
+    dual_energy_source: DualEnergySource,
+    source_selector: SourceSelector,
+) -> VGScientaDetector[LensMode, PsuMode, PassEnergy]:
     return VGScientaDetector[LensMode, PsuMode, PassEnergy](
         prefix=f"{I_PREFIX.beamline_prefix}-EA-DET-01:CAM:",
         lens_mode_type=LensMode,
         psu_mode_type=PsuMode,
         pass_energy_type=PassEnergy,
-        energy_source=dual_energy_source(),
-        shutter=dual_fast_shutter(),
-        source_selector=source_selector(),
+        energy_source=dual_energy_source,
+        shutter=dual_fast_shutter,
+        source_selector=source_selector,
     )
 
 
-@device_factory()
+@devices.factory()
 def lakeshore() -> Lakeshore336:
     return Lakeshore336(prefix="BL09L-VA-LAKE-01:")
+
+
+@devices.factory()
+def smpm() -> XYZPolarAzimuthStage:
+    """Sample Manipulator."""
+    return XYZPolarAzimuthStage(prefix=f"{I_PREFIX.beamline_prefix}-MO-SMPM-01:")

dodal/beamlines/i09_1.py

@@ -1,25 +1,13 @@
-from dodal.common.beamlines.beamline_utils import (
-    device_factory,
-)
+from dodal.beamlines.i09_1_shared import devices as i09_1_shared_devices
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.common_dcm import (
-    DoubleCrystalMonochromatorWithDSpacing,
-    PitchAndRollCrystal,
-    StationaryCrystal,
-)
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.i09_1 import LensMode, PsuMode
+from dodal.devices.common_dcm import DoubleCrystalMonochromatorWithDSpacing
 from dodal.devices.electron_analyser.base import EnergySource
 from dodal.devices.electron_analyser.specs import SpecsDetector
-from dodal.devices.i09_1 import LensMode, PsuMode
-from dodal.devices.i09_1_shared.hard_energy import HardEnergy, HardInsertionDeviceEnergy
-from dodal.devices.i09_1_shared.hard_undulator_functions import (
-    calculate_energy_i09_hu,
-    calculate_gap_i09_hu,
-)
+from dodal.devices.motors import XYZPolarAzimuthTiltStage
 from dodal.devices.synchrotron import Synchrotron
-from dodal.devices.temperture_controller import (
-    Lakeshore336,
-)
-from dodal.devices.undulator import UndulatorInMm, UndulatorOrder
+from dodal.devices.temperture_controller import Lakeshore336
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
 
@@ -28,65 +16,38 @@ PREFIX = BeamlinePrefix(BL, suffix="I")
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
+devices = DeviceManager()
+devices.include(i09_1_shared_devices)
 
-@device_factory()
+
+@devices.factory()
 def synchrotron() -> Synchrotron:
     return Synchrotron()
 
 
-@device_factory()
-def dcm() -> DoubleCrystalMonochromatorWithDSpacing:
-    return DoubleCrystalMonochromatorWithDSpacing(
-        f"{PREFIX.beamline_prefix}-MO-DCM-01:", PitchAndRollCrystal, StationaryCrystal
-    )
-
-
-@device_factory()
-def energy_source() -> EnergySource:
-    return EnergySource(dcm().energy_in_eV)
+@devices.factory()
+def energy_source(dcm: DoubleCrystalMonochromatorWithDSpacing) -> EnergySource:
+    return EnergySource(dcm.energy_in_eV)
 
 
-# Connect will work again after this work completed
-# https://jira.diamond.ac.uk/browse/I09-651
-@device_factory(skip=True)
-def analyser() -> SpecsDetector[LensMode, PsuMode]:
+# CAM:IMAGE will fail to connect outside the beamline network,
+# see https://github.com/DiamondLightSource/dodal/issues/1852
+@devices.factory()
+def analyser(energy_source: EnergySource) -> SpecsDetector[LensMode, PsuMode]:
     return SpecsDetector[LensMode, PsuMode](
         prefix=f"{PREFIX.beamline_prefix}-EA-DET-02:CAM:",
         lens_mode_type=LensMode,
         psu_mode_type=PsuMode,
-        energy_source=energy_source(),
-    )
-
-
-@device_factory()
-def undulator() -> UndulatorInMm:
-    return UndulatorInMm(prefix=f"{BeamlinePrefix(BL).insertion_prefix}-MO-SERVC-01:")
-
-
-@device_factory()
-def harmonics() -> UndulatorOrder:
-    return UndulatorOrder()
-
-
-@device_factory()
-def hu_id_energy() -> HardInsertionDeviceEnergy:
-    return HardInsertionDeviceEnergy(
-        undulator_order=harmonics(),
-        undulator=undulator(),
-        lut={},  # ToDo https://github.com/DiamondLightSource/sm-bluesky/issues/239
-        gap_to_energy_func=calculate_energy_i09_hu,
-        energy_to_gap_func=calculate_gap_i09_hu,
-    )
-
-
-@device_factory()
-def hu_energy() -> HardEnergy:
-    return HardEnergy(
-        dcm=dcm(),
-        undulator_energy=hu_id_energy(),
+        energy_source=energy_source,
     )
 
 
-@device_factory()
+@devices.factory()
 def lakeshore() -> Lakeshore336:
     return Lakeshore336(prefix=f"{PREFIX.beamline_prefix}-EA-TCTRL-01:")
+
+
+@devices.factory()
+def hsmpm() -> XYZPolarAzimuthTiltStage:
+    """Sample Manipulator."""
+    return XYZPolarAzimuthTiltStage(prefix=f"{PREFIX.beamline_prefix}-MO-HSMPM-01:")

dodal/beamlines/i09_1_shared.py

@@ -0,0 +1,61 @@
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.i09_1_shared import (
+    HardEnergy,
+    HardInsertionDeviceEnergy,
+    calculate_energy_i09_hu,
+    calculate_gap_i09_hu,
+)
+from dodal.devices.common_dcm import (
+    DoubleCrystalMonochromatorWithDSpacing,
+    PitchAndRollCrystal,
+    StationaryCrystal,
+)
+from dodal.devices.undulator import UndulatorInMm, UndulatorOrder
+from dodal.utils import BeamlinePrefix, get_beamline_name
+
+BL = get_beamline_name("i09-1-shared")
+I_PREFIX = BeamlinePrefix(BL, suffix="I")
+
+devices = DeviceManager()
+
+
+@devices.factory()
+def dcm() -> DoubleCrystalMonochromatorWithDSpacing[
+    PitchAndRollCrystal, StationaryCrystal
+]:
+    return DoubleCrystalMonochromatorWithDSpacing[
+        PitchAndRollCrystal, StationaryCrystal
+    ](f"{I_PREFIX.beamline_prefix}-MO-DCM-01:", PitchAndRollCrystal, StationaryCrystal)
+
+
+@devices.factory()
+def undulator() -> UndulatorInMm:
+    return UndulatorInMm(prefix=f"{I_PREFIX.insertion_prefix}-MO-SERVC-01:")
+
+
+@devices.factory()
+def harmonics() -> UndulatorOrder:
+    return UndulatorOrder()
+
+
+@devices.factory()
+def hu_id_energy(
+    harmonics: UndulatorOrder, undulator: UndulatorInMm
+) -> HardInsertionDeviceEnergy:
+    return HardInsertionDeviceEnergy(
+        undulator_order=harmonics,
+        undulator=undulator,
+        lut={},  # ToDo https://github.com/DiamondLightSource/sm-bluesky/issues/239
+        gap_to_energy_func=calculate_energy_i09_hu,
+        energy_to_gap_func=calculate_gap_i09_hu,
+    )
+
+
+@devices.factory()
+def hu_energy(
+    dcm: DoubleCrystalMonochromatorWithDSpacing, hu_id_energy: HardInsertionDeviceEnergy
+) -> HardEnergy:
+    return HardEnergy(
+        dcm=dcm,
+        undulator_energy=hu_id_energy,
+    )

dodal/beamlines/i09_2.py

@@ -1,113 +1,19 @@
-from pathlib import Path
-
-from daq_config_server.client import ConfigServer
-
-from dodal.common.beamlines.beamline_utils import (
-    device_factory,
-)
+from dodal.beamlines.i09_2_shared import devices as i09_2_shared_devices
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.i09.enums import Grating
-from dodal.devices.i09_2_shared.i09_apple2 import (
-    J09_GAP_POLY_DEG_COLUMNS,
-    J09_PHASE_POLY_DEG_COLUMNS,
-)
-from dodal.devices.insertion_device import (
-    Apple2,
-    Apple2EnforceLHMoveController,
-    BeamEnergy,
-    InsertionDeviceEnergy,
-    InsertionDevicePolarisation,
-    UndulatorGap,
-    UndulatorPhaseAxes,
-)
-from dodal.devices.insertion_device.energy_motor_lookup import (
-    ConfigServerEnergyMotorLookup,
-)
-from dodal.devices.insertion_device.lookup_table_models import LookupTableColumnConfig
-from dodal.devices.pgm import PlaneGratingMonochromator
+from dodal.device_manager import DeviceManager
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
 
-J09_CONF_CLIENT = ConfigServer(url="https://daq-config.diamond.ac.uk")
-LOOK_UPTABLE_DIR = "/dls_sw/i09-2/software/gda/workspace_git/gda-diamond.git/configurations/i09-2-shared/lookupTables/"
-GAP_LOOKUP_FILE_NAME = "JIDEnergy2GapCalibrations.csv"
-PHASE_LOOKUP_FILE_NAME = "JIDEnergy2PhaseCalibrations.csv"
-
 BL = get_beamline_name("i09-2")
 PREFIX = BeamlinePrefix(BL, suffix="J")
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
+devices = DeviceManager()
+devices.include(i09_2_shared_devices)
 
-@device_factory()
+
+@devices.factory()
 def synchrotron() -> Synchrotron:
     return Synchrotron()
-
-
-@device_factory()
-def pgm() -> PlaneGratingMonochromator:
-    return PlaneGratingMonochromator(
-        prefix=f"{PREFIX.beamline_prefix}-MO-PGM-01:",
-        grating=Grating,
-    )
-
-
-@device_factory()
-def jid_gap() -> UndulatorGap:
-    return UndulatorGap(prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:")
-
-
-@device_factory()
-def jid_phase() -> UndulatorPhaseAxes:
-    return UndulatorPhaseAxes(
-        prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
-        top_outer="PUO",
-        top_inner="PUI",
-        btm_inner="PLI",
-        btm_outer="PLO",
-    )
-
-
-@device_factory()
-def jid() -> Apple2[UndulatorPhaseAxes]:
-    """I09 soft x-ray insertion device."""
-    return Apple2[UndulatorPhaseAxes](
-        id_gap=jid_gap(),
-        id_phase=jid_phase(),
-    )
-
-
-@device_factory()
-def jid_controller() -> Apple2EnforceLHMoveController[UndulatorPhaseAxes]:
-    """J09 insertion device controller."""
-    return Apple2EnforceLHMoveController[UndulatorPhaseAxes](
-        apple2=jid(),
-        gap_energy_motor_lut=ConfigServerEnergyMotorLookup(
-            lut_config=LookupTableColumnConfig(poly_deg=J09_GAP_POLY_DEG_COLUMNS),
-            config_client=J09_CONF_CLIENT,
-            path=Path(LOOK_UPTABLE_DIR, GAP_LOOKUP_FILE_NAME),
-        ),
-        phase_energy_motor_lut=ConfigServerEnergyMotorLookup(
-            lut_config=LookupTableColumnConfig(poly_deg=J09_PHASE_POLY_DEG_COLUMNS),
-            config_client=J09_CONF_CLIENT,
-            path=Path(LOOK_UPTABLE_DIR, PHASE_LOOKUP_FILE_NAME),
-        ),
-        units="keV",
-    )
-
-
-@device_factory()
-def jid_energy() -> InsertionDeviceEnergy:
-    return InsertionDeviceEnergy(id_controller=jid_controller())
-
-
-@device_factory()
-def jid_polarisation() -> InsertionDevicePolarisation:
-    return InsertionDevicePolarisation(id_controller=jid_controller())
-
-
-@device_factory()
-def energy_jid() -> BeamEnergy:
-    """Beam energy."""
-    return BeamEnergy(id_energy=jid_energy(), mono=pgm().energy)

dodal/beamlines/i09_2_shared.py

@@ -0,0 +1,110 @@
+from pathlib import Path
+
+from daq_config_server.client import ConfigServer
+
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.i09.enums import Grating
+from dodal.devices.beamlines.i09_2_shared.i09_apple2 import (
+    J09_GAP_POLY_DEG_COLUMNS,
+    J09_PHASE_POLY_DEG_COLUMNS,
+)
+from dodal.devices.insertion_device import (
+    Apple2,
+    Apple2EnforceLHMoveController,
+    BeamEnergy,
+    InsertionDeviceEnergy,
+    InsertionDevicePolarisation,
+    UndulatorGap,
+    UndulatorPhaseAxes,
+)
+from dodal.devices.insertion_device.energy_motor_lookup import (
+    ConfigServerEnergyMotorLookup,
+)
+from dodal.devices.insertion_device.lookup_table_models import LookupTableColumnConfig
+from dodal.devices.pgm import PlaneGratingMonochromator
+from dodal.utils import BeamlinePrefix, get_beamline_name
+
+J09_CONF_CLIENT = ConfigServer(url="https://daq-config.diamond.ac.uk")
+LOOK_UPTABLE_DIR = "/dls_sw/i09-2/software/gda/workspace_git/gda-diamond.git/configurations/i09-2-shared/lookupTables/"
+GAP_LOOKUP_FILE_NAME = "JIDEnergy2GapCalibrations.csv"
+PHASE_LOOKUP_FILE_NAME = "JIDEnergy2PhaseCalibrations.csv"
+
+BL = get_beamline_name("i09-2-shared")
+J_PREFIX = BeamlinePrefix(BL, suffix="J")
+
+devices = DeviceManager()
+
+
+@devices.factory()
+def pgm() -> PlaneGratingMonochromator:
+    return PlaneGratingMonochromator(
+        prefix=f"{J_PREFIX.beamline_prefix}-MO-PGM-01:",
+        grating=Grating,
+    )
+
+
+@devices.factory()
+def jid_gap() -> UndulatorGap:
+    return UndulatorGap(prefix=f"{J_PREFIX.insertion_prefix}-MO-SERVC-01:")
+
+
+@devices.factory()
+def jid_phase() -> UndulatorPhaseAxes:
+    return UndulatorPhaseAxes(
+        prefix=f"{J_PREFIX.insertion_prefix}-MO-SERVC-01:",
+        top_outer="PUO",
+        top_inner="PUI",
+        btm_inner="PLI",
+        btm_outer="PLO",
+    )
+
+
+@devices.factory()
+def jid(
+    jid_gap: UndulatorGap, jid_phase: UndulatorPhaseAxes
+) -> Apple2[UndulatorPhaseAxes]:
+    """I09 soft x-ray insertion device."""
+    return Apple2[UndulatorPhaseAxes](id_gap=jid_gap, id_phase=jid_phase)
+
+
+@devices.factory()
+def jid_controller(
+    jid: Apple2[UndulatorPhaseAxes],
+) -> Apple2EnforceLHMoveController[UndulatorPhaseAxes]:
+    """J09 insertion device controller."""
+    return Apple2EnforceLHMoveController[UndulatorPhaseAxes](
+        apple2=jid,
+        gap_energy_motor_lut=ConfigServerEnergyMotorLookup(
+            lut_config=LookupTableColumnConfig(poly_deg=J09_GAP_POLY_DEG_COLUMNS),
+            config_client=J09_CONF_CLIENT,
+            path=Path(LOOK_UPTABLE_DIR, GAP_LOOKUP_FILE_NAME),
+        ),
+        phase_energy_motor_lut=ConfigServerEnergyMotorLookup(
+            lut_config=LookupTableColumnConfig(poly_deg=J09_PHASE_POLY_DEG_COLUMNS),
+            config_client=J09_CONF_CLIENT,
+            path=Path(LOOK_UPTABLE_DIR, PHASE_LOOKUP_FILE_NAME),
+        ),
+        units="keV",
+    )
+
+
+@devices.factory()
+def jid_energy(
+    jid_controller: Apple2EnforceLHMoveController[UndulatorPhaseAxes],
+) -> InsertionDeviceEnergy:
+    return InsertionDeviceEnergy(id_controller=jid_controller)
+
+
+@devices.factory()
+def jid_polarisation(
+    jid_controller: Apple2EnforceLHMoveController[UndulatorPhaseAxes],
+) -> InsertionDevicePolarisation:
+    return InsertionDevicePolarisation(id_controller=jid_controller)
+
+
+@devices.factory()
+def energy_jid(
+    jid_energy: InsertionDeviceEnergy, pgm: PlaneGratingMonochromator
+) -> BeamEnergy:
+    """Beam energy."""
+    return BeamEnergy(id_energy=jid_energy, mono=pgm.energy)