bec-server 4.2.1__tar.gz → 4.3.0__tar.gz

{bec_server-4.2.1 → bec_server-4.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: bec-server
-Version: 4.2.1
+Version: 4.3.0
 Summary: BEC server
 Project-URL: Bug Tracker, https://github.com/bec-project/bec/issues
 Project-URL: Homepage, https://github.com/bec-project/bec

{bec_server-4.2.1 → bec_server-4.3.0}/bec_server/scan_server/scan_manager.py

@@ -164,6 +164,10 @@ class ScanManager:
                 "doc": scan_doc_with_modifiers(scan_cls),
                 "signature": scan_signature_with_modifiers(scan_cls),
                 "gui_visibility": gui_visibility,
+                "position_preview": getattr(scan_cls, "position_preview", None),
+                "position_preview_parameter_mapping": getattr(
+                    scan_cls, "position_preview_parameter_mapping", {}
+                ),
             }
 
     @staticmethod

{bec_server-4.2.1 → bec_server-4.3.0}/bec_server/scan_server/scans/fermat_scan.py

@@ -20,11 +20,11 @@ from typing import Annotated
 
 import numpy as np
 
+from bec_lib import position_generators
 from bec_lib.device import DeviceBase
 from bec_lib.logger import bec_logger
+from bec_lib.position_generators import Direction
 from bec_lib.scan_args import DefaultArgType, ScanArgument, Units
-from bec_server.scan_server.scans import position_generators
-from bec_server.scan_server.scans.position_generators import Direction
 from bec_server.scan_server.scans.scan_base import ScanBase, ScanType
 from bec_server.scan_server.scans.scan_modifier import scan_hook
 
@@ -59,6 +59,16 @@ class FermatSpiralScan(ScanBase):
         ],
     }
 
+    position_preview = "bec_lib.position_generators.fermat_spiral_pos"
+    position_preview_parameter_mapping = {
+        "m1_start": "start_motor1",
+        "m1_stop": "stop_motor1",
+        "m2_start": "start_motor2",
+        "m2_stop": "stop_motor2",
+        "step": "step",
+        "spiral_type": "spiral_type",
+    }
+
     def __init__(
         self,
         motor1: DeviceBase,

{bec_server-4.2.1 → bec_server-4.3.0}/bec_server/scan_server/scans/grid_scan.py

@@ -20,10 +20,10 @@ from typing import Annotated
 
 import numpy as np
 
+from bec_lib import position_generators
 from bec_lib.device import DeviceBase
 from bec_lib.logger import bec_logger
 from bec_lib.scan_args import DefaultArgType, ScanArgument
-from bec_server.scan_server.scans import position_generators
 from bec_server.scan_server.scans.scan_base import ScanBase, ScanType, bundle_args
 from bec_server.scan_server.scans.scan_modifier import scan_hook
 
@@ -69,6 +69,9 @@ class GridScan(ScanBase):
         ],
     }
 
+    position_preview = "bec_lib.position_generators.nd_grid_positions"
+    position_preview_parameter_mapping = {"axes": {"bundle": [1, 2, 3]}, "snaked": "snaked"}
+
     def __init__(
         self,
         *args,

{bec_server-4.2.1 → bec_server-4.3.0}/bec_server/scan_server/scans/hexagonal_scan.py

@@ -20,9 +20,9 @@ from typing import Annotated
 
 import numpy as np
 
+from bec_lib import position_generators
 from bec_lib.device import DeviceBase
 from bec_lib.scan_args import DefaultArgType, ScanArgument
-from bec_server.scan_server.scans import position_generators
 from bec_server.scan_server.scans.scan_base import ScanBase, ScanType
 from bec_server.scan_server.scans.scan_modifier import scan_hook
 
@@ -53,6 +53,15 @@ class HexagonalScan(ScanBase):
         ],
     }
 
+    position_preview = "bec_lib.position_generators.hex_grid_2d"
+    position_preview_parameter_mapping = {
+        "axes": [
+            ["start_motor1", "stop_motor1", "step_motor1"],
+            ["start_motor2", "stop_motor2", "step_motor2"],
+        ],
+        "snaked": "snaked",
+    }
+
     def __init__(
         self,
         motor1: DeviceBase,

{bec_server-4.2.1 → bec_server-4.3.0}/bec_server/scan_server/scans/line_scan.py

@@ -20,9 +20,9 @@ from typing import Annotated
 
 import numpy as np
 
+from bec_lib import position_generators
 from bec_lib.device import DeviceBase
 from bec_lib.scan_args import DefaultArgType, ScanArgument
-from bec_server.scan_server.scans import position_generators
 from bec_server.scan_server.scans.scan_base import ScanBase, ScanType, bundle_args
 from bec_server.scan_server.scans.scan_modifier import scan_hook
 
@@ -64,6 +64,9 @@ class LineScan(ScanBase):
         ],
     }
 
