dls-dodal 1.29.3__py3-none-any.whl → 1.30.0__py3-none-any.whl

dodal/beamlines/i24.py

@@ -5,8 +5,9 @@ from dodal.devices.eiger import EigerDetector
 from dodal.devices.hutch_shutter import HutchShutter
 from dodal.devices.i24.aperture import Aperture
 from dodal.devices.i24.beamstop import Beamstop
+from dodal.devices.i24.dcm import DCM
 from dodal.devices.i24.dual_backlight import DualBacklight
-from dodal.devices.i24.I24_detector_motion import DetectorMotion
+from dodal.devices.i24.i24_detector_motion import DetectorMotion
 from dodal.devices.i24.i24_vgonio import VGonio
 from dodal.devices.i24.pmac import PMAC
 from dodal.devices.oav.oav_detector import OAV
@@ -82,6 +83,19 @@ def detector_motion(
     )
 
 
+def dcm(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) -> DCM:
+    """Get the i24 DCM device, instantiate it if it hasn't already been.
+    If this is called when already instantiated in i24, it will return the existing object.
+    """
+    return device_instantiation(
+        device_factory=DCM,
+        name="dcm",
+        prefix="",
+        wait=wait_for_connection,
+        fake=fake_with_ophyd_sim,
+    )
+
+
 @skip_device(lambda: BL == "s24")
 def eiger(
     wait_for_connection: bool = True,

dodal/beamlines/p38.py

@@ -55,7 +55,7 @@ def d3(
 
 
 # Disconnected
-@skip_device
+@skip_device()
 def d11(
     wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
 ) -> AravisDetector:
@@ -232,13 +232,13 @@ def dcm(
             usage="Bragg",
             type="silicon",
             reflection=(1, 1, 1),
-            d_spacing=3.13475,
+            d_spacing=(3.13475, "nm"),
         ),
         crystal_2_metadata=CrystalMetadata(
             usage="Bragg",
             type="silicon",
             reflection=(1, 1, 1),
-            d_spacing=3.13475,
+            d_spacing=(3.13475, "nm"),
         ),
     )
 
@@ -262,7 +262,7 @@ def undulator(
 # Must find which PandA IOC(s) are compatible
 # Must document what PandAs are physically connected to
 # See: https://github.com/bluesky/ophyd-async/issues/284
-@skip_device
+@skip_device()
 def panda1(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = False,
@@ -277,7 +277,7 @@ def panda1(
     )
 
 
-@skip_device
+@skip_device()
 def panda2(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = False,
@@ -292,7 +292,7 @@ def panda2(
     )
 
 
-@skip_device
+@skip_device()
 def panda3(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = False,
@@ -307,7 +307,7 @@ def panda3(
     )
 
 
-@skip_device
+@skip_device()
 def linkam(
     wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
 ) -> Linkam3:

dodal/beamlines/p45.py

@@ -1,3 +1,5 @@
+from pathlib import Path
+
 from ophyd_async.epics.areadetector import AravisDetector
 from ophyd_async.panda import HDFPanda
 
@@ -18,7 +20,7 @@ set_utils_beamline(BL)
 set_directory_provider(
     StaticVisitDirectoryProvider(
         BL,
-        "/data/2024/cm37283-2/",  # latest commissioning visit
+        Path("/data/2024/cm37283-2/"),  # latest commissioning visit
     )
 )
 
@@ -48,7 +50,7 @@ def choppers(
 
 
 # Disconnected
-@skip_device
+@skip_device()
 def det(
     wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
 ) -> AravisDetector:
@@ -65,7 +67,7 @@ def det(
 
 
 # Disconnected
-@skip_device
+@skip_device()
 def diff(
     wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
 ) -> AravisDetector:
@@ -84,7 +86,7 @@ def diff(
 # Must find which PandA IOC(s) are compatible
 # Must document what PandAs are physically connected to
 # See: https://github.com/bluesky/ophyd-async/issues/284
-@skip_device
+@skip_device()
 def panda1(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = False,
@@ -99,7 +101,7 @@ def panda1(
     )
 
 
-@skip_device
+@skip_device()
 def panda2(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = False,

dodal/beamlines/p99.py

@@ -0,0 +1,61 @@
+from dodal.common.beamlines.beamline_utils import device_instantiation, set_beamline
+from dodal.devices.motors import XYZPositioner
+from dodal.devices.p99.sample_stage import FilterMotor, SampleAngleStage
+from dodal.log import set_beamline as set_log_beamline
+from dodal.utils import get_beamline_name
+
+BL = get_beamline_name("BL99P")
+set_log_beamline(BL)
+set_beamline(BL)
+
+
+def sample_angle_stage(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> SampleAngleStage:
+    """Sample stage for p99"""
+
+    return device_instantiation(
+        SampleAngleStage,
+        prefix="-MO-STAGE-01:",
+        name="sample_angle_stage",
+        wait=wait_for_connection,
+        fake=fake_with_ophyd_sim,
+    )
+
+
+def sample_stage_filer(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> FilterMotor:
+    """Sample stage for p99"""
+
+    return device_instantiation(
+        FilterMotor,
+        prefix="-MO-STAGE-02:MP:SELECT",
+        name="sample_stage_filer",
+        wait=wait_for_connection,
+        fake=fake_with_ophyd_sim,
+    )
+
+
+def sample_xyz_stage(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> XYZPositioner:
+    return device_instantiation(
+        FilterMotor,
+        prefix="-MO-STAGE-02:",
+        name="sample_xyz_stage",
+        wait=wait_for_connection,
+        fake=fake_with_ophyd_sim,
+    )
+
+
+def sample_lab_xyz_stage(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> XYZPositioner:
+    return device_instantiation(
+        FilterMotor,
+        prefix="-MO-STAGE-02:LAB:",
+        name="sample_lab_xyz_stage",
+        wait=wait_for_connection,
+        fake=fake_with_ophyd_sim,
+    )

dodal/cli.py

@@ -58,10 +58,13 @@ def connect(beamline: str, all: bool, sim_backend: bool) -> None:
         include_skipped=all,
         fake_with_ophyd_sim=sim_backend,
     )
-    sim_statement = "(sim mode)" if sim_backend else ""
+    sim_statement = " (sim mode)" if sim_backend else ""
 
-    print(f"{len(devices)} devices connected {sim_statement}:")
-    print("\n".join([f"\t{device_name}" for device_name in devices.keys()]))
+    print(f"{len(devices)} devices connected{sim_statement}:")
+    connected_devices = "\n".join(
+        sorted([f"\t{device_name}" for device_name in devices.keys()])
+    )
+    print(connected_devices)
 
     # If exceptions have occurred, this will print details of the relevant PVs
     if len(exceptions) > 0:

dodal/common/beamlines/beamline_parameters.py

@@ -1,4 +1,4 @@
-from typing import Any, Tuple, cast
+from typing import Any, cast
 
 from dodal.log import LOGGER
 from dodal.utils import get_beamline_name
@@ -31,7 +31,7 @@ class GDABeamlineParameters:
             for line in config_lines_nocomments
         ]
         config_pairs: list[tuple[str, Any]] = [
-            cast(Tuple[str, Any], param)
+            cast(tuple[str, Any], param)
             for param in config_lines_sep_key_and_value
             if len(param) == 2
         ]

dodal/common/beamlines/beamline_utils.py

@@ -1,5 +1,6 @@
 import inspect
-from typing import Callable, Dict, Final, List, Optional, TypeVar, cast
+from collections.abc import Callable
+from typing import Final, TypeVar, cast
 
 from bluesky.run_engine import call_in_bluesky_event_loop
 from ophyd import Device as OphydV1Device
@@ -12,7 +13,7 @@ from dodal.utils import AnyDevice, BeamlinePrefix, skip_device
 
 DEFAULT_CONNECTION_TIMEOUT: Final[float] = 5.0
 
-ACTIVE_DEVICES: Dict[str, AnyDevice] = {}
+ACTIVE_DEVICES: dict[str, AnyDevice] = {}
 BL = ""
 DIRECTORY_PROVIDER: UpdatingDirectoryProvider | None = None
 
@@ -33,7 +34,7 @@ def clear_device(name: str):
     del ACTIVE_DEVICES[name]
 
 
-def list_active_devices() -> List[str]:
+def list_active_devices() -> list[str]:
     global ACTIVE_DEVICES
     return list(ACTIVE_DEVICES.keys())
 
@@ -59,7 +60,7 @@ def wait_for_connection(
         )
     else:
         raise TypeError(
-            "Invalid type {} in _wait_for_connection".format(device.__class__.__name__)
+            f"Invalid type {device.__class__.__name__} in _wait_for_connection"
         )
 
 
@@ -73,7 +74,7 @@ def device_instantiation(
     prefix: str,
     wait: bool,
     fake: bool,
-    post_create: Optional[Callable[[T], None]] = None,
+    post_create: Callable[[T], None] | None = None,
     bl_prefix: bool = True,
     **kwargs,
 ) -> T:

dodal/common/maths.py

@@ -1,9 +1,7 @@
-from typing import Tuple
-
 import numpy as np
 
 
-def step_to_num(start: float, stop: float, step: float) -> Tuple[float, float, int]:
+def step_to_num(start: float, stop: float, step: float) -> tuple[float, float, int]:
     """
     Standard handling for converting from start, stop, step to start, stop, num
     Forces step to be same direction as length

dodal/common/types.py

@@ -1,8 +1,7 @@
 from abc import ABC, abstractmethod
+from collections.abc import Callable, Generator
 from typing import (
     Any,
-    Callable,
-    Generator,
 )
 
 from bluesky.utils import Msg
@@ -18,4 +17,4 @@ PlanGenerator = Callable[..., MsgGenerator]
 
 class UpdatingDirectoryProvider(DirectoryProvider, ABC):
     @abstractmethod
-    def update(self, **kwargs) -> None: ...
+    async def update(self, **kwargs) -> None: ...

dodal/common/udc_directory_provider.py

@@ -8,7 +8,7 @@ from dodal.log import LOGGER
 
 class PandASubdirectoryProvider(UpdatingDirectoryProvider):
     """Directory provider for the HDFPanda. Points to a panda subdirectory within the
-    directory path provided, which must exist before attempting to arm the PCAP block"""
+    directory path provided"""
 
     resource_dir = Path("panda")
 
@@ -23,9 +23,20 @@ class PandASubdirectoryProvider(UpdatingDirectoryProvider):
             else None
         )
 
-    def update(self, directory: Path):
+    async def update(self, *, directory: Path, suffix: str = "", **kwargs):
+        """Update the root directory into which panda pcap files are written. This will result in the panda
+        subdirectory being created if it does not already exist.
+         Args:
+             directory: Path instance that identifies the root folder. This folder must exist. The panda will
+                attempt to write into the "panda" subdirectory which will be created if not already present.
+             suffix: Optional str that will be appended to the panda device name along with the file
+                type extension to construct the output filename
+        """
+        output_directory = directory / self.resource_dir
+        output_directory.mkdir(exist_ok=True)
+
         self._directory_info = DirectoryInfo(
-            root=directory, resource_dir=self.resource_dir
+            root=directory, resource_dir=self.resource_dir, suffix=suffix
         )
 
     def __call__(self) -> DirectoryInfo:

dodal/common/visit.py

@@ -1,6 +1,5 @@
 from abc import ABC, abstractmethod
 from pathlib import Path
-from typing import Optional
 
 from aiohttp import ClientSession
 from ophyd_async.core import DirectoryInfo
@@ -105,7 +104,7 @@ class StaticVisitDirectoryProvider(UpdatingDirectoryProvider):
         self,
         beamline: str,
         root: Path,
-        client: Optional[DirectoryServiceClientBase] = None,
+        client: DirectoryServiceClientBase | None = None,
     ):
         self._beamline = beamline
         self._client = client or DirectoryServiceClient(f"{beamline}-control:8088/api")
@@ -113,7 +112,7 @@ class StaticVisitDirectoryProvider(UpdatingDirectoryProvider):
         self._current_collection = None
         self._session = None
 
-    async def update(self) -> None:
+    async def update(self, **kwargs) -> None:
         """
         Creates a new data collection in the current visit.
         """

dodal/devices/CTAB.py

@@ -1,8 +1,9 @@
-from ophyd import Component as Cpt
-from ophyd import Device, EpicsMotor, EpicsSignalRO
+from ophyd_async.core import StandardReadable
+from ophyd_async.epics.motion import Motor
+from ophyd_async.epics.signal import epics_signal_r
 
 
-class CTAB(Device):
+class CTAB(StandardReadable):
     """Basic collimantion table (CTAB) device for motion plus the motion disable signal
     when laser curtain triggered and hutch not locked.
 
@@ -17,20 +18,24 @@ class CTAB(Device):
     these disabling systems is to cut power to the motors - signal for this is crate_power
     """
 
-    inboard_y = Cpt(EpicsMotor, "-MO-TABLE-01:INBOARDY")
-    outboard_y = Cpt(EpicsMotor, "-MO-TABLE-01:OUTBOARDY")
-    upstream_y = Cpt(EpicsMotor, "-MO-TABLE-01:UPSTREAMY")
-    combined_downstream_y = Cpt(EpicsMotor, "-MO-TABLE-01:DOWNSTREAMY")
-    combined_all_y = Cpt(EpicsMotor, "-MO-TABLE-01:Y")
+    def __init__(self, prefix: str, name: str = ""):
+        with self.add_children_as_readables():
+            self.inboard_y = Motor(prefix + "-MO-TABLE-01:INBOARDY")
+            self.outboard_y = Motor(prefix + "-MO-TABLE-01:OUTBOARDY")
+            self.upstream_y = Motor(prefix + "-MO-TABLE-01:UPSTREAMY")
+            self.combined_downstream_y = Motor(prefix + "-MO-TABLE-01:DOWNSTREAMY")
+            self.combined_all_y = Motor(prefix + "-MO-TABLE-01:Y")
 
-    downstream_x = Cpt(EpicsMotor, "-MO-TABLE-01:DOWNSTREAMX")
-    upstream_x = Cpt(EpicsMotor, "-MO-TABLE-01:UPSTREAMX")
-    combined_all_x = Cpt(EpicsMotor, "-MO-TABLE-01:X")
+            self.downstream_x = Motor(prefix + "-MO-TABLE-01:DOWNSTREAMX")
+            self.upstream_x = Motor(prefix + "-MO-TABLE-01:UPSTREAMX")
+            self.combined_all_x = Motor(prefix + "-MO-TABLE-01:X")
 
-    pitch = Cpt(EpicsMotor, "-MO-TABLE-01:PITCH")
-    roll = Cpt(EpicsMotor, "-MO-TABLE-01:ROLL")
-    yaw = Cpt(EpicsMotor, "-MO-TABLE-01:YAW")
+            self.pitch = Motor(prefix + "-MO-TABLE-01:PITCH")
+            self.roll = Motor(prefix + "-MO-TABLE-01:ROLL")
+            self.yaw = Motor(prefix + "-MO-TABLE-01:YAW")
 
-    crate_power = Cpt(
-        EpicsSignalRO, "-MO-PMAC-02:CRATE2_HEALTHY"
-    )  # returns 0 if no power
+            self.crate_power = epics_signal_r(
+                int, prefix + "-MO-PMAC-02:CRATE2_HEALTHY"
+            )  # returns 0 if no power
+
+            super().__init__(name)