1076 fast cs eiger for xrc

docs/developer/hyperion/reference/common_params.puml

@@ -0,0 +1,53 @@
+package mx_bluesky.common.parameters {
+    together {
+        class WithSample{
+            int sample_id
+            int | None sample_puck
+            int | None sample_pin
+        }
+        class WithVisit{
+            str beamline
+            str visit
+            float | None detector_distance_mm
+        }
+        class WithSnapshot {
+            Path snapshot_directory
+            list[float] snapshot_omegas_deg
+            bool use_grid_snapshots
+        }
+        class WithOptionalEnergyChange {
+            float | None demand_energy_ev
+        }
+        class OptionalGonioAngleStarts {
+            list[int] omega_starts_deg
+            float | None phi_start_deg
+            float | None chi_start_deg
+            float | None kappa_start_deg
+        }
+    }
+    class MxBlueskyParameters{
+        SemanticVersion parameter_model_version
+    }
+    together {
+        class DiffractionExperiment {
+            str file_name
+            float exposure_time_s
+            str comment
+            TriggerMode trigger_mode
+            int run_number
+            ApertureValue selected_aperture
+            float transmission_frac
+            IspybExperimentType ispyb_experiment_type
+            str storage_directory
+            bool use_roi_mode
+        }
+        class DiffractionExperimentWithSample
+    }
+}
+
+MxBlueskyParameters <|-- DiffractionExperiment
+DiffractionExperiment <|-- DiffractionExperimentWithSample
+WithSample <|-- DiffractionExperimentWithSample
+WithSnapshot <|-- DiffractionExperiment
+WithOptionalEnergyChange <|-- DiffractionExperiment
+WithVisit <|-- DiffractionExperiment

docs/developer/hyperion/reference/internal_params_gridscan.puml

@@ -0,0 +1,36 @@
+'This file is auto-generated by generate_plantuml.py
+@startuml hyperion_parameter_model
+title Hyperion Internal Parameter Model (Centring and GridScans)
+set namespaceSeparator none
+
+!include common_params.puml
+
+package mx_bluesky.common.parameters {
+    together {
+        class GridDetectionParams {
+            float box_size_um
+            float grid_width_um
+        }
+        class GridScanParams {
+            list[int] omega_starts_deg
+            float x_start_um
+            list[float] y_starts_um
+            list[float] z_starts_um
+            int x_steps
+            list[int] y_steps
+            float x_step_size_um
+            list[float] y_step_sizes_um
+        }
+    }
+}
+
+package mx_bluesky.hyperion.parameters {
+    class PinTipCentreThenXrayCentre
+    class RobotLoadThenCentre
+}
+
+GridScanParams <|-- PinTipCentreThenXrayCentre
+OptionalGonioAngleStarts <|-- PinTipCentreThenXrayCentre
+DiffractionExperimentWithSample <|-- PinTipCentreThenXrayCentre
+PinTipCentreThenXrayCentre <|-- RobotLoadThenCentre
+@enduml

docs/developer/hyperion/reference/internal_params_rotation.puml

@@ -0,0 +1,27 @@
+'This file is auto-generated by generate_plantuml.py
+@startuml hyperion_parameter_model
+title Hyperion Internal Parameter Model (Rotation)
+set namespaceSeparator none
+
+!include common_params.puml
+
+package mx_bluesky.common.parameters {
+together {
+class RotationExperiment
+class SingleRotationScan
+class RotationScanPerSweep
+class RotationScan
+}
+}
+package mx_bluesky.hyperion.parameters {
+}
+
+
+DiffractionExperimentWithSample <|-- SingleRotationScan
+DiffractionExperimentWithSample <|-- RotationScan
+RotationExperiment <|-- SingleRotationScan
+RotationScanPerSweep <|-- SingleRotationScan
+DiffractionExperiment <|-- RotationExperiment
+OptionalGonioAngleStarts <|-- RotationScanPerSweep
+WithSample <|-- RotationScanPerSweep
+@enduml

docs/developer/hyperion/reference/param-hierarchy.rst

@@ -1,4 +1,10 @@
 Hyperion Parameter class hierarchy
 ==================================
 
-.. uml:: param_hierarchy.puml
+Below are outline diagrams for the internal parameter models for gridscans and rotations.
+Note that not all details are shown.
+
+.. image:: ../../../images/internal_params_gridscan.png
+
+
+.. image:: ../../../images/internal_params_rotation.png

pyproject.toml

@@ -57,7 +57,7 @@ dependencies = [
     "ophyd >= 1.10.5",
     "ophyd-async >= 0.17a4",
     "bluesky >= 1.14.6",
-    "dls-dodal @ git+https://github.com/DiamondLightSource/dodal.git@684bc381d9ea5a924ed1ab4a444e71524765602f",
+    "dls-dodal @ git+https://github.com/DiamondLightSource/dodal.git@use_fastcs_eiger_for_xrc",
 ]
 
 
@@ -272,13 +272,6 @@ CONFIG_SERVER_URL = "http://localhost:8555"
 description = "Run docs build with clean environment"
 env_dir = ".venv"
 skip_install = true