+    position_preview = "bec_lib.position_generators.line_scan_positions"
+    position_preview_parameter_mapping = {"axes": {"bundle": [1, 2]}, "steps": "steps"}
+
     def __init__(
         self,
         *args,

{bec_server-4.2.1 → bec_server-4.3.0}/bec_server/scan_server/scans/log_scan.py

@@ -20,9 +20,9 @@ from typing import Annotated
 
 import numpy as np
 
+from bec_lib import position_generators
 from bec_lib.device import DeviceBase
 from bec_lib.scan_args import DefaultArgType, ScanArgument
-from bec_server.scan_server.scans import position_generators
 from bec_server.scan_server.scans.scan_base import ScanBase, ScanType, bundle_args
 from bec_server.scan_server.scans.scan_modifier import scan_hook
 
@@ -64,6 +64,9 @@ class LogScan(ScanBase):
         ],
     }
 
+    position_preview = "bec_lib.position_generators.log_scan_positions"
+    position_preview_parameter_mapping = {"axes": {"bundle": [1, 2]}, "steps": "steps"}
+
     def __init__(
         self,
         *args,

{bec_server-4.2.1 → bec_server-4.3.0}/bec_server/scan_server/scans/multi_region_grid_scan.py

@@ -18,9 +18,9 @@ from __future__ import annotations
 
 import numpy as np
 
+from bec_lib import position_generators
 from bec_lib.device import DeviceBase
 from bec_lib.scan_args import DefaultArgType
-from bec_server.scan_server.scans import position_generators
 from bec_server.scan_server.scans.scan_base import ScanBase, ScanType
 from bec_server.scan_server.scans.scan_modifier import scan_hook
 
@@ -44,6 +44,9 @@ class MultiRegionGridScan(ScanBase):
         "Acquisition Parameters": ["exp_time", "settling_time", "burst_at_each_point"],
     }
 
+    position_preview = "bec_lib.position_generators.multi_region_grid_positions"
+    position_preview_parameter_mapping = {"regions": "regions", "snaked": "snaked"}
+
     def __init__(
         self,
         motor1: DeviceBase,

{bec_server-4.2.1 → bec_server-4.3.0}/bec_server/scan_server/scans/multi_region_line_scan.py

@@ -18,9 +18,9 @@ from __future__ import annotations
 
 import numpy as np
 
+from bec_lib import position_generators
 from bec_lib.device import DeviceBase
 from bec_lib.scan_args import DefaultArgType
-from bec_server.scan_server.scans import position_generators
 from bec_server.scan_server.scans.scan_base import ScanBase, ScanType
 from bec_server.scan_server.scans.scan_modifier import scan_hook
 
@@ -50,6 +50,9 @@ class MultiRegionLineScan(ScanBase):
         ],
     }
 
+    position_preview = "bec_lib.position_generators.multi_region_line_positions"
+    position_preview_parameter_mapping = {"regions": "regions"}
+
     def __init__(
         self,
         motor: DeviceBase,

bec_server-4.3.0/bec_server/scan_server/scans/path_optimization.py

@@ -0,0 +1,5 @@
+"""Compatibility imports; use :mod:`bec_lib.path_optimization` for new code."""
+
+from bec_lib.path_optimization import PathOptimizerMixin, PathQualityStats
+
+__all__ = ["PathOptimizerMixin", "PathQualityStats"]

bec_server-4.3.0/bec_server/scan_server/scans/position_generators.py

@@ -0,0 +1,33 @@
+"""Compatibility imports; use :mod:`bec_lib.position_generators` for new code."""
+
+from bec_lib.position_generators import (
+    Direction,
+    fermat_spiral_pos,
+    get_round_roi_scan_positions,
+    hex_grid_2d,
+    line_scan_positions,
+    log_scan_positions,
+    multi_region_grid_positions,
+    multi_region_line_positions,
+    nd_grid_positions,
+    oscillating_positions,
+    rotate_points,
+    round_scan_positions,
+    spiral_positions,
+)
+
+__all__ = [
+    "Direction",
+    "rotate_points",
+    "spiral_positions",
+    "line_scan_positions",
+    "log_scan_positions",
+    "oscillating_positions",
+    "multi_region_line_positions",
+    "multi_region_grid_positions",
+    "nd_grid_positions",
+    "fermat_spiral_pos",
+    "round_scan_positions",
+    "get_round_roi_scan_positions",
+    "hex_grid_2d",
+]

{bec_server-4.2.1 → bec_server-4.3.0}/bec_server/scan_server/scans/round_roi_scan.py

@@ -20,9 +20,9 @@ from typing import Annotated
 
 import numpy as np
 
+from bec_lib import position_generators
 from bec_lib.device import DeviceBase
 from bec_lib.scan_args import DefaultArgType, ScanArgument
-from bec_server.scan_server.scans import position_generators
 from bec_server.scan_server.scans.scan_base import ScanBase, ScanType
 from bec_server.scan_server.scans.scan_modifier import scan_hook
 
@@ -54,6 +54,18 @@ class RoundROIScan(ScanBase):
         ],
     }
 
