mx-bluesky 1.4.9__py3-none-any.whl → 1.5.0__py3-none-any.whl

mx_bluesky/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.4.9'
-__version_tuple__ = version_tuple = (1, 4, 9)
+__version__ = version = '1.5.0'
+__version_tuple__ = version_tuple = (1, 5, 0)

mx_bluesky/beamlines/i24/serial/__init__.py

@@ -2,7 +2,8 @@ from mx_bluesky.beamlines.i24.serial.web_gui_plans.general_plans import (
     gui_gonio_move_on_click,
     gui_move_backlight,
     gui_move_detector,
-    gui_set_parameters,
+    gui_run_chip_collection,
+    gui_set_zoom_level,
     gui_sleep,
     gui_stage_move_on_click,
 )
@@ -57,6 +58,7 @@ __all__ = [
     "gui_gonio_move_on_click",
     "gui_sleep",
     "gui_move_detector",
-    "gui_set_parameters",
+    "gui_run_chip_collection",
     "gui_move_backlight",
+    "gui_set_zoom_level",
 ]

mx_bluesky/beamlines/i24/serial/blueapi_config.yaml

@@ -8,6 +8,10 @@ env:
     broadcast_status_events: false
 api:
   port: 25565
+  cors:
+    allow_credentials: True
+    origins: 
+      - "*"
 stomp:
   enabled: true
   host: i24-control.diamond.ac.uk

mx_bluesky/beamlines/i24/serial/fixed_target/i24ssx_Chip_Collect_py3v1.py

