mx-bluesky 1.4.6__py3-none-any.whl → 1.4.7__py3-none-any.whl

mx_bluesky/beamlines/i24/serial/setup_beamline/pv.py

@@ -258,22 +258,22 @@ step09_pmac_response = "BL24I-MO-IOC-09:ASYN9.AINP"
 step10_pmac_response = "BL24I-MO-IOC-10:ASYN10.AINP"
 step11_pmac_response = "BL24I-MO-IOC-11:ASYN11.AINP"
 step12_pmac_response = "BL24I-MO-IOC-12:ASYN12.AINP"
-# General Purpose PV
-ioc12_gp1 = "BL24I-EA-IOC-12:GP1"
-ioc12_gp2 = "BL24I-EA-IOC-12:GP2"
-ioc12_gp3 = "BL24I-EA-IOC-12:GP3"
-ioc12_gp4 = "BL24I-EA-IOC-12:GP4"
-ioc12_gp5 = "BL24I-EA-IOC-12:GP5"
-ioc12_gp6 = "BL24I-EA-IOC-12:GP6"
-ioc12_gp7 = "BL24I-EA-IOC-12:GP7"
-ioc12_gp8 = "BL24I-EA-IOC-12:GP8"
-ioc12_gp9 = "BL24I-EA-IOC-12:GP9"
-ioc12_gp10 = "BL24I-EA-IOC-12:GP10"
-ioc12_gp11 = "BL24I-EA-IOC-12:GP11"
-ioc12_gp12 = "BL24I-EA-IOC-12:GP12"
-ioc12_gp13 = "BL24I-EA-IOC-12:GP13"
-ioc12_gp14 = "BL24I-EA-IOC-12:GP14"
-ioc12_gp15 = "BL24I-EA-IOC-12:GP15"
+# General Purpose PV. Now use STEP13
+ioc13_gp1 = "BL24I-MO-IOC-13:GP1"
+ioc13_gp2 = "BL24I-MO-IOC-13:GP2"
+ioc13_gp3 = "BL24I-MO-IOC-13:GP3"
+ioc13_gp4 = "BL24I-MO-IOC-13:GP4"
+ioc13_gp5 = "BL24I-MO-IOC-13:GP5"
+ioc13_gp6 = "BL24I-MO-IOC-13:GP6"
+ioc13_gp7 = "BL24I-MO-IOC-13:GP7"
+ioc13_gp8 = "BL24I-MO-IOC-13:GP8"
+ioc13_gp9 = "BL24I-MO-IOC-13:GP9"
+ioc13_gp10 = "BL24I-MO-IOC-13:GP10"
+ioc13_gp11 = "BL24I-MO-IOC-13:GP11"
+ioc13_gp12 = "BL24I-MO-IOC-13:GP12"
+ioc13_gp13 = "BL24I-MO-IOC-13:GP13"
+ioc13_gp14 = "BL24I-MO-IOC-13:GP14"
+ioc13_gp15 = "BL24I-MO-IOC-13:GP15"
 # ME14E
 me14e_pmac_str = "ME14E-MO-CHIP-01:PMAC_STRING"
 me14e_stage_x = "ME14E-MO-CHIP-01:X"

mx_bluesky/beamlines/i24/serial/setup_beamline/setup_beamline.py

@@ -1,5 +1,4 @@
 from pathlib import Path
-from time import sleep
 
 import bluesky.plan_stubs as bps
 from dodal.beamlines import i24
@@ -149,9 +148,9 @@ def modechange(action):
         caput(pv.vgon_pinzs, 0)
         caput(pv.fluo_trans, "OUT")
         caput(pv.bs_roty, 0)
-        sleep(0.5)
+        yield from bps.sleep(0.5)
         caput(pv.bs_mp_select, "Data Collection")
-        sleep(2.3)
+        yield from bps.sleep(2.3)
         caput(pv.bl_mp_select, "In")
         SSX_LOGGER.debug("Pin Data Collection Done")
 