-commands_pre = [
-    [
-        "python",
-        "{toxinidir}/utility_scripts/generate_plantuml.py",
-        "docs/developer/hyperion/reference/param_hierarchy.puml",
-    ],
-]
 commands = [
     [
         "sphinx-build",

src/mx_bluesky/beamlines/i02_1/device_setup_plans/gridscan.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from bluesky.utils import MsgGenerator
+from dodal.devices.beamlines.i02_1.fast_grid_scan import ZebraGridScanParamsTwoD
+from dodal.devices.fast_grid_scan import FastGridScanCommon, set_fast_grid_scan_params
+
+from mx_bluesky.common.parameters.components import DiffractionExperiment
+from mx_bluesky.common.parameters.gridscan import GridScanParams
+
+
+def set_zebra_fgs_2d_params(
+    fast_grid_scan: FastGridScanCommon[ZebraGridScanParamsTwoD],
+    expt_params: DiffractionExperiment,
+    grid_scan_params: GridScanParams,
+) -> MsgGenerator:
+    zebra_fgs_params = _fast_gridscan_2d_params(expt_params, grid_scan_params)
+    yield from set_fast_grid_scan_params(fast_grid_scan, zebra_fgs_params)
+
+
+def _fast_gridscan_2d_params(
+    params: DiffractionExperiment, grid_scan_params: GridScanParams
+) -> ZebraGridScanParamsTwoD:
+    return ZebraGridScanParamsTwoD(
+        x_steps=grid_scan_params.x_steps,
+        y_steps=grid_scan_params.y_steps[0],
+        x_step_size_mm=grid_scan_params.x_step_size_um / 1000,
+        y_step_size_mm=grid_scan_params.y_step_sizes_um[0] / 1000,
+        x_start_mm=grid_scan_params.x_start_um / 1000,
+        y1_start_mm=grid_scan_params.y_starts_um[0] / 1000,
+        z1_start_mm=grid_scan_params.z_starts_um[0] / 1000,
+        set_stub_offsets=False,
+        transmission_fraction=0.5,
+        dwell_time_ms=params.exposure_time_s * 1000,
+    )

src/mx_bluesky/beamlines/i02_1/external_interaction/callbacks/gridscan/ispyb_callback.py

@@ -1,6 +1,6 @@
 from collections.abc import Sequence
 
-from mx_bluesky.beamlines.i02_1.composites import I02_1FgsParams
+from mx_bluesky.beamlines.i02_1.parameters import I02_1FgsParams
 from mx_bluesky.common.external_interaction.callbacks.grid.grid_detect_and_scan.ispyb_mapping import (
     construct_comment_for_gridscan,
 )
@@ -26,34 +26,40 @@ def _get_scan_infos(self, doc) -> Sequence[ScanDataInfo]:
         For VMXm, grid information is available immediately after the plan is triggered.
         """
         assert isinstance(self.params, I02_1FgsParams)
+        assert self.grid_scan_params
+        assert self.detector_params
         assert self.ispyb_ids.data_collection_ids, "No current data collection"
         assert self.data_collection_group_info, "No data collection group"
         data = doc["data"]
         scan_data_infos = []
 
-        for grid_num in range(self.params.num_grids):
-            omega = data.get("gonio-omega", self.params.omega_starts_deg[grid_num])
+        for grid_num in range(self.grid_scan_params.num_grids):
+            omega = data.get(
+                "gonio-omega", self.grid_scan_params.omega_starts_deg[grid_num]
+            )
 
             ISPYB_ZOCALO_CALLBACK_LOGGER.info(
                 f"Generating dc info for gridplane XY, omega {omega}"
             )
-            data_collection_number = self.params.detector_params.run_number
-            file_template = f"{self.params.detector_params.prefix}_{data_collection_number}_master.h5"
+            data_collection_number = self.detector_params.run_number
+            file_template = (
+                f"{self.detector_params.prefix}_{data_collection_number}_master.h5"
+            )
             # Snapshots have already been taken in GDA
 
             data_collection_info = DataCollectionInfo(
                 xtal_snapshot1=str(self.params.path_to_xtal_snapshot),
                 xtal_snapshot2=str(self.params.path_to_xtal_snapshot),
                 xtal_snapshot3=str(self.params.path_to_xtal_snapshot),
-                n_images=self.params.num_images,
+                n_images=self.grid_scan_params.num_images,
                 data_collection_number=data_collection_number,
                 file_template=file_template,
             )
             data_collection_grid_info = DataCollectionGridInfo(
-                dx_in_mm=self.params.x_step_size_um / 1000,
-                dy_in_mm=self.params.y_step_sizes_um[grid_num] / 1000,
-                steps_x=self.params.x_steps,
-                steps_y=self.params.y_steps[grid_num],
+                dx_in_mm=self.grid_scan_params.x_step_size_um / 1000,
+                dy_in_mm=self.grid_scan_params.y_step_sizes_um[grid_num] / 1000,
+                steps_x=self.grid_scan_params.x_steps,
+                steps_y=self.grid_scan_params.y_steps[grid_num],
                 microns_per_pixel_x=self.params.microns_per_pixel_x,
                 microns_per_pixel_y=self.params.microns_per_pixel_y,
                 snapshot_offset_x_pixel=self.params.upper_left_x,
@@ -68,7 +74,7 @@ def _get_scan_infos(self, doc) -> Sequence[ScanDataInfo]:
             data_collection_id = self.ispyb_ids.data_collection_ids[0]
 
             self.data_collection_group_info.comments = _make_comment(
-                self.params.x_steps, self.params.y_steps[0]
+                self.grid_scan_params.x_steps, self.grid_scan_params.y_steps[0]
             )
 
             self._populate_axis_info(data_collection_info, doc["data"])