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

dodal/beamlines/b07_1.py

@@ -1,7 +1,8 @@
-from dodal.common.beamlines.beamline_utils import device_factory
+from dodal.beamlines.b07_shared import devices as b07_shared_devices
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.b07 import PsuMode
-from dodal.devices.b07_1 import (
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.b07 import PsuMode
+from dodal.devices.beamlines.b07_1 import (
     ChannelCutMonochromator,
     Grating,
     LensMode,
@@ -9,46 +10,43 @@ from dodal.devices.b07_1 import (
 from dodal.devices.electron_analyser.base import EnergySource
 from dodal.devices.electron_analyser.specs import SpecsDetector
 from dodal.devices.pgm import PlaneGratingMonochromator
-from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
 
 BL = get_beamline_name("b07-1")
-PREFIX = BeamlinePrefix(BL, suffix="C")
+C_PREFIX = BeamlinePrefix(BL, suffix="C")
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
+devices = DeviceManager()
+devices.include(b07_shared_devices)
 
-@device_factory()
-def synchrotron() -> Synchrotron:
-    return Synchrotron()
 
-
-@device_factory()
+@devices.factory()
 def pgm() -> PlaneGratingMonochromator:
     return PlaneGratingMonochromator(
-        prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
+        prefix=f"{C_PREFIX.beamline_prefix}-OP-PGM-01:",
         grating=Grating,
     )
 
 
-# Connect will work again after this work completed
-# https://jira.diamond.ac.uk/browse/B07-1104
-@device_factory()
+@devices.factory()
 def ccmc() -> ChannelCutMonochromator:
-    return ChannelCutMonochromator(prefix=f"{PREFIX.beamline_prefix}-OP-CCM-01:")
+    return ChannelCutMonochromator(prefix=f"{C_PREFIX.beamline_prefix}-OP-CCM-01:")
 
 
-@device_factory()
-def energy_source() -> EnergySource:
-    return EnergySource(pgm().energy.user_readback)
+@devices.factory()
+def energy_source(pgm: PlaneGratingMonochromator) -> EnergySource:
+    return EnergySource(pgm.energy.user_readback)
 
 
-@device_factory()
-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-01:CAM:",
+        prefix=f"{C_PREFIX.beamline_prefix}-EA-DET-01:CAM:",
         lens_mode_type=LensMode,
         psu_mode_type=PsuMode,
-        energy_source=energy_source(),
+        energy_source=energy_source,
     )

dodal/beamlines/b07_shared.py

@@ -0,0 +1,12 @@
+from dodal.device_manager import DeviceManager
+from dodal.devices.synchrotron import Synchrotron
+from dodal.utils import get_beamline_name
+
+BL = get_beamline_name("b07-shared")
+
+devices = DeviceManager()
+
+
+@devices.factory()
+def synchrotron() -> Synchrotron:
+    return Synchrotron()

dodal/beamlines/b16.py

@@ -11,7 +11,7 @@ from dodal.common.beamlines.beamline_utils import (
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.common.visit import RemoteDirectoryServiceClient, StaticVisitPathProvider
-from dodal.devices.b16.detector import (
+from dodal.devices.beamlines.b16.detector import (
     software_triggered_tiff_area_detector,
 )
 from dodal.devices.motors import XYZStage

dodal/beamlines/b21.py

@@ -1,3 +1,6 @@
+from pathlib import Path
+
+from ophyd_async.core import StaticPathProvider, UUIDFilenameProvider
 from ophyd_async.epics.adaravis import AravisDetector
 from ophyd_async.fastcs.eiger import EigerDetector
 from ophyd_async.fastcs.panda import HDFPanda
@@ -5,11 +8,12 @@ from ophyd_async.fastcs.panda import HDFPanda
 from dodal.common.beamlines.beamline_utils import (
     device_factory,
     get_path_provider,
+    set_path_provider,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.common.beamlines.device_helpers import CAM_SUFFIX, HDF5_SUFFIX
+from dodal.devices.beamlines.i22.nxsas import NXSasMetadataHolder, NXSasOAV
 from dodal.devices.focusing_mirror import SimpleMirror
-from dodal.devices.i22.nxsas import NXSasMetadataHolder, NXSasOAV
 from dodal.devices.linkam3 import Linkam3
 from dodal.devices.motors import XYStage
 from dodal.devices.slits import Slits
@@ -23,6 +27,13 @@ PREFIX = BeamlinePrefix(BL)
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
+# This should be removed when the DeviceManager is adopted
+try:
+    get_path_provider()
+except NameError:
+    # If one hasn't already been set, use a default to stop things crashing
+    set_path_provider(StaticPathProvider(UUIDFilenameProvider(), Path("/tmp")))
+
 
 @device_factory()
 def saxs() -> EigerDetector:
@@ -95,9 +106,8 @@ def slits_3() -> Slits:
     return Slits(prefix=f"{PREFIX.beamline_prefix}-AL-SLITS-03:")
 
 
-"""
-Slits 4 was removed from B21 after the camera length was fixed, it is not used anymore.
-"""
+"""Slits 4 was removed from B21 after the camera length was fixed, it is not used
+anymore."""
 
 
 @device_factory()
@@ -112,8 +122,7 @@ def slits_6() -> Slits:
 
 @device_factory()
 def slits_7() -> Slits:
-    """
-    Compact JJ slits device is used for B21 slits 7. PV's operate in same way
+    """Compact JJ slits device is used for B21 slits 7. PV's operate in same way
     but physically different to other slits, and uses X:GAP nomenclature.
     """
     return Slits(

dodal/beamlines/i02_1.py

@@ -1,4 +1,4 @@
-"""Beamline i02-1 is also known as VMXm, or I02J"""
+"""Beamline i02-1 is also known as VMXm, or I02J."""
 
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.device_manager import DeviceManager
@@ -9,9 +9,9 @@ from dodal.devices.attenuator.filter_selections import (
     I02_1FilterThreeSelections,
     I02_1FilterTwoSelections,
 )
+from dodal.devices.beamlines.i02_1.fast_grid_scan import ZebraFastGridScanTwoD
+from dodal.devices.beamlines.i02_1.sample_motors import SampleMotors
 from dodal.devices.eiger import EigerDetector
-from dodal.devices.i02_1.fast_grid_scan import ZebraFastGridScanTwoD
-from dodal.devices.i02_1.sample_motors import SampleMotors
 from dodal.devices.synchrotron import Synchrotron
 from dodal.devices.zebra.zebra import Zebra
 from dodal.devices.zebra.zebra_constants_mapping import (

dodal/beamlines/i02_2.py

@@ -1,4 +1,4 @@
-"""Beamline i02-2 is also known as VMXi, or I02I"""
+"""Beamline i02-2 is also known as VMXi, or I02I."""
 
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.device_manager import DeviceManager

dodal/beamlines/i03.py

@@ -17,6 +17,10 @@ from dodal.devices.aperturescatterguard import (
 from dodal.devices.attenuator.attenuator import BinaryFilterAttenuator
 from dodal.devices.backlight import Backlight
 from dodal.devices.baton import Baton
+from dodal.devices.beamlines.i03 import Beamstop
+from dodal.devices.beamlines.i03.beamsize import Beamsize
+from dodal.devices.beamlines.i03.dcm import DCM
+from dodal.devices.beamlines.i03.undulator_dcm import UndulatorDCM
 from dodal.devices.collimation_table import CollimationTable
 from dodal.devices.cryostream import (
     CryoStreamGantry,
@@ -31,10 +35,6 @@ from dodal.devices.fluorescence_detector_motion import FluorescenceDetector
 from dodal.devices.flux import Flux
 from dodal.devices.focusing_mirror import FocusingMirrorWithStripes, MirrorVoltages
 from dodal.devices.hutch_shutter import HutchShutter
-from dodal.devices.i03 import Beamstop
-from dodal.devices.i03.beamsize import Beamsize
-from dodal.devices.i03.dcm import DCM
-from dodal.devices.i03.undulator_dcm import UndulatorDCM
 from dodal.devices.ipin import IPin
 from dodal.devices.motors import XYZStage
 from dodal.devices.oav.oav_detector import OAVBeamCentreFile

dodal/beamlines/i04.py

@@ -11,23 +11,24 @@ from dodal.devices.aperturescatterguard import (
 from dodal.devices.attenuator.attenuator import BinaryFilterAttenuator
 from dodal.devices.backlight import Backlight
 from dodal.devices.baton import Baton
+from dodal.devices.beamlines.i03.dcm import DCM
+from dodal.devices.beamlines.i04.beam_centre import CentreEllipseMethod
+from dodal.devices.beamlines.i04.beamsize import Beamsize
+from dodal.devices.beamlines.i04.constants import RedisConstants
+from dodal.devices.beamlines.i04.max_pixel import MaxPixel
+from dodal.devices.beamlines.i04.murko_results import MurkoResultsDevice
+from dodal.devices.beamlines.i04.transfocator import Transfocator
 from dodal.devices.detector.detector_motion import DetectorMotion
 from dodal.devices.diamond_filter import DiamondFilter, I04Filters
 from dodal.devices.eiger import EigerDetector
 from dodal.devices.fast_grid_scan import ZebraFastGridScanThreeD
 from dodal.devices.flux import Flux
-from dodal.devices.i03.dcm import DCM
-from dodal.devices.i04.beam_centre import CentreEllipseMethod
-from dodal.devices.i04.beamsize import Beamsize
-from dodal.devices.i04.constants import RedisConstants
-from dodal.devices.i04.max_pixel import MaxPixel
-from dodal.devices.i04.murko_results import MurkoResultsDevice
-from dodal.devices.i04.transfocator import Transfocator
 from dodal.devices.ipin import IPin
 from dodal.devices.motors import XYZStage
 from dodal.devices.mx_phase1.beamstop import Beamstop
 from dodal.devices.oav.oav_detector import (
     OAVBeamCentrePV,
+    ZoomControllerWithBeamCentres,
 )
 from dodal.devices.oav.oav_parameters import OAVConfig
 from dodal.devices.oav.oav_to_redis_forwarder import OAVToRedisForwarder
@@ -66,7 +67,6 @@ I04_ZEBRA_MAPPING = ZebraMapping(
     outputs=(ZebraTTLOutputs(TTL_DETECTOR=1, TTL_FAST_SHUTTER=2, TTL_XSPRESS3=3)),
     sources=ZebraSources(),
 )
-
 PREFIX = BeamlinePrefix(BL)
 
 devices = DeviceManager()
@@ -305,3 +305,11 @@ def beam_centre() -> CentreEllipseMethod:
     return CentreEllipseMethod(
         f"{PREFIX.beamline_prefix}-DI-OAV-01:",
     )
+
+
+@devices.factory()
+def zoom_controller() -> ZoomControllerWithBeamCentres:
+    """Get the i04 zoom controller, instantiate it if it hasn't already been.
+    If this is called when already instantiated in i04, it will return the existing object.
+    """
+    return ZoomControllerWithBeamCentres(f"{PREFIX.beamline_prefix}-EA-OAV-01:FZOOM:")

dodal/beamlines/i05.py

@@ -1,57 +1,19 @@
-from dodal.beamline_specific_utils.i05_shared import pgm as i05_pgm
-from dodal.common.beamlines.beamline_utils import (
-    device_factory,
-)
+from dodal.beamlines.i05_shared import devices as i05_shared_devices
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.insertion_device import (
-    Apple2,
-    UndulatorGap,
-    UndulatorLockedPhaseAxes,
-)
-from dodal.devices.pgm import PlaneGratingMonochromator
-from dodal.devices.synchrotron import Synchrotron
-from dodal.devices.temperture_controller import (
-    Lakeshore336,
-)
+from dodal.device_manager import DeviceManager
+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
 
+devices = DeviceManager()
+devices.include(i05_shared_devices)
+
 BL = get_beamline_name("i05")
 PREFIX = BeamlinePrefix(BL)
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
 
-@device_factory()
-def synchrotron() -> Synchrotron:
-    return Synchrotron()
-
-
-@device_factory()
-def pgm() -> PlaneGratingMonochromator:
-    return i05_pgm()
-
-
-@device_factory()
-def id_gap() -> UndulatorGap:
-    return UndulatorGap(prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:")
-
-
-@device_factory()
-def id_phase() -> UndulatorLockedPhaseAxes:
-    return UndulatorLockedPhaseAxes(
-        prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
-        top_outer="PL",
-        btm_inner="PU",
-    )
-
-
-@device_factory()
-def id() -> Apple2:
-    """i05 insertion device."""
-    return Apple2(id_gap=id_gap(), id_phase=id_phase())
-
-
-@device_factory()
+@devices.factory()
 def sample_temperature_controller() -> Lakeshore336:
     return Lakeshore336(prefix=f"{PREFIX.beamline_prefix}-EA-TCTRL-02:")

dodal/beamlines/i05_1.py

@@ -1,8 +1,6 @@
-from dodal.beamline_specific_utils.i05_shared import pgm as i05_pgm
-from dodal.common.beamlines.beamline_utils import device_factory
+from dodal.beamlines.i05_shared import devices as i05_shared_devices
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.pgm import PlaneGratingMonochromator
-from dodal.devices.synchrotron import Synchrotron
+from dodal.device_manager import DeviceManager
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
 
@@ -11,12 +9,5 @@ PREFIX = BeamlinePrefix(BL, suffix="J")
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
-
-@device_factory()
-def pgm() -> PlaneGratingMonochromator:
-    return i05_pgm()
-
-
-@device_factory()
-def synchrotron() -> Synchrotron:
-    return Synchrotron()
+devices = DeviceManager()
+devices.include(i05_shared_devices)

dodal/beamlines/i05_shared.py

@@ -0,0 +1,51 @@
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.i05.enums import Grating
+from dodal.devices.insertion_device import (
+    Apple2,
+    UndulatorGap,
+    UndulatorLockedPhaseAxes,
+)
+from dodal.devices.pgm import PlaneGratingMonochromator
+from dodal.devices.synchrotron import Synchrotron
+from dodal.utils import BeamlinePrefix, get_beamline_name
+
+BL = get_beamline_name("i05-shared")
+PREFIX = BeamlinePrefix("i05-shared", "I")
+
+devices = DeviceManager()
+
+
+@devices.factory()
+def synchrotron() -> Synchrotron:
+    return Synchrotron()
+
+
+@devices.factory()
+def pgm() -> PlaneGratingMonochromator:
+    return PlaneGratingMonochromator(
+        prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
+        grating=Grating,
+    )
+
+
+@devices.factory()
+def id_gap() -> UndulatorGap:
+    return UndulatorGap(prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:")
+
+
+@devices.factory()
+def id_phase() -> UndulatorLockedPhaseAxes:
+    return UndulatorLockedPhaseAxes(
+        prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
+        top_outer="PL",
+        btm_inner="PU",
+    )
+
+
+@devices.factory()
+def id(
+    id_gap: UndulatorGap,
+    id_phase: UndulatorLockedPhaseAxes,
+) -> Apple2[UndulatorLockedPhaseAxes]:
+    """i05 insertion device."""
+    return Apple2[UndulatorLockedPhaseAxes](id_gap=id_gap, id_phase=id_phase)

dodal/beamlines/i06_1.py

@@ -1,7 +1,6 @@
-from dodal.common.beamlines.beamline_utils import (
-    device_factory,
-)
+from dodal.beamlines.i06_shared import devices as i06_shared_devices
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.device_manager import DeviceManager
 from dodal.devices.temperture_controller import (
     Lakeshore336,
 )
@@ -13,12 +12,15 @@ PREFIX = BeamlinePrefix(BL, suffix="J")
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
+devices = DeviceManager()
+devices.include(i06_shared_devices)
+
 
-@device_factory()
+@devices.factory()
 def diff_cooling_temperature_controller() -> Lakeshore336:
     return Lakeshore336(prefix=f"{PREFIX.beamline_prefix}-EA-TCTRL-02:")
 
 
-@device_factory()
+@devices.factory()
 def diff_heating_temperature_controller() -> Lakeshore336:
     return Lakeshore336(prefix=f"{PREFIX.beamline_prefix}-EA-TCTRL-03:")

dodal/beamlines/{i06.py → i06_shared.py}

@@ -1,12 +1,12 @@
-from dodal.common.beamlines.beamline_utils import (
-    device_factory,
-)
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.i06_shared import I06Grating
 from dodal.devices.insertion_device import (
     Apple2,
     UndulatorGap,
     UndulatorLockedPhaseAxes,
 )
+from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -16,18 +16,20 @@ PREFIX = BeamlinePrefix(BL)
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
+devices = DeviceManager()
+
 
-@device_factory()
+@devices.factory()
 def synchrotron() -> Synchrotron:
     return Synchrotron()
 
 
-@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() -> UndulatorLockedPhaseAxes:
     return UndulatorLockedPhaseAxes(
         prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
@@ -36,18 +38,18 @@ def idd_phase() -> UndulatorLockedPhaseAxes:
     )
 
 
-@device_factory()
-def idd() -> Apple2:
+@devices.factory()
+def idd(idd_gap: UndulatorGap, idd_phase: UndulatorLockedPhaseAxes) -> Apple2:
     """i06 downstream insertion device."""
-    return Apple2(id_gap=idd_gap(), id_phase=idd_phase())
+    return Apple2(id_gap=idd_gap, id_phase=idd_phase)
 
 
-@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() -> UndulatorLockedPhaseAxes:
     return UndulatorLockedPhaseAxes(
         prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-21:",
@@ -56,7 +58,16 @@ def idu_phase() -> UndulatorLockedPhaseAxes:
     )
 
 
-@device_factory()
-def idu() -> Apple2:
+@devices.factory()
+def idu(idu_gap: UndulatorGap, idu_phase: UndulatorLockedPhaseAxes) -> Apple2:
     """i06 upstream insertion device."""
-    return Apple2(id_gap=idd_gap(), id_phase=idd_phase())
+    return Apple2(id_gap=idu_gap, id_phase=idu_phase)
+
+
+@devices.factory()
+def pgm() -> PlaneGratingMonochromator:
+    return PlaneGratingMonochromator(
+        prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
+        grating=I06Grating,
+        grating_pv="NLINES2",
+    )

dodal/beamlines/i07.py

@@ -1,7 +1,7 @@
-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.devices.i07.id import InsertionDevice
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.i07.dcm import DCM
+from dodal.devices.beamlines.i07.id import InsertionDevice
 from dodal.devices.undulator import UndulatorOrder
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -11,31 +11,29 @@ set_log_beamline(BL)
 set_utils_beamline(BL)
 PREFIX = BeamlinePrefix(BL)
 
+devices = DeviceManager()
 
-@device_factory()
+
+@devices.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",
+    """Instantiate DCM using two PV bases."""
+    return DCM(
+        f"{PREFIX.beamline_prefix}-MO-DCM-01:", f"{PREFIX.beamline_prefix}-DI-DCM-01:"
     )
-    return dcm
 
 
-@device_factory()
+@devices.factory()
 def harmonic() -> UndulatorOrder:
-    return UndulatorOrder("harmonic")
+    return UndulatorOrder()
 
 
-@device_factory()
-def id() -> InsertionDevice:
+@devices.factory()
+def id(harmonic: UndulatorOrder) -> InsertionDevice:
     """Get the i07 undulator device, instantiate it if it hasn't already been.
     If this is called when already instantiated it will return the existing object.
     """
     return InsertionDevice(
-        "id",
         f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
-        harmonic(),
+        harmonic,
         id_gap_lookup_table_path="/dls_sw/i07/software/gda/config/lookupTables/IIDCalibrationTable.txt",
     )