@@ -168,9 +167,9 @@ def modechange(action):
         caput(pv.vgon_pinyh, 0)
         caput(pv.vgon_pinzs, 0)
         caput(pv.fluo_trans, "OUT")
-        sleep(0.1)
+        yield from bps.sleep(0.1)
         caput(pv.bs_roty, 0)
-        sleep(2.6)
+        yield from bps.sleep(2.6)
         caput(pv.bl_mp_select, "In")
         caput(pv.bs_mp_select, "Data Collection")
         SSX_LOGGER.debug("RT Data Collection Done")
@@ -182,11 +181,11 @@ def modechange(action):
         caput(pv.hgon_omega, 0.0)
         caput(pv.fluo_trans, "OUT")
         caput(pv.bl_mp_select, "Out")
-        sleep(1)
+        yield from bps.sleep(1)
         caput(pv.aptr1_mp_select, "Manual Mounting")
         caput(pv.bs_mp_select, "Tray Mount")
         while float(caget(pv.ttab_x + ".RBV")) > 3:
-            sleep(1)
+            yield from bps.sleep(1)
         SSX_LOGGER.debug("Tray Hand Mount Done")
 
     # Tray Robot Load. This action needs to be reviewed and revised
@@ -199,15 +198,15 @@ def modechange(action):
         caput(pv.fluo_trans, "OUT")
         caput(pv.aptr1_mp_select, "In")
         caput(pv.bl_mp_select, "Out")
-        sleep(1)
+        yield from bps.sleep(1)
         caput(pv.bs_roty, 0)
-        sleep(1)
+        yield from bps.sleep(1)
         caput(pv.bs_mp_select, "Robot")
-        sleep(1)
+        yield from bps.sleep(1)
         caput(pv.bs_mp_select, "Data Collection Far")
-        sleep(1)
+        yield from bps.sleep(1)
         caput(pv.bs_roty, 0)
-        sleep(4)
+        yield from bps.sleep(4)
         caput(pv.bl_mp_select, "In")
         SSX_LOGGER.debug("Tray Robot Mount Done")
 
@@ -220,15 +219,15 @@ def modechange(action):
         caput(pv.aptr1_mp_select, "In")
         caput(pv.fluo_trans, "OUT")
         caput(pv.bl_mp_select, "Out")
-        sleep(1)
+        yield from bps.sleep(1)
         caput(pv.bs_roty, 0)
-        sleep(1)
+        yield from bps.sleep(1)
         caput(pv.bs_mp_select, "Robot")
-        sleep(1)
+        yield from bps.sleep(1)
         caput(pv.bs_mp_select, "Data Collection")
-        sleep(1)
+        yield from bps.sleep(1)
         caput(pv.bs_roty, 0)
-        sleep(4)
+        yield from bps.sleep(4)
         caput(pv.bl_mp_select, "In")
         SSX_LOGGER.debug("Tray Data Collection Done")
 
@@ -252,17 +251,17 @@ def modechange(action):
         caput(pv.vgon_pinzs, 0)
         while float(caget(pv.ttab_x + ".RBV")) > 1:
             SSX_LOGGER.debug(f"moving ttab_x {caget(pv.ttab_x)}")
-            sleep(0.1)
+            yield from bps.sleep(0.1)
         while caget(pv.fluo_out_limit) == "OFF":
             SSX_LOGGER.debug("waiting on fluorescence detector")
-            sleep(0.1)
+            yield from bps.sleep(0.1)
         while caget(pv.bl_mp_select) != "Out":
             SSX_LOGGER.debug("waiting on back light to move to out")
-            sleep(0.1)
+            yield from bps.sleep(0.1)
         caput(pv.bs_mp_select, "Robot")
         caput(pv.bs_roty, 0)
         while float(caget(pv.ptab_y + ".RBV")) > -89.0:
-            sleep(1)
+            yield from bps.sleep(1)
         SSX_LOGGER.debug("Switch To Tray Done")
 
     # Tray Switch to Pin
@@ -272,11 +271,11 @@ def modechange(action):
         caput(pv.hgon_trayys, 0.0)
         caput(pv.hgon_trayzs, 0.0)
         while float(caget(pv.ttab_x + ".RBV")) > 1.0:
-            sleep(1)
+            yield from bps.sleep(1)
         caput(pv.ptab_y, 0)
         while float(caget(pv.ptab_y + ".RBV")) < -1.0:
-            sleep(1)
-        modechange("Pin_data_collection")
+            yield from bps.sleep(1)
+        yield from modechange("Pin_data_collection")
         SSX_LOGGER.debug("Switch To Pin Done")
     else:
         SSX_LOGGER.debug(f"Unknown action: {action}")
@@ -323,9 +322,9 @@ def pilatus(action, args_list):
         [filepath, filename, num_imgs, exptime] = args_list
         rampath = filepath.replace("dls/i24/data", "ramdisk")
         caput(pv.pilat_filepath, rampath)
-        sleep(0.1)
+        yield from bps.sleep(0.1)
         caput(pv.pilat_filename, filename)
-        sleep(0.1)
+        yield from bps.sleep(0.1)
         acqtime = float(exptime) - 0.001
         caput(pv.pilat_acquiretime, str(acqtime))
         caput(pv.pilat_acquireperiod, str(exptime))
@@ -336,21 +335,21 @@ def pilatus(action, args_list):
         SSX_LOGGER.debug(f"Exposure time set as {exptime} s")
         SSX_LOGGER.debug(f"Acquire time set as {acqtime} s")
         SSX_LOGGER.debug("Pilatus takes time apprx 2sec")
-        sleep(2)
+        yield from bps.sleep(2)
         caput(pv.pilat_delaytime, 0.00)
         caput(pv.pilat_numimages, str(num_imgs))
         caput(pv.pilat_imagemode, "Continuous")
         caput(pv.pilat_triggermode, "Ext. Trigger")
-        sleep(0.2)
+        yield from bps.sleep(0.2)
 
     elif action == "quickshot-internaltrig":
         SSX_LOGGER.debug("quickshot-internaltrig")
         [filepath, filename, num_imgs, exptime] = args_list
         rampath = filepath.replace("dls/i24/data", "ramdisk")
         caput(pv.pilat_filepath, rampath)
-        sleep(0.1)
+        yield from bps.sleep(0.1)
         caput(pv.pilat_filename, filename)
-        sleep(0.1)
+        yield from bps.sleep(0.1)
         acqtime = float(exptime) - 0.001
         caput(pv.pilat_acquiretime, str(acqtime))
         caput(pv.pilat_acquireperiod, str(exptime))
@@ -361,12 +360,12 @@ def pilatus(action, args_list):
         SSX_LOGGER.debug(f"Exposure time set as {exptime} s")
         SSX_LOGGER.debug(f"Acquire time set as {acqtime} s")
         SSX_LOGGER.debug("Pilatus takes time apprx 2sec")
-        sleep(2)
+        yield from bps.sleep(2)
         caput(pv.pilat_delaytime, 0.00)
         caput(pv.pilat_numimages, str(num_imgs))
         caput(pv.pilat_imagemode, "Continuous")
         caput(pv.pilat_triggermode, "Internal")
-        sleep(0.2)
+        yield from bps.sleep(0.2)
 
     # Put it all back to GDA acceptable defaults
     elif action == "return to normal":
@@ -374,7 +373,7 @@ def pilatus(action, args_list):
         caput(pv.pilat_triggermode, "Ext. Trigger")
         caput(pv.pilat_numexpimage, 1)
     SSX_LOGGER.debug("***** leaving pilatus")
-    sleep(0.1)
+    yield from bps.sleep(0.1)
     return 0
 
 
@@ -388,7 +387,7 @@ def eiger(action, args_list):
     caput(pv.eiger_detdist, str(float(caget(pv.det_z)) / 1000))
     caput(pv.eiger_wavelength, caget(pv.dcm_lambda))
     caput(pv.eiger_omegaincr, 0.0)
-    sleep(0.1)
+    yield from bps.sleep(0.1)
     # Setup common to all collections ###
     caput(pv.eiger_filewriter, "No")
     caput(pv.eiger_stream, "Yes")