@@ -684,6 +684,38 @@ def run_fixed_target_plan(
     # DCID instance - do not create yet
     dcid = DCID(emit_errors=False, expt_params=parameters)
 
+    yield from run_plan_in_wrapper(
+        zebra,
+        pmac,
+        aperture,
+        backlight,
+        beamstop,
+        detector_stage,
+        shutter,
+        dcm,
+        mirrors,
+        beam_center_device,
+        parameters,
+        dcid,
+        pilatus_metadata,
+    )
+
+
+def run_plan_in_wrapper(
+    zebra: Zebra,
+    pmac: PMAC,
+    aperture: Aperture,
+    backlight: DualBacklight,
+    beamstop: Beamstop,
+    detector_stage: DetectorMotion,
+    shutter: HutchShutter,
+    dcm: DCM,
+    mirrors: FocusMirrorsMode,
+    beam_center_device: DetectorBeamCenter,
+    parameters: FixedTargetParameters,
+    dcid: DCID,
+    pilatus_metadata: PilatusMetadata,
+) -> MsgGenerator:
     yield from bpp.contingency_wrapper(
         main_fixed_target_plan(
             zebra,

mx_bluesky/beamlines/i24/serial/fixed_target/i24ssx_Chip_Manager_py3v1.py

@@ -256,6 +256,7 @@ def upload_chip_map_to_geobrick(pmac: PMAC, chip_map: list[int]) -> MsgGenerator
     """
     SSX_LOGGER.info("Uploading Parameters for Oxford Chip to the GeoBrick")
     SSX_LOGGER.info(f"Chipid {ChipType.Oxford}, width {OXFORD_CHIP_WIDTH}")
+    SSX_LOGGER.warning(f"MAP TO UPLOAD: {chip_map}")
     for block in range(1, 65):
         value = 1 if block in chip_map else 0
         pvar = PVAR_TEMPLATE % block
@@ -264,7 +265,7 @@ def upload_chip_map_to_geobrick(pmac: PMAC, chip_map: list[int]) -> MsgGenerator
         yield from bps.abs_set(pmac.pmac_string, pvar_str, wait=True)
         # Wait for PMAC to be done processing PVAR string
         yield from bps.sleep(0.02)
-    SSX_LOGGER.debug("Upload parameters done.")
+    SSX_LOGGER.info("Upload parameters done.")
 
 
 @log_on_entry

mx_bluesky/beamlines/i24/serial/web_gui_plans/general_plans.py

@@ -3,19 +3,34 @@ from typing import Literal
 
 import bluesky.plan_stubs as bps
 import bluesky.preprocessors as bpp
-from blueapi.core import MsgGenerator
+from bluesky.utils import MsgGenerator
 from dodal.beamlines import i24
 from dodal.common import inject
+from dodal.devices.hutch_shutter import HutchShutter
+from dodal.devices.i24.aperture import Aperture
+from dodal.devices.i24.beam_center import DetectorBeamCenter
+from dodal.devices.i24.beamstop import Beamstop
+from dodal.devices.i24.dcm import DCM
 from dodal.devices.i24.dual_backlight import BacklightPositions, DualBacklight
+from dodal.devices.i24.focus_mirrors import FocusMirrorsMode
 from dodal.devices.i24.i24_detector_motion import DetectorMotion
+from dodal.devices.i24.pilatus_metadata import PilatusMetadata
 from dodal.devices.i24.pmac import PMAC
-from dodal.devices.oav.oav_detector import OAV
+from dodal.devices.oav.oav_detector import OAVBeamCentreFile
+from dodal.devices.zebra.zebra import Zebra
 
+from mx_bluesky.beamlines.i24.serial.dcid import DCID
 from mx_bluesky.beamlines.i24.serial.fixed_target.ft_utils import (
     ChipType,
     MappingType,
     PumpProbeSetting,
 )
+from mx_bluesky.beamlines.i24.serial.fixed_target.i24ssx_Chip_Collect_py3v1 import (
+    run_plan_in_wrapper,
+)
+from mx_bluesky.beamlines.i24.serial.fixed_target.i24ssx_Chip_Manager_py3v1 import (
+    upload_chip_map_to_geobrick,
+)
 from mx_bluesky.beamlines.i24.serial.fixed_target.i24ssx_moveonclick import (
     _move_on_mouse_click_plan,
 )
@@ -24,6 +39,7 @@ from mx_bluesky.beamlines.i24.serial.log import (
     _read_visit_directory_from_file,
 )
 from mx_bluesky.beamlines.i24.serial.parameters import (
+    DetectorName,
     FixedTargetParameters,
     get_chip_format,
 )
@@ -46,9 +62,19 @@ def gui_move_backlight(
     SSX_LOGGER.debug(f"Backlight moved to {bl_pos.value}")
 
 
+@bpp.run_decorator()
+def gui_set_zoom_level(
+    position: str, oav: OAVBeamCentreFile = inject("oav")
+) -> MsgGenerator:
+    yield from bps.abs_set(oav.zoom_controller, position, wait=True)
+    SSX_LOGGER.debug(f"Setting zoom level to {position}")
+
+
 @bpp.run_decorator()
 def gui_stage_move_on_click(
-    position_px: tuple[int, int], oav: OAV = inject("oav"), pmac: PMAC = inject("pmac")
+    position_px: tuple[int, int],
+    oav: OAVBeamCentreFile = inject("oav"),
+    pmac: PMAC = inject("pmac"),
 ) -> MsgGenerator:
     yield from _move_on_mouse_click_plan(oav, pmac, position_px)
 
@@ -88,7 +114,7 @@ def gui_move_detector(
 
 
 @bpp.run_decorator()
-def gui_set_parameters(
+def gui_run_chip_collection(
     sub_dir: str,
     chip_name: str,
     exp_time: float,
@@ -103,6 +129,18 @@ def gui_set_parameters(
     laser_dwell: float,
     laser_delay: float,
     pre_pump: float,
+    pmac: PMAC = inject("pmac"),
+    zebra: Zebra = inject("zebra"),
+    aperture: Aperture = inject("aperture"),
+    backlight: DualBacklight = inject("backlight"),
+    beamstop: Beamstop = inject("beamstop"),
+    detector_stage: DetectorMotion = inject("detector_motion"),
+    shutter: HutchShutter = inject("shutter"),
+    dcm: DCM = inject("dcm"),
+    mirrors: FocusMirrorsMode = inject("focus_mirrors"),
+    beam_center_pilatus: DetectorBeamCenter = inject("pilatus_bc"),
+    beam_center_eiger: DetectorBeamCenter = inject("eiger_bc"),
+    pilatus_metadata: PilatusMetadata = inject("pilatus_meta"),
 ) -> MsgGenerator:
     """Set the parameter model for the data collection.
 
@@ -132,7 +170,6 @@ def gui_set_parameters(
     """
     # NOTE still a work in progress, adding to it as the ui grows
     # See progression of https://github.com/DiamondLightSource/mx-daq-ui/issues/3
-    detector_stage = i24.detector_motion()
     det_type = yield from get_detector_type(detector_stage)
     _format = chip_format if ChipType[chip_type] is ChipType.Custom else None
     chip_params = get_chip_format(ChipType[chip_type], _format)
@@ -164,6 +201,38 @@ def gui_set_parameters(
         "checker_pattern": checker_pattern,
         "pre_pump_exposure_s": pre_pump,
     }
-    # TODO run the run_fixed_target plan once params are set (GUI not ready yet)
-    yield from bps.sleep(0.5)
-    return FixedTargetParameters(**params)
+
+    parameters = FixedTargetParameters(**params)
+
+    # Create collection directory
+    parameters.collection_directory.mkdir(parents=True, exist_ok=True)
+
+    if parameters.chip_map:
+        yield from upload_chip_map_to_geobrick(pmac, parameters.chip_map)
+
+    beam_center_device = (
+        beam_center_eiger
+        if parameters.detector_name is DetectorName.EIGER
+        else beam_center_pilatus
+    )
+    SSX_LOGGER.info("Beam center device ready")
+
+    # DCID instance - do not create yet
+    dcid = DCID(emit_errors=False, expt_params=parameters)  # noqa
+    SSX_LOGGER.info("DCID created")
+
+    yield from run_plan_in_wrapper(
+        zebra,
+        pmac,
+        aperture,
+        backlight,
+        beamstop,
+        detector_stage,
+        shutter,
+        dcm,
+        mirrors,
+        beam_center_device,
+        parameters,
+        dcid,
+        pilatus_metadata,
+    )

mx_bluesky/common/device_setup_plans/manipulate_sample.py

@@ -10,6 +10,7 @@ from dodal.devices.detector.detector_motion import DetectorMotion
 from dodal.devices.smargon import CombinedMove, Smargon
 
 from mx_bluesky.common.utils.log import LOGGER
+from mx_bluesky.hyperion.parameters.constants import CONST
 
 LOWER_DETECTOR_SHUTTER_AFTER_SCAN = True
 
@@ -21,6 +22,8 @@ def setup_sample_environment(
     group="setup_senv",
 ):
     """Move the aperture into required position, move out the backlight."""
+    yield from bps.abs_set(backlight, BacklightPosition.OUT, group=group)
+
     aperture_value = (
         None
         if not aperture_position_gda_name
@@ -29,7 +32,6 @@ def setup_sample_environment(
     yield from move_aperture_if_required(
         aperture_scatterguard, aperture_value, group=group
     )
-    yield from bps.abs_set(backlight, BacklightPosition.OUT, group=group)
 
 
 def move_aperture_if_required(
@@ -46,6 +48,7 @@ def move_aperture_if_required(
 
     else:
         LOGGER.info(f"Setting aperture position to {aperture_value}")
+        yield from bps.wait(CONST.WAIT.PREPARE_APERTURE)
         yield from bps.abs_set(
             aperture_scatterguard.selected_aperture,
             aperture_value,

mx_bluesky/common/device_setup_plans/utils.py

@@ -0,0 +1,49 @@
+from collections.abc import Generator
+
+from bluesky import plan_stubs as bps
+from bluesky import preprocessors as bpp
+from bluesky.utils import Msg
+from dodal.devices.detector.detector_motion import DetectorMotion, ShutterState
+from dodal.devices.eiger import EigerDetector
+from dodal.devices.mx_phase1.beamstop import Beamstop, BeamstopPositions
+
+from mx_bluesky.common.device_setup_plans.position_detector import (
+    set_detector_z_position,
+    set_shutter,
+)
+
+
+def start_preparing_data_collection_then_do_plan(
+    beamstop: Beamstop,
+    eiger: EigerDetector,
+    detector_motion: DetectorMotion,
+    detector_distance_mm: float | None,
+    plan_to_run: Generator[Msg, None, None],
+    group="ready_for_data_collection",
+) -> Generator[Msg, None, None]:
+    """Starts preparing for the next data collection and then runs the
+    given plan.
+
+     Preparation consists of:
+     * Arming the Eiger
+     * Moving the detector to the specified position
+     * Opening the detect shutter
+     If the plan fails it will disarm the eiger.
+    """
+
+    def wrapped_plan():
+        yield from bps.abs_set(eiger.do_arm, 1, group=group)  # type: ignore # Fix types in ophyd-async (https://github.com/DiamondLightSource/mx-bluesky/issues/855)
+        yield from bps.abs_set(
+            beamstop.selected_pos, BeamstopPositions.DATA_COLLECTION, group=group
+        )
+        if detector_distance_mm:
+            yield from set_detector_z_position(
+                detector_motion, detector_distance_mm, group
+            )
+        yield from set_shutter(detector_motion, ShutterState.OPEN, group)
+        yield from plan_to_run
+
+    yield from bpp.contingency_wrapper(
+        wrapped_plan(),
+        except_plan=lambda e: (yield from bps.stop(eiger)),  # type: ignore # Fix types in ophyd-async (https://github.com/DiamondLightSource/mx-bluesky/issues/855)
+    )

mx_bluesky/common/{plans → experiment_plans}/common_flyscan_xray_centre_plan.py

@@ -7,35 +7,32 @@ from functools import partial
 import bluesky.plan_stubs as bps
 import bluesky.preprocessors as bpp
 import numpy as np
-import pydantic
 from bluesky.protocols import Readable
 from bluesky.utils import MsgGenerator
-from dodal.devices.eiger import EigerDetector
 from dodal.devices.fast_grid_scan import (
     FastGridScanCommon,
 )
-from dodal.devices.smargon import Smargon
-from dodal.devices.synchrotron import Synchrotron
 from dodal.devices.zocalo import ZocaloResults
 from dodal.devices.zocalo.zocalo_results import (
     XrcResult,
     get_full_processing_results,
 )
 
+from mx_bluesky.common.experiment_plans.inner_plans.do_fgs import (
+    ZOCALO_STAGE_GROUP,
+    kickoff_and_complete_gridscan,
+)
+from mx_bluesky.common.experiment_plans.read_hardware import (
+    read_hardware_plan,
+)
 from mx_bluesky.common.parameters.constants import (
     DocDescriptorNames,
     GridscanParamConstants,
     PlanGroupCheckpointConstants,
     PlanNameConstants,
 )
+from mx_bluesky.common.parameters.device_composites import FlyScanEssentialDevices
 from mx_bluesky.common.parameters.gridscan import SpecifiedThreeDGridScan
-from mx_bluesky.common.plans.inner_plans.do_fgs import (
-    ZOCALO_STAGE_GROUP,
-    kickoff_and_complete_gridscan,
-)
-from mx_bluesky.common.plans.read_hardware import (
-    read_hardware_plan,
-)
 from mx_bluesky.common.utils.exceptions import (
     CrystalNotFoundException,
     SampleException,
@@ -45,14 +42,6 @@ from mx_bluesky.common.utils.tracing import TRACER
 from mx_bluesky.common.xrc_result import XRayCentreResult
 
 
-@pydantic.dataclasses.dataclass(config={"arbitrary_types_allowed": True})
-class FlyScanEssentialDevices:
-    eiger: EigerDetector
-    synchrotron: Synchrotron
-    zocalo: ZocaloResults
-    smargon: Smargon
-
-
 @dataclasses.dataclass
 class BeamlineSpecificFGSFeatures:
     setup_trigger_plan: Callable[..., MsgGenerator]
@@ -251,6 +240,9 @@ def run_gridscan(
         parameters.scan_indices,
         plan_during_collection=beamline_specific.read_during_collection_plan,
     )
+
+    # GDA's gridscans requires Z steps to be at 0, so make sure we leave this device
+    # in a GDA-happy state.
     yield from bps.abs_set(beamline_specific.fgs_motors.z_steps, 0, wait=False)