mx-bluesky 1.5.9__py3-none-any.whl → 1.5.11__py3-none-any.whl

mx_bluesky/hyperion/experiment_plans/pin_centre_then_xray_centre_plan.py

@@ -19,7 +19,7 @@ from mx_bluesky.common.experiment_plans.common_grid_detect_then_xray_centre_plan
     detect_grid_and_do_gridscan,
 )
 from mx_bluesky.common.experiment_plans.oav_snapshot_plan import (
-    setup_beamline_for_OAV,
+    setup_beamline_for_oav,
 )
 from mx_bluesky.common.external_interaction.callbacks.xray_centre.ispyb_callback import (
     ispyb_activation_wrapper,
@@ -84,7 +84,7 @@ def pin_centre_then_flyscan_plan(
     )
 
     def _pin_centre_then_flyscan_plan():
-        yield from setup_beamline_for_OAV(
+        yield from setup_beamline_for_oav(
             composite.smargon, composite.backlight, composite.aperture_scatterguard
         )
 

mx_bluesky/hyperion/experiment_plans/pin_tip_centring_plan.py

@@ -9,7 +9,7 @@ from dodal.devices.oav.oav_detector import OAV
 from dodal.devices.oav.oav_parameters import OAV_CONFIG_JSON, OAVParameters
 from dodal.devices.oav.pin_image_recognition import PinTipDetection, Tip
 from dodal.devices.oav.utils import (
-    PinNotFoundException,
+    PinNotFoundError,
     Pixel,
     get_move_required_so_that_beam_is_at_pixel,
     wait_for_tip_to_be_found,
@@ -18,7 +18,7 @@ from dodal.devices.smargon import Smargon
 
 from mx_bluesky.common.device_setup_plans.setup_oav import pre_centring_setup_oav
 from mx_bluesky.common.utils.context import device_composite_from_context
-from mx_bluesky.common.utils.exceptions import SampleException, catch_exception_and_warn
+from mx_bluesky.common.utils.exceptions import SampleError, catch_exception_and_warn
 from mx_bluesky.common.utils.log import LOGGER
 from mx_bluesky.hyperion.device_setup_plans.smargon import (
     move_smargon_warn_on_out_of_range,
@@ -69,7 +69,7 @@ def move_pin_into_view(
         max_steps (int, optional): The number of steps to search with. Defaults to 2.
 
     Raises:
-        SampleException: Error if the pin tip is never found
+        SampleError: Error if the pin tip is never found
 
     Returns:
         Tuple[int, int]: The location of the pin tip in pixels
@@ -106,7 +106,7 @@ def move_pin_into_view(
     tip_xy_px = yield from trigger_and_return_pin_tip(pin_tip_device)
 
     if not pin_tip_valid(tip_xy_px):
-        raise SampleException(
+        raise SampleError(
             "Pin tip centring failed - pin too long/short/bent and out of range"
         )
     else:
@@ -161,6 +161,6 @@ def pin_tip_centre_plan(
     # See #673 for improvements
     yield from bps.sleep(0.3)
     tip = yield from catch_exception_and_warn(
-        PinNotFoundException, wait_for_tip_to_be_found, pin_tip_detect
+        PinNotFoundError, wait_for_tip_to_be_found, pin_tip_detect
     )
     yield from offset_and_move(tip)

mx_bluesky/hyperion/experiment_plans/rotation_scan_plan.py

@@ -49,7 +49,7 @@ from mx_bluesky.common.experiment_plans.inner_plans.read_hardware import (
 from mx_bluesky.common.experiment_plans.oav_snapshot_plan import (
     OavSnapshotComposite,
     oav_snapshot_plan,
-    setup_beamline_for_OAV,
+    setup_beamline_for_oav,
 )
 from mx_bluesky.common.parameters.components import WithSnapshot
 from mx_bluesky.common.preprocessors.preprocessors import (
@@ -346,7 +346,7 @@ def _move_and_rotation(
         yield from bps.wait(CONST.WAIT.MOVE_GONIO_TO_START)
 
         if not params.use_grid_snapshots:
-            yield from setup_beamline_for_OAV(
+            yield from setup_beamline_for_oav(
                 composite.smargon,
                 composite.backlight,
                 composite.aperture_scatterguard,
@@ -428,7 +428,7 @@ def rotation_scan_internal(
 
             yield from rotation_scan_core(single_scan)
 
-        yield from bps.unstage(eiger)
+        yield from bps.unstage(eiger, wait=True)
 
     LOGGER.info("setting up and staging eiger...")
     yield from start_preparing_data_collection_then_do_plan(

mx_bluesky/hyperion/external_interaction/agamemnon.py

@@ -23,7 +23,7 @@ from mx_bluesky.common.parameters.constants import (
     GridscanParamConstants,
 )
 from mx_bluesky.common.utils.log import LOGGER
-from mx_bluesky.common.utils.utils import convert_angstrom_to_eV
+from mx_bluesky.common.utils.utils import convert_angstrom_to_ev
 from mx_bluesky.hyperion.parameters.components import Wait
 from mx_bluesky.hyperion.parameters.load_centre_collect import LoadCentreCollect
 
@@ -222,7 +222,7 @@ def _get_withenergy_parameters_from_agamemnon(parameters: dict) -> dict[str, Any
         first_collection: dict = parameters["collection"][0]
         wavelength = first_collection.get("wavelength")
         assert isinstance(wavelength, float)
-        demand_energy_ev = convert_angstrom_to_eV(wavelength)
+        demand_energy_ev = convert_angstrom_to_ev(wavelength)
         return {"demand_energy_ev": demand_energy_ev}
     except (KeyError, IndexError, AttributeError, TypeError):
         return {"demand_energy_ev": None}

mx_bluesky/hyperion/external_interaction/callbacks/__main__.py

@@ -5,7 +5,7 @@ from time import sleep  # noqa
 
 from bluesky.callbacks import CallbackBase
 from bluesky.callbacks.zmq import Proxy, RemoteDispatcher
-from dodal.log import LOGGER as dodal_logger
+from dodal.log import LOGGER as DODAL_LOGGER
 from dodal.log import set_up_all_logging_handlers
 
 from mx_bluesky.common.external_interaction.alerting import set_alerting_service
@@ -124,7 +124,7 @@ def setup_logging(dev_mode: bool):
     log_info(f"Loggers initialised with dev_mode={dev_mode}")
     nexgen_logger = logging.getLogger("nexgen")
     nexgen_logger.parent = NEXUS_LOGGER
-    dodal_logger.parent = ISPYB_ZOCALO_CALLBACK_LOGGER
+    DODAL_LOGGER.parent = ISPYB_ZOCALO_CALLBACK_LOGGER
     log_debug("nexgen logger added to nexus logger")
 
 

mx_bluesky/hyperion/external_interaction/callbacks/rotation/ispyb_callback.py

@@ -46,7 +46,7 @@ class RotationISPyBCallback(BaseISPyBCallback):
     To use, subscribe the Bluesky RunEngine to an instance of this class.
     E.g.:
         ispyb_handler_callback = RotationISPyBCallback(parameters)
-        RE.subscribe(ispyb_handler_callback)
+        run_engine.subscribe(ispyb_handler_callback)
     Or decorate a plan using bluesky.preprocessors.subs_decorator.
 
     See: https://blueskyproject.io/bluesky/callbacks.html#ways-to-invoke-callbacks

mx_bluesky/hyperion/external_interaction/callbacks/rotation/nexus_callback.py

@@ -29,7 +29,7 @@ class RotationNexusFileCallback(PlanReactiveCallback):
     To use, subscribe the Bluesky RunEngine to an instance of this class.
     E.g.:
         nexus_file_handler_callback = NexusFileCallback(parameters)
-        RE.subscribe(nexus_file_handler_callback)
+        run_engine.subscribe(nexus_file_handler_callback)
     Or decorate a plan using bluesky.preprocessors.subs_decorator.
 
     See: https://blueskyproject.io/bluesky/callbacks.html#ways-to-invoke-callbacks
@@ -65,7 +65,7 @@ class RotationNexusFileCallback(PlanReactiveCallback):
                 self.writer.beam,
                 self.writer.attenuator,
             ) = create_beam_and_attenuator_parameters(
-                data["dcm-energy_in_kev"],
+                data["dcm-energy_in_keV"],
                 data["flux-flux_reading"],
                 data["attenuator-actual_transmission"],
             )

mx_bluesky/hyperion/external_interaction/config_server.py

@@ -3,14 +3,14 @@ from functools import cache
 from mx_bluesky.common.external_interaction.config_server import MXConfigClient
 from mx_bluesky.hyperion.parameters.constants import (
     HyperionFeatureSetting,
-    HyperionFeatureSettingources,
+    HyperionFeatureSettingSources,
 )
 
 
 @cache
 def get_hyperion_config_client() -> MXConfigClient[HyperionFeatureSetting]:
     return MXConfigClient(
-        feature_sources=HyperionFeatureSettingources,
+        feature_sources=HyperionFeatureSettingSources,
         feature_dc=HyperionFeatureSetting,
         url="https://daq-config.diamond.ac.uk",
     )

mx_bluesky/hyperion/parameters/constants.py

@@ -9,7 +9,7 @@ from mx_bluesky.common.parameters.constants import (
     EnvironmentConstants,
     ExperimentParamConstants,
     FeatureSetting,
-    FeatureSettingources,
+    FeatureSettingSources,
     HardwareConstants,
     OavConstants,
     PlanGroupCheckpointConstants,
@@ -32,7 +32,7 @@ class I03Constants:
 
 
 # These currently exist in GDA domain.properties
-class HyperionFeatureSettingources(FeatureSettingources):
+class HyperionFeatureSettingSources(FeatureSettingSources):
     USE_GPU_RESULTS = "gda.mx.hyperion.xrc.use_gpu_results"
     USE_PANDA_FOR_GRIDSCAN = "gda.mx.hyperion.use_panda_for_gridscans"
     SET_STUB_OFFSETS = "gda.mx.hyperion.do_stub_offsets"

mx_bluesky/hyperion/parameters/device_composites.py

@@ -6,7 +6,7 @@ from dodal.devices.aperturescatterguard import (
 )
 from dodal.devices.attenuator.attenuator import BinaryFilterAttenuator
 from dodal.devices.backlight import Backlight
-from dodal.devices.common_dcm import BaseDCM
+from dodal.devices.common_dcm import DoubleCrystalMonochromatorWithDSpacing
 from dodal.devices.eiger import EigerDetector
 from dodal.devices.fast_grid_scan import (
     PandAFastGridScan,
@@ -37,7 +37,7 @@ class HyperionFlyScanXRayCentreComposite(FlyScanEssentialDevices):
 
     aperture_scatterguard: ApertureScatterguard
     attenuator: BinaryFilterAttenuator
-    dcm: BaseDCM
+    dcm: DoubleCrystalMonochromatorWithDSpacing
     eiger: EigerDetector
     flux: Flux
     s4_slit_gaps: S4SlitGaps

mx_bluesky/hyperion/parameters/gridscan.py

@@ -44,7 +44,7 @@ class HyperionSpecifiedThreeDGridScan(SpecifiedThreeDGridScan):
 
     # Relative to common grid scan, stub offsets are defined by config server
     @property
-    def FGS_params(self) -> ZebraGridScanParamsThreeD:
+    def fast_gridscan_params(self) -> ZebraGridScanParamsThreeD:
         return ZebraGridScanParamsThreeD(
             x_steps=self.x_steps,
             y_steps=self.y_steps,
@@ -65,10 +65,10 @@ class HyperionSpecifiedThreeDGridScan(SpecifiedThreeDGridScan):
         )
 
     @property
-    def panda_FGS_params(self) -> PandAGridScanParams:
+    def panda_fast_gridscan_params(self) -> PandAGridScanParams:
         if self.y_steps % 2 and self.z_steps > 0:
             # See https://github.com/DiamondLightSource/hyperion/issues/1118 for explanation
-            raise OddYStepsException(
+            raise OddYStepsError(
                 "The number of Y steps must be even for a PandA gridscan"
             )
         return PandAGridScanParams(
@@ -93,7 +93,7 @@ class HyperionSpecifiedThreeDGridScan(SpecifiedThreeDGridScan):
         )
 
 
-class OddYStepsException(Exception): ...
+class OddYStepsError(Exception): ...
 
 
 class PinTipCentreThenXrayCentre(GridCommonWithHyperionDetectorParams):

mx_bluesky/hyperion/parameters/rotation.py

@@ -150,14 +150,12 @@ class RotationScan(RotationExperiment, SplitScan):
         return rotation_scan
 
     @model_validator(mode="after")
-    @classmethod
-    def correct_start_vds(cls, values: Any) -> Any:
-        assert isinstance(values, RotationScan)
+    def correct_start_vds(self) -> Any:
         start_img = 0.0
-        for scan in values.rotation_scans:
+        for scan in self.rotation_scans:
             scan.nexus_vds_start_img = int(start_img)
-            start_img += scan.scan_width_deg / values.rotation_increment_deg
-        return values
+            start_img += scan.scan_width_deg / self.rotation_increment_deg
+        return self
 
     @model_validator(mode="after")
     def _check_valid_for_single_arm_multiple_sweep(self) -> Self:

mx_bluesky/hyperion/plan_runner.py

@@ -5,12 +5,12 @@ from blueapi.core import BlueskyContext
 from bluesky.utils import MsgGenerator, RequestAbort
 
 from mx_bluesky.common.parameters.constants import Status
-from mx_bluesky.common.utils.exceptions import WarningException
+from mx_bluesky.common.utils.exceptions import WarningError
 from mx_bluesky.common.utils.log import LOGGER
 from mx_bluesky.hyperion.runner import BaseRunner
 
 
-class PlanException(Exception):
+class PlanError(Exception):
     """Identifies an exception that was encountered during plan execution."""
 
     pass
@@ -32,7 +32,7 @@ class PlanRunner(BaseRunner):
         Args:
             experiment: The experiment to run
         Raises:
-            PlanException: If the plan raised an exception
+            PlanError: If the plan raised an exception
             RequestAbort: If the RunEngine aborted during execution"""
 
         self.current_status = Status.BUSY
@@ -40,7 +40,7 @@ class PlanRunner(BaseRunner):
         try:
             yield from experiment()
             self.current_status = Status.IDLE
-        except WarningException as e:
+        except WarningError as e:
             LOGGER.warning("Plan failed with warning", exc_info=e)
             self.current_status = Status.FAILED
         except RequestAbort:
@@ -50,7 +50,7 @@ class PlanRunner(BaseRunner):
         except Exception as e:
             LOGGER.error("Plan failed with exception", exc_info=e)
             self.current_status = Status.FAILED
-            raise PlanException("Exception thrown in plan execution") from e
+            raise PlanError("Exception thrown in plan execution") from e
 
     def shutdown(self):
         """Performs a prompt shutdown. Aborts the run engine and terminates the loop
@@ -61,7 +61,7 @@ class PlanRunner(BaseRunner):
                 # abort() causes the run engine to throw a RequestAbort exception
                 # inside the plan, which will propagate through the contingency wrappers.
                 # When the plan returns, the run engine will raise RunEngineInterrupted
-                self.RE.abort()
+                self.run_engine.abort()
             except Exception as e:
                 LOGGER.warning(
                     "Exception encountered when issuing abort() to RunEngine:",

mx_bluesky/hyperion/runner.py

@@ -14,7 +14,7 @@ from mx_bluesky.common.external_interaction.callbacks.common.log_uid_tag_callbac
 )
 from mx_bluesky.common.parameters.components import MxBlueskyParameters
 from mx_bluesky.common.parameters.constants import Actions, Status
-from mx_bluesky.common.utils.exceptions import WarningException
+from mx_bluesky.common.utils.exceptions import WarningError
 from mx_bluesky.common.utils.log import LOGGER
 from mx_bluesky.common.utils.tracing import TRACER
 from mx_bluesky.hyperion.experiment_plans.experiment_registry import PLAN_REGISTRY
@@ -65,15 +65,15 @@ class BaseRunner:
 
     def __init__(self, context: BlueskyContext):
         self.context: BlueskyContext = context
-        self.RE = context.run_engine
-        # These references are necessary to maintain liveness of callbacks because RE
+        self.run_engine = context.run_engine
+        # These references are necessary to maintain liveness of callbacks because run_engine
         # only keeps a weakref
         self._logging_uid_tag_callback = LogUidTaggingCallback()
         self._publisher = Publisher(f"localhost:{CONST.CALLBACK_0MQ_PROXY_PORTS[0]}")
 
-        self.RE.subscribe(self._logging_uid_tag_callback)
+        self.run_engine.subscribe(self._logging_uid_tag_callback)
         LOGGER.info("Connecting to external callback ZMQ proxy...")
-        self.RE.subscribe(self._publisher)
+        self.run_engine.subscribe(self._publisher)
 
 
 class GDARunner(BaseRunner):
@@ -145,7 +145,7 @@ class GDARunner(BaseRunner):
             # abort() causes the run engine to throw a RequestAbort exception
             # inside the plan, which will propagate through the contingency wrappers.
             # When the plan returns, the run engine will raise RunEngineInterrupted
-            self.RE.abort()
+            self.run_engine.abort()
             self.current_status = StatusAndMessage(Status.IDLE)
         except Exception as e:
             self.current_status = make_error_status_and_message(e)
@@ -171,12 +171,14 @@ class GDARunner(BaseRunner):
                     raise ValueError("No experiment provided for START")
                 try:
                     with TRACER.start_span("do_run"):
-                        self.RE(command.experiment(command.devices, command.parameters))
+                        self.run_engine(
+                            command.experiment(command.devices, command.parameters)
+                        )
 
                     self.current_status = StatusAndMessage(Status.IDLE)
 
                     self._last_run_aborted = False
-                except WarningException as exception:
+                except WarningError as exception:
                     LOGGER.warning("Warning Exception", exc_info=True)
                     self.current_status = make_error_status_and_message(exception)
                 except Exception as exception:

mx_bluesky/hyperion/utils/context.py

@@ -27,7 +27,12 @@ def clear_all_device_caches(context: BlueskyContext):
 
 
 def setup_devices(context: BlueskyContext, dev_mode: bool):
-    context.with_dodal_module(
+    _, exceptions = context.with_dodal_module(
         get_beamline_based_on_environment_variable(),
         mock=dev_mode,
     )
+    if exceptions:
+        raise ExceptionGroup(
+            f"Unable to connect to beamline devices {list(exceptions.keys())}",
+            list(exceptions.values()),
+        )

mx_bluesky/jupyter_example.ipynb

@@ -18,12 +18,12 @@
     "from bluesky import RunEngine\n",
     "from bluesky.callbacks.best_effort import BestEffortCallback\n",
     "\n",
-    "RE = RunEngine({})\n",
+    "run_engine = RunEngine({})\n",
     "\n",
     "bec = BestEffortCallback()\n",
     "\n",
     "# Send all metadata/data captured to the BestEffortCallback.\n",
-    "RE.subscribe(bec)"
+    "run_engine.subscribe(bec)"
    ]
   },
   {
@@ -46,7 +46,7 @@
     "\n",
     "dets = [det]  # just one in this case, but it could be more than one\n",
     "\n",
-    "RE(scan(dets, motor, -1, 1, 10))"
+    "run_engine(scan(dets, motor, -1, 1, 10))"
    ]
   }
  ],

{mx_bluesky-1.5.9.dist-info → mx_bluesky-1.5.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mx-bluesky
-Version: 1.5.9
+Version: 1.5.11
 Summary: Bluesky tools for MX Beamlines at DLS
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>
 License:                                  Apache License
@@ -210,6 +210,7 @@ Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
@@ -237,11 +238,11 @@ Requires-Dist: deepdiff
 Requires-Dist: matplotlib
 Requires-Dist: cachetools
 Requires-Dist: daq-config-server>=v1.0.0-rc.2
-Requires-Dist: blueapi>=0.15.0
+Requires-Dist: blueapi>=1.6.3
 Requires-Dist: ophyd>=1.10.5
-Requires-Dist: ophyd-async>=0.10.0a2
-Requires-Dist: bluesky>=1.13.1
-Requires-Dist: dls-dodal==1.62.0
+Requires-Dist: ophyd-async>=0.13.5
+Requires-Dist: bluesky>=1.14.6
+Requires-Dist: dls-dodal==1.65.0
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: build; extra == "dev"
@@ -255,7 +256,7 @@ Requires-Dist: pipdeptree; extra == "dev"
 Requires-Dist: plantweb; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pydata-sphinx-theme>=0.12; extra == "dev"
-Requires-Dist: pyright; extra == "dev"
+Requires-Dist: pyright==1.1.406; extra == "dev"
 Requires-Dist: pytest-asyncio; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pytest-random-order; extra == "dev"