@@ -409,9 +408,9 @@ def eiger(action, args_list):
         [filepath, filename, num_imgs, exptime] = args_list
         filename = filename + "_" + str(caget(pv.eiger_seqID))
         caput(pv.eiger_ODfilepath, filepath)
-        sleep(0.1)
+        yield from bps.sleep(0.1)
         caput(pv.eiger_ODfilename, filename)
-        sleep(0.1)
+        yield from bps.sleep(0.1)
         acqtime = float(exptime) - 0.0000001
         caput(pv.eiger_acquiretime, str(acqtime))
         SSX_LOGGER.debug(f"Filepath was set as {filepath}")
@@ -425,7 +424,7 @@ def eiger(action, args_list):
         caput(pv.eiger_triggermode, "Internal Series")
         caput(pv.eiger_numtriggers, 1)
         caput(pv.eiger_manualtrigger, "Yes")
-        sleep(1.0)
+        yield from bps.sleep(1.0)
         # ODIN setup
         SSX_LOGGER.info("Setting up Odin")
         caput(pv.eiger_ODfilename, filename)
@@ -435,7 +434,7 @@ def eiger(action, args_list):
         eigerbdrbv = "UInt" + str(caget(pv.eiger_bitdepthrbv))
         caput(pv.eiger_ODdatatype, eigerbdrbv)
         caput(pv.eiger_ODcompress, "BSL24")
-        sleep(1.0)
+        yield from bps.sleep(1.0)
         # All done. Now get Odin to wait for data and start Eiger
         SSX_LOGGER.info("Done: Odin waiting for data")
         caput(pv.eiger_ODcapture, "Capture")
@@ -451,9 +450,9 @@ def eiger(action, args_list):
         [filepath, filename, num_imgs, exptime] = args_list
         filename = filename + "_" + str(caget(pv.eiger_seqID))
         caput(pv.eiger_ODfilepath, filepath)
-        sleep(0.1)
+        yield from bps.sleep(0.1)
         caput(pv.eiger_ODfilename, filename)
-        sleep(0.1)
+        yield from bps.sleep(0.1)
         acqtime = float(exptime) - 0.0000001
         caput(pv.eiger_acquiretime, str(acqtime))
         SSX_LOGGER.debug(f"Filepath was set as {filepath}")
@@ -467,7 +466,7 @@ def eiger(action, args_list):
         caput(pv.eiger_triggermode, "External Enable")
         caput(pv.eiger_numtriggers, str(num_imgs))
         caput(pv.eiger_manualtrigger, "Yes")
-        sleep(1.0)
+        yield from bps.sleep(1.0)
         # ODIN setup #
         SSX_LOGGER.info("Setting up Odin")
         caput(pv.eiger_ODfilename, filename)
@@ -477,7 +476,7 @@ def eiger(action, args_list):
         eigerbdrbv = "UInt" + str(caget(pv.eiger_bitdepthrbv))
         caput(pv.eiger_ODdatatype, eigerbdrbv)
         caput(pv.eiger_ODcompress, "BSL24")
-        sleep(1.0)
+        yield from bps.sleep(1.0)
         # All done. Now get Odin to wait for data and start Eiger
         SSX_LOGGER.info("Done: Odin waiting for data")
         caput(pv.eiger_ODcapture, "Capture")
@@ -492,7 +491,7 @@ def eiger(action, args_list):
         caput(pv.eiger_manualtrigger, "No")
         # caput(pv.eiger_seqID, int(caget(pv.eiger_seqID))+1)
     SSX_LOGGER.debug("***** leaving Eiger")
-    sleep(0.1)
+    yield from bps.sleep(0.1)
     return 0
 
 
@@ -510,10 +509,10 @@ def xspress3(action, args_list):
         caput(pv.xsp3_acquiretime, exp_time)
         caput(pv.xsp3_c1_mca_roi1_llm, lo)
         caput(pv.xsp3_c1_mca_roi1_hlm, hi)
