dls-dodal 1.29.4__py3-none-any.whl → 1.31.0__py3-none-any.whl

dodal/beamlines/i13_1.py

@@ -0,0 +1,66 @@
+from pathlib import Path
+
+from ophyd_async.epics.adaravis import AravisDetector
+
+from dodal.common.beamlines.beamline_utils import (
+    device_instantiation,
+    get_path_provider,
+    set_path_provider,
+)
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.visit import StaticVisitPathProvider
+from dodal.devices.motors import XYZPositioner
+from dodal.log import set_beamline as set_log_beamline
+from dodal.utils import get_beamline_name
+
+BL = get_beamline_name("i13-1")
+set_log_beamline(BL)
+set_utils_beamline(BL)
+set_path_provider(
+    StaticVisitPathProvider(
+        BL,
+        Path("/data/2024/cm37257-4/"),  # latest commissioning visit
+    )
+)
+
+
+def sample_xyz_stage(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> XYZPositioner:
+    return device_instantiation(
+        XYZPositioner,
+        prefix="BL13J-MO-PI-02:",
+        name="sample_xyz_stage",
+        wait=wait_for_connection,
+        fake=fake_with_ophyd_sim,
+        bl_prefix=False,
+    )
+
+
+def sample_xyz_lab_fa_stage(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> XYZPositioner:
+    return device_instantiation(
+        XYZPositioner,
+        prefix="BL13J-MO-PI-02:FIXANG:",
+        name="sample_xyz_lab_fa_stage",
+        wait=wait_for_connection,
+        fake=fake_with_ophyd_sim,
+        bl_prefix=False,
+    )
+
+
+def side_camera(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> AravisDetector:
+    return device_instantiation(
+        AravisDetector,
+        prefix="BL13J-OP-FLOAT-03:",
+        name="side_camera",
+        bl_prefix=False,
+        drv_suffix="CAM:",
+        hdf_suffix="HDF5:",
+        path_provider=get_path_provider(),
+        wait=wait_for_connection,
+        fake=fake_with_ophyd_sim,
+    )

dodal/beamlines/i22.py

@@ -1,16 +1,17 @@
 from pathlib import Path
 
-from ophyd_async.epics.areadetector import AravisDetector, PilatusDetector
-from ophyd_async.panda import HDFPanda
+from ophyd_async.epics.adaravis import AravisDetector
+from ophyd_async.epics.adpilatus import PilatusDetector
+from ophyd_async.fastcs.panda import HDFPanda
 
 from dodal.common.beamlines.beamline_utils import (
     device_instantiation,
-    get_directory_provider,
-    set_directory_provider,
+    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 numbered_slits
-from dodal.common.visit import DirectoryServiceClient, StaticVisitDirectoryProvider
+from dodal.common.visit import RemoteDirectoryServiceClient, StaticVisitPathProvider
 from dodal.devices.focusing_mirror import FocusingMirror
 from dodal.devices.i22.dcm import CrystalMetadata, DoubleCrystalMonochromator
 from dodal.devices.i22.fswitch import FSwitch
@@ -32,11 +33,11 @@ set_utils_beamline(BL)
 # Communication with GDA is also WIP so for now we determine an arbitrary scan number
 # locally and write the commissioning directory. The scan number is not guaranteed to
 # be unique and the data is at risk - this configuration is for testing only.
-set_directory_provider(
-    StaticVisitDirectoryProvider(
+set_path_provider(
+    StaticVisitPathProvider(
         BL,
         Path("/dls/i22/data/2024/cm37271-2/bluesky"),
-        client=DirectoryServiceClient("http://i22-control:8088/api"),
+        client=RemoteDirectoryServiceClient("http://i22-control:8088/api"),
     )
 )
 
@@ -61,7 +62,7 @@ def saxs(
             sensor_thickness=(0.45, "mm"),
             distance=(4711.833684146172, "mm"),
         ),
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
@@ -97,7 +98,7 @@ def waxs(
             sensor_thickness=(0.45, "mm"),
             distance=(175.4199417092314, "mm"),
         ),
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
@@ -112,7 +113,7 @@ def i0(
         wait_for_connection,
         fake_with_ophyd_sim,
         type="Cividec Diamond XBPM",
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
@@ -127,7 +128,7 @@ def it(
         wait_for_connection,
         fake_with_ophyd_sim,
         type="PIN Diode",
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
@@ -234,7 +235,6 @@ def slits_3(
     )
 
 
-@skip_device
 def slits_4(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = False,
@@ -296,11 +296,11 @@ def panda1(
         "-EA-PANDA-01:",
         wait_for_connection,
         fake_with_ophyd_sim,
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
-@skip_device
+@skip_device()
 def panda2(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = False,
@@ -311,11 +311,11 @@ def panda2(
         "-EA-PANDA-02:",
         wait_for_connection,
         fake_with_ophyd_sim,
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
-@skip_device
+@skip_device()
 def panda3(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = False,
@@ -326,11 +326,11 @@ def panda3(
         "-EA-PANDA-03:",
         wait_for_connection,
         fake_with_ophyd_sim,
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
-@skip_device
+@skip_device()
 def panda4(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = False,
@@ -341,7 +341,7 @@ def panda4(
         "-EA-PANDA-04:",
         wait_for_connection,
         fake_with_ophyd_sim,
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
@@ -362,11 +362,11 @@ def oav(
             description="AVT Mako G-507B",
             distance=(-1.0, "m"),
         ),
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
-@skip_device
+@skip_device()
 def linkam(
     wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
 ) -> Linkam3:

dodal/beamlines/i24.py

@@ -7,7 +7,7 @@ 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

dodal/beamlines/p38.py

@@ -1,16 +1,16 @@
 from pathlib import Path
 
-from ophyd_async.epics.areadetector import AravisDetector
-from ophyd_async.panda import HDFPanda
+from ophyd_async.epics.adaravis import AravisDetector
+from ophyd_async.fastcs.panda import HDFPanda
 
 from dodal.common.beamlines.beamline_utils import (
     device_instantiation,
-    get_directory_provider,
-    set_directory_provider,
+    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 numbered_slits
-from dodal.common.visit import LocalDirectoryServiceClient, StaticVisitDirectoryProvider
+from dodal.common.visit import LocalDirectoryServiceClient, StaticVisitPathProvider
 from dodal.devices.focusing_mirror import FocusingMirror
 from dodal.devices.i22.dcm import CrystalMetadata, DoubleCrystalMonochromator
 from dodal.devices.i22.fswitch import FSwitch
@@ -30,8 +30,8 @@ set_utils_beamline(BL)
 # Communication with GDA is also WIP so for now we determine an arbitrary scan number
 # locally and write the commissioning directory. The scan number is not guaranteed to
 # be unique and the data is at risk - this configuration is for testing only.
-set_directory_provider(
-    StaticVisitDirectoryProvider(
+set_path_provider(
+    StaticVisitPathProvider(
         BL,
         Path("/dls/p38/data/2024/cm37282-2/bluesky"),
         client=LocalDirectoryServiceClient(),
@@ -50,12 +50,12 @@ def d3(
         fake_with_ophyd_sim,
         drv_suffix="DET:",
         hdf_suffix="HDF5:",
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
 # Disconnected
-@skip_device
+@skip_device()
 def d11(
     wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
 ) -> AravisDetector:
@@ -67,7 +67,7 @@ def d11(
         fake_with_ophyd_sim,
         drv_suffix="DET:",
         hdf_suffix="HDF5:",
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
@@ -82,7 +82,7 @@ def d12(
         fake_with_ophyd_sim,
         drv_suffix="DET:",
         hdf_suffix="HDF5:",
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
@@ -96,7 +96,7 @@ def i0(
         "-EA-XBPM-01:",
         wait_for_connection,
         fake_with_ophyd_sim,
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
@@ -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,
@@ -273,11 +273,11 @@ def panda1(
         "-EA-PANDA-01:",
         wait_for_connection,
         fake_with_ophyd_sim,
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
-@skip_device
+@skip_device()
 def panda2(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = False,
@@ -288,11 +288,11 @@ def panda2(
         "-EA-PANDA-02:",
         wait_for_connection,
         fake_with_ophyd_sim,
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
-@skip_device
+@skip_device()
 def panda3(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = False,
@@ -303,11 +303,11 @@ def panda3(
         "-EA-PANDA-03:",
         wait_for_connection,
         fake_with_ophyd_sim,
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
-@skip_device
+@skip_device()
 def linkam(
     wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
 ) -> Linkam3:

dodal/beamlines/p45.py

@@ -1,13 +1,15 @@
-from ophyd_async.epics.areadetector import AravisDetector
-from ophyd_async.panda import HDFPanda
+from pathlib import Path
+
+from ophyd_async.epics.adaravis import AravisDetector
+from ophyd_async.fastcs.panda import HDFPanda
 
 from dodal.common.beamlines.beamline_utils import (
     device_instantiation,
-    get_directory_provider,
-    set_directory_provider,
+    get_path_provider,
+    set_path_provider,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.common.visit import StaticVisitDirectoryProvider
+from dodal.common.visit import StaticVisitPathProvider
 from dodal.devices.p45 import Choppers, TomoStageWithStretchAndSkew
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import get_beamline_name, skip_device
@@ -15,10 +17,10 @@ from dodal.utils import get_beamline_name, skip_device
 BL = get_beamline_name("p45")
 set_log_beamline(BL)
 set_utils_beamline(BL)
-set_directory_provider(
-    StaticVisitDirectoryProvider(
+set_path_provider(
+    StaticVisitPathProvider(
         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:
@@ -60,12 +62,12 @@ def det(
         fake_with_ophyd_sim,
         drv_suffix="DET:",
         hdf_suffix="HDF5:",
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
 # Disconnected
-@skip_device
+@skip_device()
 def diff(
     wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
 ) -> AravisDetector:
@@ -77,14 +79,14 @@ def diff(
         fake_with_ophyd_sim,
         drv_suffix="DET:",
         hdf_suffix="HDF5:",
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
 # 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,
@@ -95,11 +97,11 @@ def panda1(
         "-MO-PANDA-01:",
         wait_for_connection,
         fake_with_ophyd_sim,
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )
 
 
-@skip_device
+@skip_device()
 def panda2(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = False,
@@ -110,5 +112,5 @@ def panda2(
         "-MO-PANDA-02:",
         wait_for_connection,
         fake_with_ophyd_sim,
-        directory_provider=get_directory_provider(),
+        path_provider=get_path_provider(),
     )

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/beamlines/training_rig.py

@@ -0,0 +1,64 @@
+from pathlib import Path
+
+from ophyd_async.epics.adaravis import AravisDetector
+
+from dodal.common.beamlines.beamline_utils import (
+    device_instantiation,
+    get_path_provider,
+    set_path_provider,
+)
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.visit import LocalDirectoryServiceClient, StaticVisitPathProvider
+from dodal.devices.training_rig.sample_stage import TrainingRigSampleStage
+from dodal.log import set_beamline as set_log_beamline
+from dodal.utils import get_beamline_name
+
+#
+# HTSS Training Rig
+#
+# A mock-beamline design that is employed at Diamond, consisting of a pair of
+# simple motors, a GigE camera and a PandA.
+# Since there are multiple rigs whose PVs are identical aside from the prefix,
+# this module can be used for any rig. It should fill in the prefix automatically
+# if the ${BEAMLINE} environment variable is correctly set. It currently defaults
+# to p47.
+#
+
+BL = get_beamline_name("p47")
+set_log_beamline(BL)
+set_utils_beamline(BL)
+
+set_path_provider(
+    StaticVisitPathProvider(
+        BL,
+        Path("/exports/mybeamline/data"),
+        client=LocalDirectoryServiceClient(),
+    )
+)
+
+
+def sample_stage(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> TrainingRigSampleStage:
+    return device_instantiation(
+        TrainingRigSampleStage,
+        "sample_stage",
+        "-MO-MAP-01:STAGE:",
+        wait_for_connection,
+        fake_with_ophyd_sim,
+    )
+
+
+def det(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> AravisDetector:
+    return device_instantiation(
+        AravisDetector,
+        "det",
+        "-EA-DET-01:",
+        wait_for_connection,
+        fake_with_ophyd_sim,
+        drv_suffix="DET:",
+        hdf_suffix="HDF5:",
+        path_provider=get_path_provider(),
+    )

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
@@ -7,7 +7,7 @@ BEAMLINE_PARAMETER_KEYWORDS = ["FB", "FULL", "deadtime"]
 
 BEAMLINE_PARAMETER_PATHS = {
     "i03": "/dls_sw/i03/software/daq_configuration/domain/beamlineParameters",
-    "i04": "/dls_sw/i04/software/gda_versions/gda_9_29/workspace_git/gda-mx.git/configurations/i04-config/scripts/beamlineParameters",
+    "i04": "/dls_sw/i04/software/gda_versions/gda_9_34/workspace_git/gda-mx.git/configurations/i04-config/scripts/beamlineParameters",
     "s03": "tests/test_data/test_beamline_parameters.txt",
 }
 
@@ -15,6 +15,9 @@ BEAMLINE_PARAMETER_PATHS = {
 class GDABeamlineParameters:
     params: dict[str, Any]
 
+    def __init__(self, params: dict[str, Any]):
+        self.params = params
+
     def __repr__(self) -> str:
         return repr(self.params)
 
@@ -23,7 +26,6 @@ class GDABeamlineParameters:
 
     @classmethod
     def from_lines(cls, file_name: str, config_lines: list[str]):
-        ob = cls()
         config_lines_nocomments = [line.split("#", 1)[0] for line in config_lines]
         config_lines_sep_key_and_value = [
             # XXX removes all whitespace instead of just trim
@@ -31,7 +33,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
         ]
@@ -46,8 +48,7 @@ class GDABeamlineParameters:
             except Exception as e:
                 LOGGER.warning(f"Unable to parse {file_name} line {i}: {e}")
 
-        ob.params = dict(config_pairs)
-        return ob
+        return cls(params=dict(config_pairs))
 
     @classmethod
     def from_file(cls, path: str):