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

dodal/beamlines/i10.py

@@ -1,29 +1,22 @@
-"""
-note:
-    I10 has two insertion devices one up(idu) and one down stream(idd).
-    It is worth noting that the downstream device is slightly longer,
-    so it can reach Mn edge for linear arbitrary.
-    idd == id1,    idu == id2.
-"""
-
-from dodal.common.beamlines.beamline_utils import device_factory
+from dodal.beamlines.i10_shared import devices as i10_shared_devices
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.current_amplifiers import CurrentAmpDet
-from dodal.devices.i10 import (
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.i10 import (
     I10Diagnostic,
     I10Diagnostic5ADet,
     I10Slits,
     I10SlitsDrainCurrent,
     PiezoMirror,
 )
-from dodal.devices.i10.diagnostics import I10Diagnostic, I10Diagnostic5ADet
-from dodal.devices.i10.rasor.rasor_current_amp import RasorFemto, RasorSR570
-from dodal.devices.i10.rasor.rasor_motors import (
+from dodal.devices.beamlines.i10.diagnostics import I10Diagnostic, I10Diagnostic5ADet
+from dodal.devices.beamlines.i10.rasor.rasor_current_amp import RasorFemto, RasorSR570
+from dodal.devices.beamlines.i10.rasor.rasor_motors import (
     DetSlits,
     Diffractometer,
     PaStage,
 )
-from dodal.devices.i10.rasor.rasor_scaler_cards import RasorScalerCard1
+from dodal.devices.beamlines.i10.rasor.rasor_scaler_cards import RasorScalerCard1
+from dodal.devices.current_amplifiers import CurrentAmpDet
 from dodal.devices.motors import XYStage, XYZStage
 from dodal.devices.temperture_controller import (
     Lakeshore340,
@@ -35,11 +28,12 @@ BL = get_beamline_name("i10")
 set_log_beamline(BL)
 set_utils_beamline(BL)
 PREFIX = BeamlinePrefix(BL)
-
+devices = DeviceManager()
+devices.include(i10_shared_devices)
 """Mirrors"""
 
 
-@device_factory()
+@devices.factory()
 def focusing_mirror() -> PiezoMirror:
     return PiezoMirror(prefix=f"{PREFIX.beamline_prefix}-OP-FOCS-01:")
 
@@ -47,12 +41,12 @@ def focusing_mirror() -> PiezoMirror:
 """Optic slits"""
 
 
-@device_factory()
+@devices.factory()
 def slits() -> I10Slits:
     return I10Slits(prefix=f"{PREFIX.beamline_prefix}-AL-SLITS-")
 
 
-@device_factory()
+@devices.factory()
 def slits_current() -> I10SlitsDrainCurrent:
     return I10SlitsDrainCurrent(prefix=f"{PREFIX.beamline_prefix}-")
 
@@ -60,14 +54,14 @@ def slits_current() -> I10SlitsDrainCurrent:
 """Diagnostics"""
 
 
-@device_factory()
+@devices.factory()
 def diagnostics() -> I10Diagnostic:
     return I10Diagnostic(
         prefix=f"{PREFIX.beamline_prefix}-DI-",
     )
 
 
-@device_factory()
+@devices.factory()
 def d5a_det() -> I10Diagnostic5ADet:
     return I10Diagnostic5ADet(prefix=f"{PREFIX.beamline_prefix}-DI-")
 
@@ -75,100 +69,112 @@ def d5a_det() -> I10Diagnostic5ADet:
 """Rasor devices"""
 
 
-@device_factory()
+@devices.factory()
 def pin_hole() -> XYStage:
     return XYStage(prefix="ME01D-EA-PINH-01:")
 
 
-@device_factory()
+@devices.factory()
 def det_slits() -> DetSlits:
     return DetSlits(prefix="ME01D-MO-APTR-0")
 
 
-@device_factory()
+@devices.factory()
 def diffractometer() -> Diffractometer:
     return Diffractometer(prefix="ME01D-MO-DIFF-01:")
 
 
-@device_factory()
+@devices.factory()
 def pa_stage() -> PaStage:
     return PaStage(prefix="ME01D-MO-POLAN-01:")
 
 
-@device_factory()
+@devices.factory()
 def sample_stage() -> XYZStage:
     return XYZStage(prefix="ME01D-MO-CRYO-01:")
 
 
-@device_factory()
+@devices.factory()
 def rasor_temperature_controller() -> Lakeshore340:
     return Lakeshore340(
         prefix="ME01D-EA-TCTRL-01:",
     )
 
 
-@device_factory()
+@devices.factory()
 def rasor_femto() -> RasorFemto:
     return RasorFemto(
         prefix="ME01D-EA-IAMP",
     )
 
 
-@device_factory()
+@devices.factory()
 def rasor_det_scalers() -> RasorScalerCard1:
     return RasorScalerCard1(prefix="ME01D-EA-SCLR-01:SCALER1")
 
 
-@device_factory()
+@devices.factory()
 def rasor_sr570() -> RasorSR570:
     return RasorSR570(
         prefix="ME01D-EA-IAMP",
     )
 
 
-@device_factory()
-def rasor_sr570_pa_scaler_det() -> CurrentAmpDet:
+@devices.factory()
+def rasor_sr570_pa_scaler_det(
+    rasor_sr570: RasorSR570, rasor_det_scalers: RasorScalerCard1
+) -> CurrentAmpDet:
     return CurrentAmpDet(
-        current_amp=rasor_sr570().ca1,
-        counter=rasor_det_scalers().det,
+        current_amp=rasor_sr570.ca1,
+        counter=rasor_det_scalers.det,
     )
 
 
-@device_factory()
-def rasor_femto_pa_scaler_det() -> CurrentAmpDet:
+@devices.factory()
+def rasor_femto_pa_scaler_det(
+    rasor_femto: RasorFemto, rasor_det_scalers: RasorScalerCard1
+) -> CurrentAmpDet:
     return CurrentAmpDet(
-        current_amp=rasor_femto().ca1,
-        counter=rasor_det_scalers().det,
+        current_amp=rasor_femto.ca1,
+        counter=rasor_det_scalers.det,
     )
 
 
-@device_factory()
-def rasor_sr570_fluo_scaler_det() -> CurrentAmpDet:
+@devices.factory()
+def rasor_sr570_fluo_scaler_det(
+    rasor_sr570: RasorSR570, rasor_det_scalers: RasorScalerCard1
+) -> CurrentAmpDet:
     return CurrentAmpDet(
-        current_amp=rasor_sr570().ca2,
-        counter=rasor_det_scalers().fluo,
+        current_amp=rasor_sr570.ca2,
+        counter=rasor_det_scalers.fluo,
     )
 
 
-@device_factory()
-def rasor_femto_fluo_scaler_det() -> CurrentAmpDet:
+@devices.factory()
+def rasor_femto_fluo_scaler_det(
+    rasor_femto: RasorFemto, rasor_det_scalers: RasorScalerCard1
+) -> CurrentAmpDet:
     return CurrentAmpDet(
-        current_amp=rasor_femto().ca2,
-        counter=rasor_det_scalers().fluo,
+        current_amp=rasor_femto.ca2,
+        counter=rasor_det_scalers.fluo,
     )
 
 
-@device_factory()
-def rasor_sr570_drain_scaler_det() -> CurrentAmpDet:
+@devices.factory()
+def rasor_sr570_drain_scaler_det(
+    rasor_sr570: RasorSR570, rasor_det_scalers: RasorScalerCard1
+) -> CurrentAmpDet:
     return CurrentAmpDet(
-        current_amp=rasor_sr570().ca3,
-        counter=rasor_det_scalers().drain,
+        current_amp=rasor_sr570.ca3,
+        counter=rasor_det_scalers.drain,
     )
 
 
-@device_factory()
-def rasor_femto_drain_scaler_det() -> CurrentAmpDet:
+@devices.factory()
+def rasor_femto_drain_scaler_det(
+    rasor_femto: RasorFemto, rasor_det_scalers: RasorScalerCard1
+) -> CurrentAmpDet:
     return CurrentAmpDet(
-        current_amp=rasor_femto().ca3,
-        counter=rasor_det_scalers().drain,
+        current_amp=rasor_femto.ca3,
+        counter=rasor_det_scalers.drain,
     )

dodal/beamlines/i10_1.py

@@ -1,6 +1,13 @@
-from dodal.common.beamlines.beamline_utils import device_factory
+from dodal.beamlines.i10_shared import devices as i10_shared_devices
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.i10 import I10JDiagnostic, I10JSlits, PiezoMirror
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.i10 import I10JDiagnostic, I10JSlits, PiezoMirror
+from dodal.devices.beamlines.i10_1 import (
+    ElectromagnetMagnetField,
+    ElectromagnetStage,
+    I10JScalerCard,
+)
+from dodal.devices.current_amplifiers import SR570, CurrentAmpDet
 from dodal.devices.temperture_controller.lakeshore.lakeshore import Lakeshore336
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -9,27 +16,109 @@ BL = get_beamline_name("i10-1")
 set_log_beamline(BL)
 set_utils_beamline(BL)
 PREFIX = BeamlinePrefix("i10", "J")
+devices = DeviceManager()
+devices.include(i10_shared_devices)
 
+"""I10J Beamline Devices"""
 
-@device_factory()
-def em_temperature_controller() -> Lakeshore336:
-    return Lakeshore336(
-        prefix=f"{PREFIX.beamline_prefix}-EA-TCTRL-41:",
-    )
+
+@devices.factory()
+def mirror6_sr570() -> SR570:
+    return SR570(prefix=f"{PREFIX.beamline_prefix}-DI-IAMP-07:")
 
 
-@device_factory()
+@devices.factory()
 def slits() -> I10JSlits:
     return I10JSlits(prefix=f"{PREFIX.beamline_prefix}-AL-SLITS-")
 
 
-@device_factory()
+@devices.factory()
 def diagnostic() -> I10JDiagnostic:
     return I10JDiagnostic(
         prefix=f"{PREFIX.beamline_prefix}-DI-",
     )
 
 
-@device_factory()
+@devices.factory()
 def focusing_mirror() -> PiezoMirror:
     return PiezoMirror(prefix=f"{PREFIX.beamline_prefix}-OP-FOCA-01:")
+
+
+"""I10J Electromagnet Devices"""
+
+
+@devices.factory()
+def electromagnet_field() -> ElectromagnetMagnetField:
+    return ElectromagnetMagnetField(
+        prefix=f"{PREFIX.beamline_prefix}-EA-MAGC-01:",
+    )
+
+
+@devices.factory()
+def electromagnet_stage() -> ElectromagnetStage:
+    return ElectromagnetStage(
+        prefix=f"{PREFIX.beamline_prefix}-MO-CRYO-01:",
+    )
+
+
+"""I10J Electromagnet Measurement Devices"""
+
+
+@devices.factory()
+def electromagnet_scaler_card() -> I10JScalerCard:
+    return I10JScalerCard(
+        prefix=f"{PREFIX.beamline_prefix}-EA-SCLR-02:SCALERJ3",
+    )
+
+
+@devices.factory()
+def em_sr570_tey() -> SR570:
+    return SR570(
+        prefix=f"{PREFIX.beamline_prefix}-DI-IAMP-08:",
+    )
+
+
+@devices.factory()
+def em_sr570_fy() -> SR570:
+    return SR570(
+        prefix=f"{PREFIX.beamline_prefix}-DI-IAMP-09:",
+    )
+
+
+@devices.factory()
+def electromagnet_sr570_scaler_monitor(
+    mirror6_sr570: SR570,
+    electromagnet_scaler_card: I10JScalerCard,
+) -> CurrentAmpDet:
+    return CurrentAmpDet(
+        current_amp=mirror6_sr570, counter=electromagnet_scaler_card.mon
+    )
+
+
+@devices.factory()
+def electromagnet_sr570_scaler_tey(
+    em_sr570_tey: SR570,
+    electromagnet_scaler_card: I10JScalerCard,
+) -> CurrentAmpDet:
+    return CurrentAmpDet(
+        current_amp=em_sr570_tey,
+        counter=electromagnet_scaler_card.tey,
+    )
+
+
+@devices.factory()
+def electromagnet_sr570_scaler_fy(
+    em_sr570_fy: SR570,
+    electromagnet_scaler_card: I10JScalerCard,
+) -> CurrentAmpDet:
+    return CurrentAmpDet(
+        current_amp=em_sr570_fy,
+        counter=electromagnet_scaler_card.fy,
+    )
+
+
+@devices.factory()
+def em_temperature_controller() -> Lakeshore336:
+    return Lakeshore336(
+        prefix=f"{PREFIX.beamline_prefix}-EA-TCTRL-41:",
+    )

dodal/beamlines/{i10_optics.py → i10_shared.py}

@@ -1,31 +1,30 @@
-"""
-note:
-    I10 has two insertion devices one up(idu) and one down stream(idd).
-    It is worth noting that the downstream device is slightly longer,
-    so it can reach Mn edge for linear arbitrary.
-    idd == id1,    idu == id2.
+"""note:
+I10 has two insertion devices one up(idu) and one down stream(idd).
+It is worth noting that the downstream device is slightly longer,
+so it can reach Mn edge for linear arbitrary.
+idd == id1,    idu == id2.
 """
 
 from pathlib import Path
 
 from daq_config_server.client import ConfigServer
 
-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.i10 import (
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.i10 import (
     I10SharedDiagnostic,
     I10SharedSlits,
     I10SharedSlitsDrainCurrent,
     PiezoMirror,
 )
-from dodal.devices.i10.i10_apple2 import (
+from dodal.devices.beamlines.i10.i10_apple2 import (
     I10Apple2,
     I10Apple2Controller,
     LinearArbitraryAngle,
 )
 
 # Imports taken from i10 while we work out how to deal with split end stations
-from dodal.devices.i10.i10_setting_data import I10Grating
+from dodal.devices.beamlines.i10.i10_setting_data import I10Grating
 from dodal.devices.insertion_device import (
     BeamEnergy,
     InsertionDeviceEnergy,
@@ -52,9 +51,10 @@ BL = get_beamline_name("i10")
 set_log_beamline(BL)
 set_utils_beamline(BL)
 PREFIX = BeamlinePrefix(BL)
+devices = DeviceManager()
 
 
-@device_factory()
+@devices.factory()
 def synchrotron() -> Synchrotron:
     return Synchrotron()
 
@@ -62,14 +62,16 @@ def synchrotron() -> Synchrotron:
 """Mirrors"""
 
 
-@device_factory()
+@devices.factory()
 def first_mirror() -> PiezoMirror:
     return PiezoMirror(prefix=f"{PREFIX.beamline_prefix}-OP-COL-01:")
 
 
-@device_factory()
+@devices.factory()
 def pgm() -> PlaneGratingMonochromator:
-    "I10 Plane Grating Monochromator, it can change energy via pgm.energy.set(<energy>)"
+    """I10 Plane Grating Monochromator, it can change energy via
+    pgm.energy.set(<energy>).
+    """
     return PlaneGratingMonochromator(
         prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
         grating=I10Grating,
@@ -77,7 +79,7 @@ def pgm() -> PlaneGratingMonochromator:
     )
 
 
-@device_factory()
+@devices.factory()
 def switching_mirror() -> PiezoMirror:
     return PiezoMirror(prefix=f"{PREFIX.beamline_prefix}-OP-SWTCH-01:")
 
@@ -89,12 +91,12 @@ I10_CONF_CLIENT = ConfigServer(url="https://daq-config.diamond.ac.uk")
 LOOK_UPTABLE_DIR = "/dls_sw/i10/software/gda/workspace_git/gda-diamond.git/configurations/i10-shared/lookupTables/"
 
 
-@device_factory()
+@devices.factory()
 def idd_gap() -> UndulatorGap:
     return UndulatorGap(prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:")
 
 
-@device_factory()
+@devices.factory()
 def idd_phase() -> UndulatorPhaseAxes:
     return UndulatorPhaseAxes(
         prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
@@ -105,7 +107,7 @@ def idd_phase() -> UndulatorPhaseAxes:
     )
 
 
-@device_factory()
+@devices.factory()
 def idd_jaw_phase() -> UndulatorJawPhase:
     return UndulatorJawPhase(
         prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
@@ -113,16 +115,18 @@ def idd_jaw_phase() -> UndulatorJawPhase:
     )
 
 
-@device_factory()
-def idd() -> I10Apple2:
-    """i10 downstream insertion device:"""
-    return I10Apple2(
-        id_gap=idd_gap(), id_phase=idd_phase(), id_jaw_phase=idd_jaw_phase()
-    )
+@devices.factory()
+def idd(
+    idd_gap: UndulatorGap,
+    idd_phase: UndulatorPhaseAxes,
+    idd_jaw_phase: UndulatorJawPhase,
+) -> I10Apple2:
+    """i10 downstream insertion device."""
+    return I10Apple2(id_gap=idd_gap, id_phase=idd_phase, id_jaw_phase=idd_jaw_phase)
 
 
-@device_factory()
-def idd_controller() -> I10Apple2Controller:
+@devices.factory()
+def idd_controller(idd: I10Apple2) -> I10Apple2Controller:
     """I10 downstream insertion device controller."""
     source = Source(column="Source", value="idd")
     idd_gap_energy_motor_lut = ConfigServerEnergyMotorLookup(
@@ -136,39 +140,43 @@ def idd_controller() -> I10Apple2Controller:
         path=Path(LOOK_UPTABLE_DIR, DEFAULT_PHASE_FILE),
     )
     return I10Apple2Controller(
-        apple2=idd(),
+        apple2=idd,
         gap_energy_motor_lut=idd_gap_energy_motor_lut,
         phase_energy_motor_lut=idd_phase_energy_motor_lut,
     )
 
 
-@device_factory()
-def idd_energy() -> InsertionDeviceEnergy:
-    return InsertionDeviceEnergy(id_controller=idd_controller())
+@devices.factory()
+def idd_energy(idd_controller: I10Apple2Controller) -> InsertionDeviceEnergy:
+    return InsertionDeviceEnergy(id_controller=idd_controller)
 
 
-@device_factory()
-def idd_polarisation() -> InsertionDevicePolarisation:
-    return InsertionDevicePolarisation(id_controller=idd_controller())
+@devices.factory()
+def idd_polarisation(
+    idd_controller: I10Apple2Controller,
+) -> InsertionDevicePolarisation:
+    return InsertionDevicePolarisation(id_controller=idd_controller)
 
 
-@device_factory()
-def idd_laa() -> LinearArbitraryAngle:
-    return LinearArbitraryAngle(id_controller=idd_controller())
+@devices.factory()
+def idd_laa(idd_controller: I10Apple2Controller) -> LinearArbitraryAngle:
+    return LinearArbitraryAngle(id_controller=idd_controller)
 
 
-@device_factory()
-def energy_dd() -> BeamEnergy:
+@devices.factory()
+def energy_dd(
+    idd_energy: InsertionDeviceEnergy, pgm: PlaneGratingMonochromator
+) -> BeamEnergy:
     """Beam energy from down energy devices."""
-    return BeamEnergy(id_energy=idd_energy(), mono=pgm().energy)
+    return BeamEnergy(id_energy=idd_energy, mono=pgm.energy)
 
 
-@device_factory()
+@devices.factory()
 def idu_gap() -> UndulatorGap:
     return UndulatorGap(prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-21:")
 
 
-@device_factory()
+@devices.factory()
 def idu_phase() -> UndulatorPhaseAxes:
     return UndulatorPhaseAxes(
         prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-21:",
@@ -179,7 +187,7 @@ def idu_phase() -> UndulatorPhaseAxes:
     )
 
 
-@device_factory()
+@devices.factory()
 def idu_jaw_phase() -> UndulatorJawPhase:
     return UndulatorJawPhase(
         prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-21:",
@@ -187,16 +195,18 @@ def idu_jaw_phase() -> UndulatorJawPhase:
     )
 
 
-@device_factory()
-def idu() -> I10Apple2:
-    """i10 upstream insertion device"""
-    return I10Apple2(
-        id_gap=idu_gap(), id_phase=idu_phase(), id_jaw_phase=idu_jaw_phase()
-    )
+@devices.factory()
+def idu(
+    idu_gap: UndulatorGap,
+    idu_phase: UndulatorPhaseAxes,
+    idu_jaw_phase: UndulatorJawPhase,
+) -> I10Apple2:
+    """i10 upstream insertion device."""
+    return I10Apple2(id_gap=idu_gap, id_phase=idu_phase, id_jaw_phase=idu_jaw_phase)
 
 
-@device_factory()
-def idu_controller() -> I10Apple2Controller:
+@devices.factory()
+def idu_controller(idd: I10Apple2) -> I10Apple2Controller:
     """I10 upstream insertion device controller."""
     source = Source(column="Source", value="idu")
     idu_gap_energy_motor_lut = ConfigServerEnergyMotorLookup(
@@ -210,37 +220,41 @@ def idu_controller() -> I10Apple2Controller:
         path=Path(LOOK_UPTABLE_DIR, DEFAULT_PHASE_FILE),
     )
     return I10Apple2Controller(
-        apple2=idd(),
+        apple2=idd,
         gap_energy_motor_lut=idu_gap_energy_motor_lut,
         phase_energy_motor_lut=idu_phase_energy_motor_lut,
     )
 
 
-@device_factory()
-def idu_energy() -> InsertionDeviceEnergy:
-    return InsertionDeviceEnergy(id_controller=idu_controller())
+@devices.factory()
+def idu_energy(idu_controller: I10Apple2Controller) -> InsertionDeviceEnergy:
+    return InsertionDeviceEnergy(id_controller=idu_controller)
 
 
-@device_factory()
-def idu_polarisation() -> InsertionDevicePolarisation:
-    return InsertionDevicePolarisation(id_controller=idu_controller())
+@devices.factory()
+def idu_polarisation(
+    idu_controller: I10Apple2Controller,
+) -> InsertionDevicePolarisation:
+    return InsertionDevicePolarisation(id_controller=idu_controller)
 
 
-@device_factory()
-def idu_laa() -> LinearArbitraryAngle:
-    return LinearArbitraryAngle(id_controller=idu_controller())
+@devices.factory()
+def idu_laa(idu_controller: I10Apple2Controller) -> LinearArbitraryAngle:
+    return LinearArbitraryAngle(id_controller=idu_controller)
 
 
-@device_factory()
-def energy_ud() -> BeamEnergy:
+@devices.factory()
+def energy_ud(
+    idu_energy: InsertionDeviceEnergy, pgm: PlaneGratingMonochromator
+) -> BeamEnergy:
     """Beam energy from down energy devices."""
-    return BeamEnergy(id_energy=idu_energy(), mono=pgm().energy)
+    return BeamEnergy(id_energy=idu_energy, mono=pgm.energy)
 
 
 """Slits"""
 
 
-@device_factory()
+@devices.factory()
 def optics_slits() -> I10SharedSlits:
     return I10SharedSlits(prefix=f"{PREFIX.beamline_prefix}-AL-SLITS-")
 
@@ -248,13 +262,13 @@ def optics_slits() -> I10SharedSlits:
 """Diagnostics"""
 
 
-@device_factory()
+@devices.factory()
 def optics_diagnostics() -> I10SharedDiagnostic:
     return I10SharedDiagnostic(
         prefix=f"{PREFIX.beamline_prefix}-DI-",
     )
 
 
-@device_factory()
+@devices.factory()
 def optics_slits_current() -> I10SharedSlitsDrainCurrent:
     return I10SharedSlitsDrainCurrent(prefix=f"{PREFIX.beamline_prefix}-")