-        sleep(0.2)
+        yield from bps.sleep(0.2)
         caput(pv.xsp3_c1_mca_roi1_llm, lo)
         caput(pv.xsp3_c1_mca_roi1_hlm, hi)
-        sleep(0.2)
+        yield from bps.sleep(0.2)
         caput(pv.xsp3_erase, 0)
 
     elif action == "on-the-fly":
@@ -522,10 +521,10 @@ def xspress3(action, args_list):
         caput(pv.xsp3_numimages, num_frms)
         caput(pv.xsp3_c1_mca_roi1_llm, lo)
         caput(pv.xsp3_c1_mca_roi1_hlm, hi)
-        sleep(0.2)
+        yield from bps.sleep(0.2)
         caput(pv.xsp3_c1_mca_roi1_llm, lo)
         caput(pv.xsp3_c1_mca_roi1_hlm, hi)
-        sleep(0.2)
+        yield from bps.sleep(0.2)
         caput(pv.xsp3_erase, 0)
 
     elif action == "return-to-normal":
@@ -539,6 +538,6 @@ def xspress3(action, args_list):
     else:
         SSX_LOGGER.error("Unknown action for xspress3 method:", action)
 
-    sleep(0.1)
+    yield from bps.sleep(0.1)
     SSX_LOGGER.debug("***** leaving xspress3")
     return 1

mx_bluesky/beamlines/i24/serial/setup_beamline/setup_detector.py

