dls-dodal 1.48.0__tar.gz → 1.49.0__tar.gz

{dls_dodal-1.48.0 → dls_dodal-1.49.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dls-dodal
-Version: 1.48.0
+Version: 1.49.0
 Summary: Ophyd devices and other utils that could be used across DLS beamlines
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>
 License:                                  Apache License
@@ -234,6 +234,7 @@ Requires-Dist: aiohttp
 Requires-Dist: redis
 Requires-Dist: deepdiff
 Requires-Dist: scanspec>=0.7.3
+Requires-Dist: event-model>=1.23
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: diff-cover; extra == "dev"

{dls_dodal-1.48.0 → dls_dodal-1.49.0}/conftest.py

@@ -39,6 +39,7 @@ mock_attributes_table = {
     "s04": mock_paths,
     "i19_1": mock_paths,
     "i24": mock_paths,
+    "aithre": mock_paths,
 }
 
 BANNED_PATHS = [Path("/dls"), Path("/dls_sw")]

{dls_dodal-1.48.0 → dls_dodal-1.49.0}/pyproject.toml

@@ -33,6 +33,7 @@ dependencies = [
     "redis",
     "deepdiff",
     "scanspec>=0.7.3",
+    "event-model>=1.23",  # Until bluesky pins it https://github.com/DiamondLightSource/dodal/issues/1278
 ]
 
 dynamic = ["version"]

{dls_dodal-1.48.0 → dls_dodal-1.49.0}/src/dls_dodal.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dls-dodal
-Version: 1.48.0
+Version: 1.49.0
 Summary: Ophyd devices and other utils that could be used across DLS beamlines
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>
 License:                                  Apache License
@@ -234,6 +234,7 @@ Requires-Dist: aiohttp
 Requires-Dist: redis
 Requires-Dist: deepdiff
 Requires-Dist: scanspec>=0.7.3
+Requires-Dist: event-model>=1.23
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: diff-cover; extra == "dev"

{dls_dodal-1.48.0 → dls_dodal-1.49.0}/src/dls_dodal.egg-info/SOURCES.txt

@@ -49,6 +49,8 @@ docs/explanations/decisions/0003-codeowners.md
 docs/explanations/decisions/0004-make-devices-factory.md
 docs/explanations/decisions/0005-standardise-devices-at-epics-level.md
 docs/explanations/decisions/COPYME
+docs/explanations/umls/apple2_design.png
+docs/explanations/umls/i10_id_design.png
 docs/how-to/build-docs.md
 docs/how-to/contribute.md
 docs/how-to/coverage.md
@@ -96,6 +98,8 @@ src/dodal/beamlines/aithre.py
 src/dodal/beamlines/b01_1.py
 src/dodal/beamlines/b07.py
 src/dodal/beamlines/b07_1.py
+src/dodal/beamlines/b16.py
+src/dodal/beamlines/b18.py
 src/dodal/beamlines/i02_1.py
 src/dodal/beamlines/i03.py
 src/dodal/beamlines/i04.py
@@ -111,6 +115,7 @@ src/dodal/beamlines/i20_1.py
 src/dodal/beamlines/i22.py
 src/dodal/beamlines/i23.py
 src/dodal/beamlines/i24.py
+src/dodal/beamlines/k11.py
 src/dodal/beamlines/p38.py
 src/dodal/beamlines/p45.py
 src/dodal/beamlines/p60.py
@@ -177,6 +182,8 @@ src/dodal/devices/areadetector/plugins/MJPG.py
 src/dodal/devices/attenuator/attenuator.py
 src/dodal/devices/attenuator/filter.py
 src/dodal/devices/attenuator/filter_selections.py
+src/dodal/devices/b16/__init__.py
+src/dodal/devices/b16/detector.py
 src/dodal/devices/current_amplifiers/__init__.py
 src/dodal/devices/current_amplifiers/current_amplifier.py
 src/dodal/devices/current_amplifiers/current_amplifier_detector.py
@@ -190,6 +197,8 @@ src/dodal/devices/detector/det_resolution.py
 src/dodal/devices/detector/detector.py
 src/dodal/devices/detector/detector_motion.py
 src/dodal/devices/electron_analyser/__init__.py
+src/dodal/devices/electron_analyser/detector.py
+src/dodal/devices/electron_analyser/enums.py
 src/dodal/devices/electron_analyser/types.py
 src/dodal/devices/electron_analyser/util.py
 src/dodal/devices/electron_analyser/abstract/__init__.py
@@ -199,10 +208,12 @@ src/dodal/devices/electron_analyser/abstract/base_region.py
 src/dodal/devices/electron_analyser/specs/__init__.py
 src/dodal/devices/electron_analyser/specs/detector.py
 src/dodal/devices/electron_analyser/specs/driver_io.py
+src/dodal/devices/electron_analyser/specs/enums.py
 src/dodal/devices/electron_analyser/specs/region.py
 src/dodal/devices/electron_analyser/vgscienta/__init__.py
 src/dodal/devices/electron_analyser/vgscienta/detector.py
 src/dodal/devices/electron_analyser/vgscienta/driver_io.py
+src/dodal/devices/electron_analyser/vgscienta/enums.py
 src/dodal/devices/electron_analyser/vgscienta/region.py
 src/dodal/devices/i03/__init__.py
 src/dodal/devices/i03/dcm.py
@@ -211,6 +222,7 @@ src/dodal/devices/i04/__init__.py
 src/dodal/devices/i04/constants.py
 src/dodal/devices/i04/murko_results.py
 src/dodal/devices/i04/transfocator.py
+src/dodal/devices/i10/__init__.py
 src/dodal/devices/i10/diagnostics.py
 src/dodal/devices/i10/i10_apple2.py
 src/dodal/devices/i10/i10_setting_data.py
@@ -313,6 +325,7 @@ tests/fake_device_factory_beamline.py
 tests/test_utils.py
 tests/beamlines/__init__.py
 tests/beamlines/unit_tests/__init__.py
+tests/beamlines/unit_tests/test_b16.py
 tests/beamlines/unit_tests/test_i03.py
 tests/beamlines/unit_tests/test_i24.py
 tests/beamlines/unit_tests/test_mapping.py

{dls_dodal-1.48.0 → dls_dodal-1.49.0}/src/dls_dodal.egg-info/requires.txt

@@ -18,6 +18,7 @@ aiohttp
 redis
 deepdiff
 scanspec>=0.7.3
+event-model>=1.23
 
 [dev]
 black

{dls_dodal-1.48.0 → dls_dodal-1.49.0}/src/dodal/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.48.0'
-__version_tuple__ = version_tuple = (1, 48, 0)
+__version__ = version = '1.49.0'
+__version_tuple__ = version_tuple = (1, 49, 0)

dls_dodal-1.49.0/src/dodal/beamlines/aithre.py

@@ -0,0 +1,30 @@
+from dodal.common.beamlines.beamline_utils import device_factory
+from dodal.devices.aithre_lasershaping.goniometer import Goniometer
+from dodal.devices.aithre_lasershaping.laser_robot import LaserRobot
+from dodal.devices.oav.oav_detector import NullZoomController, OAVBeamCentreFile
+from dodal.devices.oav.oav_parameters import OAVConfigBeamCentre
+
+ZOOM_PARAMS_FILE = "/dls_sw/i23/software/aithre/aithre_oav.xml"
+DISPLAY_CONFIG = "/dls_sw/i23/software/aithre/aithre_display.configuration"
+
+PREFIX = "LA18L"
+
+
+@device_factory()
+def goniometer() -> Goniometer:
+    return Goniometer(f"{PREFIX}-MO-LSR-01:", "goniometer")
+
+
+@device_factory()
+def robot() -> LaserRobot:
+    return LaserRobot("robot", f"{PREFIX}-MO-ROBOT-01:")
+
+
+@device_factory()
+def oav(params: OAVConfigBeamCentre | None = None) -> OAVBeamCentreFile:
+    return OAVBeamCentreFile(
+        prefix=f"{PREFIX}-DI-OAV-01:",
+        config=params or OAVConfigBeamCentre(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
+        name="oav",
+        zoom_controller=NullZoomController(),
+    )

dls_dodal-1.49.0/src/dodal/beamlines/b16.py

@@ -0,0 +1,65 @@
+from pathlib import Path
+
+from ophyd_async.epics.adcore import (
+    AreaDetector,
+)
+from ophyd_async.epics.motor import Motor
+
+from dodal.common.beamlines.beamline_utils import (
+    device_factory,
+    set_path_provider,
+)
+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 (
+    software_triggered_tiff_area_detector,
+)
+from dodal.devices.motors import XYZPositioner
+from dodal.log import set_beamline as set_log_beamline
+from dodal.utils import BeamlinePrefix, get_beamline_name
+
+BL = get_beamline_name("b16")
+PREFIX = BeamlinePrefix(BL)
+set_log_beamline(BL)
+set_utils_beamline(BL)
+
+set_path_provider(
+    StaticVisitPathProvider(
+        BL,
+        Path("/dls/b16/data/2025/cm40635-3/bluesky"),
+        client=RemoteDirectoryServiceClient("http://b16-control:8088/api"),
+    )
+)
+
+
+@device_factory()
+def attol1() -> Motor:
+    return Motor(f"{PREFIX.beamline_prefix}-EA-ECC-03:ACT0")
+
+
+@device_factory()
+def attol2() -> Motor:
+    return Motor(f"{PREFIX.beamline_prefix}-EA-ECC-03:ACT1")
+
+
+@device_factory()
+def attol3() -> Motor:
+    return Motor(f"{PREFIX.beamline_prefix}-EA-ECC-03:ACT2")
+
+
+@device_factory()
+def attorot1() -> Motor:
+    return Motor(f"{PREFIX.beamline_prefix}-EA-ECC-02:ACT2")
+
+
+@device_factory()
+def fds2() -> AreaDetector:
+    prefix = f"{PREFIX.beamline_prefix}-EA-FDS-02:"
+    return software_triggered_tiff_area_detector(prefix)
+
+
+@device_factory()
+def sim_stage() -> XYZPositioner:
+    return XYZPositioner(
+        f"{PREFIX.beamline_prefix}-MO-SIM-01:", "sim_stage", infix=("M1", "M2", "M3")
+    )

dls_dodal-1.49.0/src/dodal/beamlines/b18.py

@@ -0,0 +1,38 @@
+from pathlib import Path
+
+from dodal.common.beamlines.beamline_utils import (
+    device_factory,
+    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.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("b18")
+PREFIX = BeamlinePrefix(BL)
+set_log_beamline(BL)
+set_utils_beamline(BL)
+
+
+# Currently we must hard-code the visit, determining the visit at runtime requires
+# infrastructure that is still WIP.
+# 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_path_provider(
+    StaticVisitPathProvider(
+        BL,
+        Path("/dls/b18/data/2025/cm40637-3/bluesky"),
+        client=LocalDirectoryServiceClient(),
+    )
+)
+
+
+@device_factory()
+def synchrotron() -> Synchrotron:
+    return Synchrotron()

dls_dodal-1.49.0/src/dodal/beamlines/i10.py

@@ -0,0 +1,221 @@
+"""
+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.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.devices.current_amplifiers import CurrentAmpDet
+from dodal.devices.i10.diagnostics import I10Diagnostic, I10Diagnostic5ADet
+from dodal.devices.i10.i10_apple2 import (
+    I10Id,
+)
+from dodal.devices.i10.i10_setting_data import I10Grating
+from dodal.devices.i10.mirrors import PiezoMirror
+from dodal.devices.i10.rasor.rasor_current_amp import RasorFemto, RasorSR570
+from dodal.devices.i10.rasor.rasor_motors import (
+    DetSlits,
+    Diffractometer,
+    PaStage,
+    PinHole,
+)
+from dodal.devices.i10.rasor.rasor_scaler_cards import RasorScalerCard1
+from dodal.devices.i10.slits import I10Slits, I10SlitsDrainCurrent
+from dodal.devices.motors import XYZPositioner
+from dodal.devices.pgm import PGM
+from dodal.log import set_beamline as set_log_beamline
+from dodal.utils import BeamlinePrefix, get_beamline_name
+
+BL = get_beamline_name("i10")
+set_log_beamline(BL)
+set_utils_beamline(BL)
+PREFIX = BeamlinePrefix(BL)
+
+
+LOOK_UPTABLE_DIR = "/dls_sw/i10/software/blueapi/scratch/i10-config/lookupTables/"
+
+
+@device_factory()
+def pgm() -> PGM:
+    "I10 Plane Grating Monochromator, it can change energy via pgm.energy.set(<energy>)"
+    return PGM(
+        prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
+        grating=I10Grating,
+        gratingPv="NLINES2",
+    )
+
+
+@device_factory()
+def idd() -> I10Id:
+    """i10 downstream insertion device:
+    id.energy.set(<energy>) to change beamline energy.
+    id.energy.energy_offset.set(<off_set>) to change id energy offset relative to pgm.
+    id.pol.set(<polarisation>) to change polarisation.
+    id.laa.set(<linear polarisation angle>) to change polarisation angle, must be in LA mode.
+    """
+    return I10Id(
+        prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
+        pgm=pgm(),
+        look_up_table_dir=LOOK_UPTABLE_DIR,
+        source=("Source", "idd"),
+    )
+
+
+@device_factory()
+def idu() -> I10Id:
+    """i10 upstream insertion device:
+    id.energy.set(<energy>) to change beamline energy.
+    id.energy.energy_offset.set(<off_set>) to change id energy offset relative to pgm.
+    id.pol.set(<polarisation>) to change polarisation.
+    id.laa.set(<linear polarisation angle>) to change polarisation angle, must be in LA mode.
+    """
+    return I10Id(
+        prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-21:",
+        pgm=pgm(),
+        look_up_table_dir=LOOK_UPTABLE_DIR,
+        source=("Source", "idu"),
+    )
+
+
+"""Mirrors"""
+
+
+@device_factory()
+def first_mirror() -> PiezoMirror:
+    return PiezoMirror(prefix=f"{PREFIX.beamline_prefix}-OP-COL-01:")
+
+
+@device_factory()
+def switching_mirror() -> PiezoMirror:
+    return PiezoMirror(prefix=f"{PREFIX.beamline_prefix}-OP-SWTCH-01:")
+
+
+@device_factory()
+def focusing_mirror() -> PiezoMirror:
+    return PiezoMirror(prefix=f"{PREFIX.beamline_prefix}-OP-FOCS-01:")
+
+
+"""Optic slits"""
+
+
+@device_factory()
+def slits() -> I10Slits:
+    return I10Slits(prefix=f"{PREFIX.beamline_prefix}-AL-SLITS-")
+
+
+@device_factory()
+def slits_current() -> I10SlitsDrainCurrent:
+    return I10SlitsDrainCurrent(prefix=f"{PREFIX.beamline_prefix}-")
+
+
+"""Diagnostics"""
+
+
+@device_factory()
+def diagnostics() -> I10Diagnostic:
+    return I10Diagnostic(
+        prefix=f"{PREFIX.beamline_prefix}-DI-",
+    )
+
+
+@device_factory()
+def d5a_det() -> I10Diagnostic5ADet:
+    return I10Diagnostic5ADet(prefix=f"{PREFIX.beamline_prefix}-DI-")
+
+
+"""Rasor devices"""
+
+
+@device_factory()
+def pin_hole() -> PinHole:
+    return PinHole(prefix="ME01D-EA-PINH-01:")
+
+
+@device_factory()
+def det_slits() -> DetSlits:
+    return DetSlits(prefix="ME01D-MO-APTR-0")
+
+
+@device_factory()
+def diffractometer() -> Diffractometer:
+    return Diffractometer(prefix="ME01D-MO-DIFF-01:")
+
+
+@device_factory()
+def pa_stage() -> PaStage:
+    return PaStage(prefix="ME01D-MO-POLAN-01:")
+
+
+@device_factory()
+def sample_stage() -> XYZPositioner:
+    return XYZPositioner(prefix="ME01D-MO-CRYO-01:")
+
+
+@device_factory()
+def rasor_femto() -> RasorFemto:
+    return RasorFemto(
+        prefix="ME01D-EA-IAMP",
+    )
+
+
+@device_factory()
+def rasor_det_scalers() -> RasorScalerCard1:
+    return RasorScalerCard1(prefix="ME01D-EA-SCLR-01:SCALER1")
+
+
+@device_factory()
+def rasor_sr570() -> RasorSR570:
+    return RasorSR570(
+        prefix="ME01D-EA-IAMP",
+    )
+
+
+@device_factory()
+def rasor_sr570_pa_scaler_det() -> CurrentAmpDet:
+    return CurrentAmpDet(
+        current_amp=rasor_sr570().ca1,
+        counter=rasor_det_scalers().det,
+    )
+
+
+@device_factory()
+def rasor_femto_pa_scaler_det() -> CurrentAmpDet:
+    return CurrentAmpDet(
+        current_amp=rasor_femto().ca1,
+        counter=rasor_det_scalers().det,
+    )
+
+
+@device_factory()
+def rasor_sr570_fluo_scaler_det() -> CurrentAmpDet:
+    return CurrentAmpDet(
+        current_amp=rasor_sr570().ca2,
+        counter=rasor_det_scalers().fluo,
+    )
+
+
+@device_factory()
+def rasor_femto_fluo_scaler_det() -> CurrentAmpDet:
+    return CurrentAmpDet(
+        current_amp=rasor_femto().ca2,
+        counter=rasor_det_scalers().fluo,
+    )
+
+
+@device_factory()
+def rasor_sr570_drain_scaler_det() -> CurrentAmpDet:
+    return CurrentAmpDet(
+        current_amp=rasor_sr570().ca3,
+        counter=rasor_det_scalers().drain,
+    )
+
+
+@device_factory()
+def rasor_femto_drain_scaler_det() -> CurrentAmpDet:
+    return CurrentAmpDet(
+        current_amp=rasor_femto().ca3,
+        counter=rasor_det_scalers().drain,
+    )

dls_dodal-1.49.0/src/dodal/beamlines/k11.py

@@ -0,0 +1,35 @@
+from pathlib import Path
+
+from ophyd_async.epics.motor import Motor
+
+from dodal.common.beamlines.beamline_utils import (
+    device_factory,
+    set_path_provider,
+)
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.visit import RemoteDirectoryServiceClient, StaticVisitPathProvider
+from dodal.log import set_beamline as set_log_beamline
+from dodal.utils import BeamlinePrefix, get_beamline_name
+
+beamline = get_beamline_name("k11")
+PREFIX = BeamlinePrefix(beamline)
+set_log_beamline(beamline)
+set_utils_beamline(beamline)
+
+set_path_provider(
+    StaticVisitPathProvider(
+        beamline,
+        Path("/dls/k11/data/2025/cm40627-3"),
+        client=RemoteDirectoryServiceClient("https://k11-control:8088/api"),
+    )
+)
+
+
+@device_factory()
+def kb_x() -> Motor:
+    return Motor(f"{PREFIX.beamline_prefix}-OP-KBM-01:CS:X")
+
+
+@device_factory()
+def kb_y() -> Motor:
+    return Motor(f"{PREFIX.beamline_prefix}-OP-KBM-01:CS:Y")

{dls_dodal-1.48.0 → dls_dodal-1.49.0}/src/dodal/common/beamlines/device_helpers.py

@@ -3,6 +3,7 @@ from dodal.devices.slits import Slits
 from dodal.utils import skip_device
 
 HDF5_SUFFIX = "HDF5:"
+TIFF_SUFFIX = "TIFF:"
 CAM_SUFFIX = "CAM:"
 DET_SUFFIX = "DET:"