+    position_preview = "bec_lib.position_generators.get_round_roi_scan_positions"
+    position_preview_parameter_mapping = {
+        "motor_1_start": "start_motor_1",
+        "motor_1_stop": "stop_motor_1",
+        "motor_2_start": "start_motor_2",
+        "motor_2_stop": "stop_motor_2",
+        "radial_step": "shell_spacing",
+        "points_in_first_shell": "pos_in_first_ring",
+        "center_1": "center_1",
+        "center_2": "center_2",
+    }
+
     def __init__(
         self,
         motor_1: DeviceBase,

{bec_server-4.2.1 → bec_server-4.3.0}/bec_server/scan_server/scans/round_scan.py

@@ -20,9 +20,9 @@ from typing import Annotated
 
 import numpy as np
 
+from bec_lib import position_generators
 from bec_lib.device import DeviceBase
 from bec_lib.scan_args import DefaultArgType, ScanArgument
-from bec_server.scan_server.scans import position_generators
 from bec_server.scan_server.scans.scan_base import ScanBase, ScanType
 from bec_server.scan_server.scans.scan_modifier import scan_hook
 
@@ -60,6 +60,16 @@ class RoundScan(ScanBase):
         ],
     }
 
+    position_preview = "bec_lib.position_generators.round_scan_positions"
+    position_preview_parameter_mapping = {
+        "inner_radius": "inner_radius",
+        "outer_radius": "outer_radius",
+        "number_of_rings": "number_of_rings",
+        "points_in_first_ring": "pos_in_first_ring",
+        "center_1": "center_1",
+        "center_2": "center_2",
+    }
+
     def __init__(
         self,
         motor_1: DeviceBase,

{bec_server-4.2.1 → bec_server-4.3.0}/bec_server/scan_server/scans/scan_base.py

@@ -64,6 +64,10 @@ class ScanInfo(BaseModel):
     scan_number: Annotated[int | None, Field(description="Scan number, if applicable")] = None
     dataset_number: Annotated[int | None, Field(description="Dataset number, if applicable")] = None
 
+    # Preview metadata uses the same mapping as the advertised scan definition.
+    position_preview: str | None = None
+    position_preview_parameter_mapping: dict = Field(default_factory=dict)
+
     # Scan parameters
     num_points: Annotated[int, Field(description="Number of points in the scan.")] = 0
     positions: Annotated[
@@ -168,6 +172,8 @@ class ScanBase(ABC):
     arg_bundle_size = {"bundle": len(arg_input), "min": None, "max": None}
     is_scan = True
     is_internal = False
+    position_preview: str | None = None
+    position_preview_parameter_mapping: dict = {}
 
     def __init__(
         self,
@@ -207,7 +213,12 @@ class ScanBase(ABC):
             if data is not None:
                 optional_kwargs[kwarg] = data
         self.scan_info = ScanInfo(
-            scan_name=self.scan_name, scan_id=scan_id, scan_type=self.scan_type, **optional_kwargs
+            scan_name=self.scan_name,
+            scan_id=scan_id,
+            scan_type=self.scan_type,
+            position_preview=self.position_preview,
+            position_preview_parameter_mapping=self.position_preview_parameter_mapping,
+            **optional_kwargs,
         )
         self.update_scan_info(monitored=monitored, on_request=on_request)
 

{bec_server-4.2.1 → bec_server-4.3.0}/bec_server/scan_server/scans/scan_components.py

@@ -6,9 +6,9 @@ from typing import TYPE_CHECKING, Callable, Literal
 import numpy as np
 
 from bec_lib.device import DeviceBase
+from bec_lib.path_optimization import PathOptimizerMixin
+from bec_lib.position_generators import Direction
 from bec_server.scan_server.errors import LimitError
-from bec_server.scan_server.scans.path_optimization import PathOptimizerMixin
-from bec_server.scan_server.scans.position_generators import Direction
 
 if TYPE_CHECKING:
     from bec_lib.devicemanager import DeviceContainer

{bec_server-4.2.1 → bec_server-4.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec-server"
-version = "4.2.1"
+version = "4.3.0"
 description = "BEC server"
 requires-python = ">=3.11"
 classifiers = [

bec_server-4.3.0/tests/tests_scan_server/scans/test_position_preview.py

@@ -0,0 +1,61 @@
+"""Preview metadata must reproduce the trajectory executed by each scan."""
+
+import inspect
+import json
+
+import numpy as np
+import pytest
+
+from bec_lib import position_generators
+from bec_lib.scan_preview import generate_scan_positions
+from bec_server.scan_server.scans import position_generators as legacy_generators
+
+
+@pytest.mark.parametrize(
+    "name,args,kwargs",
+    [
+        ("line_scan", ("samx", -1, 1, "samy", -2, 2), {"steps": 5}),
+        ("log_scan", ("samx", -1, 1, "samy", -2, 2), {"steps": 5}),
+        ("grid_scan", ("samx", -1, 1, 3, "samy", -2, 2, 4), {"snaked": False}),
+        ("hexagonal_scan", ("samx", -1, 1, 0.5, "samy", -2, 2, 0.5), {}),
+        ("fermat_scan", ("samx", -1, 1, "samy", -2, 2, 0.5), {"spiral_type": 1}),
+        ("round_scan", ("samx", "samy", 0, 2, 3, 4), {"center_1": 1}),
+        ("round_roi_scan", ("samx", -2, 2, "samy", -2, 2, 0.5, 4), {"center_2": 1}),
+        ("multi_region_line_scan", ("samx",), {"regions": [(-1, 0, 3), (0, 2, 4)]}),
+        ("multi_region_grid_scan", ("samx", "samy"), {"regions": [((-1, 1, 3), (-2, 2, 4))]}),
+    ],
+)
+def test_advertised_preview_matches_scan(scan_assembler, name, args, kwargs):
+    scan = scan_assembler(name, *args, relative=False, **kwargs)
+    cls = type(scan)
+    bound = inspect.signature(cls).bind(*args, relative=False, **kwargs)
+    bound.apply_defaults()
+    info = json.loads(
+        json.dumps(
+            {
+                "position_preview": cls.position_preview,
+                "position_preview_parameter_mapping": cls.position_preview_parameter_mapping,
+                "arg_bundle_size": cls.arg_bundle_size,
+            }
+        )
+    )
+    preview = generate_scan_positions(info, bound.arguments)
+    scan.prepare_scan()
+    np.testing.assert_allclose(preview, scan.positions)
+    assert scan.scan_info.position_preview == info["position_preview"]
+    assert (
+        scan.scan_info.position_preview_parameter_mapping
+        == info["position_preview_parameter_mapping"]
+    )
+
+    published_info = scan.actions._build_scan_status_info({}, {}, None)
+    assert published_info["position_preview"] == info["position_preview"]
+    assert (
+        published_info["position_preview_parameter_mapping"]
+        == info["position_preview_parameter_mapping"]
+    )
+
+
+def test_legacy_import_preserves_function_and_direction_identity():
+    assert legacy_generators.line_scan_positions is position_generators.line_scan_positions
+    assert legacy_generators.Direction is position_generators.Direction

bec_server-4.3.0/tests/tests_scan_server/test_path_optimization.py

@@ -0,0 +1,14 @@
+"""Legacy optimizer imports must preserve the shared implementation identity."""
+
+from bec_lib.path_optimization import PathOptimizerMixin, PathQualityStats
+from bec_server.scan_server.scans.path_optimization import (
+    PathOptimizerMixin as LegacyPathOptimizerMixin,
+)
+from bec_server.scan_server.scans.path_optimization import (
+    PathQualityStats as LegacyPathQualityStats,
+)
+
+
+def test_legacy_optimizer_imports_preserve_identity():
+    assert LegacyPathOptimizerMixin is PathOptimizerMixin
+    assert LegacyPathQualityStats is PathQualityStats

{bec_server-4.2.1 → bec_server-4.3.0}/tests/tests_scan_server/test_scan_server_scan_manager.py

@@ -222,3 +222,14 @@ def test_scan_manager_plugins_require_current_scan_base():
 def test_scan_manager_preserves_published_scan_base_class(scan_manager):
     assert scan_manager.available_scans
     assert {info["base_class"] for info in scan_manager.available_scans.values()} == {"ScanBaseV4"}
+
+
+def test_scan_manager_advertises_preview_metadata(scan_manager):
+    info = scan_manager.available_scans["line_scan"]
+    assert info["position_preview"] == "bec_lib.position_generators.line_scan_positions"
+    assert info["position_preview_parameter_mapping"] == {
+        "axes": {"bundle": [1, 2]},
+        "steps": "steps",
+    }
+    assert scan_manager.available_scans["time_scan"]["position_preview"] is None
+    assert scan_manager.available_scans["time_scan"]["position_preview_parameter_mapping"] == {}