@@ -22,7 +22,7 @@ from mx_bluesky.beamlines.i24.serial.setup_beamline.pv_abstract import (
 
 EXPT_TYPE_DETECTOR_PVS = {
     SSXType.FIXED: pv.me14e_gp101,
-    SSXType.EXTRUDER: pv.ioc12_gp15,
+    SSXType.EXTRUDER: pv.ioc13_gp15,
 }
 
 

mx_bluesky/beamlines/i24/serial/setup_beamline/setup_zebra_plans.py

@@ -272,7 +272,7 @@ def setup_zebra_for_fastchip_plan(
     det_type: str,
     num_gates: int,
     num_exposures: int,
-    exposure_time: float,
+    exposure_time_s: float,
     start_time_offset: float = 0.0,
     group: str = "setup_zebra_for_fastchip",
     wait: bool = True,
@@ -303,7 +303,7 @@ def setup_zebra_for_fastchip_plan(
         det_type (str): Detector in use, current choices are Eiger or Pilatus.
         num_gates (int): Number of apertures to visit in a chip.
         num_exposures (int): Number of times data is collected in each aperture.
-        exposure_time (float): Exposure time for each shot.
+        exposure_time_s (float): Exposure time for each shot.
         start_time_offset (float): Delay on the start of the position compare. \
             Defaults to 0.0 (standard chip collection).
     """
@@ -341,10 +341,12 @@ def setup_zebra_for_fastchip_plan(
         )
 
     # Square wave - needs a small drop to make it work for eiger
-    pulse_width = exposure_time - 0.0001 if det_type == "eiger" else exposure_time / 2
+    pulse_width = (
+        exposure_time_s - 0.0001 if det_type == "eiger" else exposure_time_s / 2
+    )
 
     # 100us buffer needed to avoid missing some of the triggers
-    exptime_buffer = exposure_time + 0.0001
+    exptime_buffer = exposure_time_s + 0.0001
 
     # Number of gates is the number of windows collected
     yield from bps.abs_set(zebra.pc.num_gates, num_gates, group=group)
@@ -362,7 +364,7 @@ def setup_zebra_for_fastchip_plan(
 def open_fast_shutter_at_each_position_plan(
     zebra: Zebra,
     num_exposures: int,
-    exposure_time: float,
+    exposure_time_s: float,
     group: str = "fast_shutter_control",
     wait: bool = True,
 ):
@@ -384,7 +386,7 @@ def open_fast_shutter_at_each_position_plan(
     Args:
         zebra (Zebra): The zebra ophyd device.
         num_exposures (int): Number of times data is collected in each aperture.
-        exposure_time (float): Exposure time for each shot.
+        exposure_time_s (float): Exposure time for each shot.
     """
     SSX_LOGGER.info(
         "ZEBRA setup for fastchip collection with long delays between exposures."
@@ -395,7 +397,7 @@ def open_fast_shutter_at_each_position_plan(
         zebra.output.pulse_2.input, zebra.mapping.sources.PC_GATE, group=group
     )
     yield from bps.abs_set(zebra.output.pulse_2.delay, 0.0, group=group)
-    pulse2_width = num_exposures * exposure_time + SHUTTER_OPEN_TIME
+    pulse2_width = num_exposures * exposure_time_s + SHUTTER_OPEN_TIME
     yield from bps.abs_set(zebra.output.pulse_2.width, pulse2_width, group=group)
 
     # Fast shutter

mx_bluesky/beamlines/i24/serial/write_nexus.py

@@ -4,6 +4,7 @@ import pprint
 import time
 from datetime import datetime
 
+import bluesky.plan_stubs as bps
 import requests
 
 from mx_bluesky.beamlines.i24.serial.fixed_target.ft_utils import ChipType, MappingType
@@ -61,10 +62,10 @@ def call_nexgen(
     while time.time() - t0 < max_wait:
         if meta_h5.exists():
             SSX_LOGGER.info(f"Found {meta_h5} after {time.time() - t0:.1f} seconds")
-            time.sleep(5)
+            yield from bps.sleep(5)
             break
         SSX_LOGGER.debug(f"Waiting for {meta_h5}")
-        time.sleep(1)
+        yield from bps.sleep(1)
     if not meta_h5.exists():
         SSX_LOGGER.warning(f"Giving up waiting for {meta_h5} after {max_wait} seconds")
         return

mx_bluesky/common/device_setup_plans/xbpm_feedback.py

@@ -0,0 +1,45 @@
+from bluesky import plan_stubs as bps
+from dodal.devices.attenuator.attenuator import BinaryFilterAttenuator
+from dodal.devices.xbpm_feedback import Pause, XBPMFeedback
+
+from mx_bluesky.common.utils.log import LOGGER
+
+
+def unpause_xbpm_feedback_and_set_transmission_to_1(
+    xbpm_feedback: XBPMFeedback, attenuator: BinaryFilterAttenuator
+):
+    """Turns the XBPM feedback back on and sets transmission to 1 so that it keeps the
+    beam aligned whilst not collecting.
+
+    Args:
+        xbpm_feedback (XBPMFeedback): The XBPM device that is responsible for keeping
+                                      the beam in position
+        attenuator (BinaryFilterAttenuator): The attenuator used to set transmission
+    """
+    yield from bps.mv(xbpm_feedback.pause_feedback, Pause.RUN, attenuator, 1.0)  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
+
+
+def check_and_pause_feedback(
+    xbpm_feedback: XBPMFeedback,
+    attenuator: BinaryFilterAttenuator,
+    desired_transmission_fraction: float,
+):
+    """Checks that the xbpm is in position before then turning it off and setting a new
+    transmission.
+
+    Args:
+        xbpm_feedback (XBPMFeedback): The XBPM device that is responsible for keeping
+                                      the beam in position
+        attenuator (BinaryFilterAttenuator): The attenuator used to set transmission
+        desired_transmission_fraction (float): The desired transmission to set after
+                                               turning XBPM feedback off.
+
+    """
+    yield from bps.mv(attenuator, 1.0)  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
+    LOGGER.info("Waiting for XBPM feedback to be stable")
+    yield from bps.trigger(xbpm_feedback, wait=True)
+    LOGGER.info(
+        f"XPBM feedback in position, pausing and setting transmission to {desired_transmission_fraction}"
+    )
+    yield from bps.mv(xbpm_feedback.pause_feedback, Pause.PAUSE)  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
+    yield from bps.mv(attenuator, desired_transmission_fraction)  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809

mx_bluesky/common/external_interaction/callbacks/common/ispyb_callback_base.py

@@ -121,10 +121,8 @@ class BaseISPyBCallback(PlanReactiveCallback):
         ISPYB_ZOCALO_CALLBACK_LOGGER.info(
             "ISPyB handler received event from read hardware"
         )
-        assert isinstance(
-            synchrotron_mode := doc["data"]["synchrotron-synchrotron_mode"],
-            SynchrotronMode,
-        )
+        synchrotron_mode = doc["data"]["synchrotron-synchrotron_mode"]
+        assert isinstance(synchrotron_mode, SynchrotronMode)
 
         hwscan_data_collection_info = DataCollectionInfo(
             undulator_gap1=doc["data"]["undulator-current_gap"],

mx_bluesky/common/external_interaction/callbacks/common/ispyb_mapping.py

@@ -35,7 +35,7 @@ def populate_remaining_data_collection_info(
     data_collection_info.detector_id = I03_EIGER_DETECTOR
     data_collection_info.comments = comment
     data_collection_info.detector_distance = params.detector_params.detector_distance
-    data_collection_info.exp_time = params.detector_params.exposure_time
+    data_collection_info.exp_time = params.detector_params.exposure_time_s
     data_collection_info.imgdir = params.detector_params.directory
     data_collection_info.imgprefix = params.detector_params.prefix
     data_collection_info.imgsuffix = EIGER_FILE_SUFFIX

mx_bluesky/common/external_interaction/callbacks/common/zocalo_callback.py

@@ -18,10 +18,11 @@ if TYPE_CHECKING:
 
 class ZocaloCallback(CallbackBase):
     """Callback class to handle the triggering of Zocalo processing.
-    Sends zocalo a run_start signal on receiving a start document for the specified
-    sub-plan, and sends a run_end signal on receiving a stop document for the same plan.
+    Will start listening for collections when {triggering_plan} has been started.
 
-    The metadata of the sub-plan this starts on must include a zocalo_environment.
+    For every ispyb deposition that occurs inside this run the callback will send zocalo
+    a run_start signal. Once the {triggering_plan} has ended the callback will send a
+    run_end signal for all collections.
 
     Shouldn't be subscribed directly to the RunEngine, instead should be passed to the
     `emit` argument of an ISPyB callback which appends DCIDs to the relevant start doc.
@@ -30,7 +31,9 @@ class ZocaloCallback(CallbackBase):
     def _reset_state(self):
         self.run_uid: str | None = None
         self.zocalo_info: list[ZocaloStartInfo] = []
+        self._started_zocalo_collections: list[ZocaloStartInfo] = []
         self.descriptors: dict[str, EventDescriptor] = {}
+        self.start_frame = 0
 
     def __init__(self, triggering_plan: str, zocalo_environment: str):
         super().__init__()
@@ -42,26 +45,21 @@ class ZocaloCallback(CallbackBase):
         ISPYB_ZOCALO_CALLBACK_LOGGER.info("Zocalo handler received start document.")
         if self.triggering_plan and doc.get("subplan_name") == self.triggering_plan:
             self.run_uid = doc.get("uid")
-            assert isinstance(scan_points := doc.get("scan_points"), list)
+        if self.run_uid:
             if (
-                isinstance(ispyb_ids := doc.get("ispyb_dcids"), tuple)
+                isinstance(scan_points := doc.get("scan_points"), list)
+                and isinstance(ispyb_ids := doc.get("ispyb_dcids"), tuple)
                 and len(ispyb_ids) > 0
             ):
                 ISPYB_ZOCALO_CALLBACK_LOGGER.info(f"Zocalo triggering for {ispyb_ids}")
                 ids_and_shape = list(zip(ispyb_ids, scan_points, strict=False))
-                start_frame = 0
-                self.zocalo_info = []
                 for idx, id_and_shape in enumerate(ids_and_shape):
                     id, shape = id_and_shape
                     num_frames = number_of_frames_from_scan_spec(shape)
                     self.zocalo_info.append(
-                        ZocaloStartInfo(id, None, start_frame, num_frames, idx)
+                        ZocaloStartInfo(id, None, self.start_frame, num_frames, idx)
                     )
-                    start_frame += num_frames
-            else:
-                raise ISPyBDepositionNotMade(
-                    f"No ISPyB IDs received by the start of {self.triggering_plan=}"
-                )
+                    self.start_frame += num_frames
 
     def descriptor(self, doc: EventDescriptor):
         self.descriptors[doc["uid"]] = doc
@@ -73,6 +71,8 @@ class ZocaloCallback(CallbackBase):
             for start_info in self.zocalo_info:
                 start_info.filename = filename
                 self.zocalo_interactor.run_start(start_info)
+                self._started_zocalo_collections.append(start_info)
+            self.zocalo_info = []
         return doc
 
     def stop(self, doc: RunStop):
@@ -80,7 +80,10 @@ class ZocaloCallback(CallbackBase):
             ISPYB_ZOCALO_CALLBACK_LOGGER.info(
                 f"Zocalo handler received stop document, for run {doc.get('run_start')}."
             )
-            assert self.zocalo_interactor is not None
-            for info in self.zocalo_info:
+            if not self._started_zocalo_collections:
+                raise ISPyBDepositionNotMade(
+                    f"No ISPyB IDs received by the end of {self.triggering_plan=}"
+                )
+            for info in self._started_zocalo_collections:
                 self.zocalo_interactor.run_end(info.ispyb_dcid)
             self._reset_state()

mx_bluesky/{hyperion → common}/external_interaction/callbacks/sample_handling/sample_handling_callback.py

@@ -15,12 +15,15 @@ class SampleHandlingCallback(PlanReactiveCallback):
     """Intercepts exceptions from experiment plans and updates the ISPyB BLSampleStatus
     field according to the type of exception raised."""
 
-    def __init__(self):
+    def __init__(self, record_loaded_on_success=False):
         super().__init__(log=ISPYB_ZOCALO_CALLBACK_LOGGER)
         self._sample_id: int | None = None
         self._descriptor: str | None = None
         self._run_id: str | None = None
 
+        # Record 'sample loaded' if document successfully stops
+        self.record_loaded_on_success = record_loaded_on_success
+
     def activity_gated_start(self, doc: RunStart):
         if not self._sample_id and self.active:
             sample_id = doc.get("metadata", {}).get("sample_id")
@@ -30,6 +33,7 @@ class SampleHandlingCallback(PlanReactiveCallback):
 
     def activity_gated_stop(self, doc: RunStop) -> RunStop:
         if self._run_id == doc.get("run_start"):
+            expeye = ExpeyeInteraction()
             if doc["exit_status"] != "success":
                 exception_type, message = SampleException.type_and_message_from_reason(
                     doc.get("reason", "")
@@ -37,13 +41,17 @@ class SampleHandlingCallback(PlanReactiveCallback):
                 self.log.info(
                     f"Sample handling callback intercepted exception of type {exception_type}: {message}"
                 )
-                self._record_exception(exception_type)
+                self._record_exception(exception_type, expeye)
+
+            elif self.record_loaded_on_success:
+                self._record_loaded(expeye)
+
             self._sample_id = None
             self._run_id = None
+
         return doc
 
-    def _record_exception(self, exception_type: str):
-        expeye = ExpeyeInteraction()
+    def _record_exception(self, exception_type: str, expeye: ExpeyeInteraction):
         assert self._sample_id, "Unable to record exception due to no sample ID"
         sample_status = self._decode_sample_status(exception_type)
         expeye.update_sample_status(self._sample_id, sample_status)
@@ -53,3 +61,7 @@ class SampleHandlingCallback(PlanReactiveCallback):
             case SampleException.__name__ | CrystalNotFoundException.__name__:
                 return BLSampleStatus.ERROR_SAMPLE
         return BLSampleStatus.ERROR_BEAMLINE
+
+    def _record_loaded(self, expeye: ExpeyeInteraction):
+        assert self._sample_id, "Unable to record loaded state due to no sample ID"
+        expeye.update_sample_status(self._sample_id, BLSampleStatus.LOADED)