lima2.client 3.1a0__tar.gz → 3.1.2__tar.gz

{lima2_client-3.1a0/src/lima2_client.egg-info → lima2_client-3.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lima2-client
-Version: 3.1a0
+Version: 3.1.2
 Summary: Python client library for Lima2 detector
 Author: BCU (ESRF)
 License: Copyright (c) 2020-2024 Beamline Control Unit, ESRF
@@ -24,7 +24,7 @@ Requires-Dist: gevent
 Requires-Dist: jsonschema
 Requires-Dist: jsonschema-default
 Requires-Dist: beartype
-Requires-Dist: numpy
+Requires-Dist: numpy<2.3
 Requires-Dist: pyyaml
 Requires-Dist: typing-extensions
 Requires-Dist: h5py

{lima2_client-3.1a0 → lima2_client-3.1.2}/pyproject.toml

@@ -24,7 +24,7 @@ dependencies = [
     "jsonschema",
     "jsonschema-default",
     "beartype",
-    "numpy",
+    "numpy<2.3",          # CI runner (CentOS 7) has glibc2.17, numpy>=2.3 needs glibc2.28+
     "pyyaml",
     "typing-extensions",
     "h5py",

{lima2_client-3.1a0 → lima2_client-3.1.2}/src/lima2/client/client.py

@@ -89,6 +89,22 @@ class Client:
         {saving channel name: list of tasks}.
         """
 
+    def cleanup(self):
+        """Unregister all state loggers and tango event handlers.
+
+        This method serves only in specific cases where event handlers must for
+        some reason be unregistered. In a normal use case, a Client is
+        instantiated once per Lima2 instance, and no cleanup is necessary.
+
+        NOTE: After this call, the Client instance should no longer be used.
+        """
+        self._detector.unregister_events()
+        self._detector = None
+
+        for pipeline in self.__pipelines.values():
+            pipeline.unregister_events()
+        self.__pipelines.clear()
+
     @classmethod
     def from_yaml(
         cls,
@@ -167,6 +183,15 @@ class Client:
     ) -> None:
         """Prepare acquisition with a given uuid and set of params."""
 
+        # Check parameters required for master file generation
+        checked_params = mfg.check_generation(
+            ctrl_params=ctrl_params,
+            recv_params=acq_params,
+            proc_params=proc_params,
+            topology_kind=self.topology_kind,
+        )
+        ctrl_params, acq_params, proc_params = checked_params
+
         # Adjust params for distributed acquisition
         ctl, acq, proc = topology.distribute_acq(
             ctl_params=ctrl_params,
@@ -209,6 +234,7 @@ class Client:
             ctrl_params=ctl,
             recv_params=acq[0],
             proc_params=proc[0],
+            topology_kind=self.topology_kind,
         )
 
     @docstring_from(Detector.start_acq)
@@ -364,7 +390,7 @@ class Client:
 
             cleared = []
             for uuid in receiver.pipelines:
-                if uuid != str(current):
+                if uuid != str(current) and all(self.pipeline(UUID(uuid)).is_finished):
                     logger.debug(
                         f"Erasing pipeline {uuid} from recv {receiver.dev_name()}"
                     )

{lima2_client-3.1a0 → lima2_client-3.1.2}/src/lima2/client/detector.py

@@ -73,6 +73,7 @@ class Detector:
 
         self.__ctrl = ctrl_dev
         self.__recvs = list(recv_devs)
+        self._state_event_ids: dict[tango.DeviceProxy, int] = {}
 
         self.ping()
 
@@ -100,6 +101,17 @@ class Detector:
             d.set_green_mode(tango.GreenMode.Gevent)
             d.set_timeout_millis(timeout * 1000)
 
+    def unregister_events(self):
+        """Unregister all state loggers and tango event handlers.
+
+        This method serves only in specific cases where event handlers must for
+        some reason be unregistered. In a normal use case, a Client is
+        instantiated once per Lima2 instance, and no cleanup is necessary.
+        """
+        for device, event_id in self._state_event_ids.items():
+            device.unsubscribe_event(event_id)
+        self._state_event_ids.clear()
+
     @contextlib.contextmanager
     def _locked_fsm(self) -> Iterator[fsm.StateMachine]:
         self.__fsm_lock.acquire()
@@ -633,12 +645,14 @@ class Detector:
                     finally:
                         _logger.info(f"Current state: {fsm.state}")
 
-        for dev in self.devs:
-            dev.subscribe_event(
+        self._state_event_ids = {
+            dev: dev.subscribe_event(
                 "acq_state",
                 tango.EventType.CHANGE_EVENT,
                 on_acq_state_change,
             )
+            for dev in self.devs
+        }
 
     def _register_on_end_acq_handlers(self):
         """Register an "end of acquisition" callback on each receiver.

{lima2_client-3.1a0 → lima2_client-3.1.2}/src/lima2/client/state_machine.py

@@ -239,6 +239,9 @@ class StateMachine(fsm.StateMachine):
         if logger in self.__loggers:
             self.__loggers.remove(logger)
 
+    def clear_transition_loggers(self):
+        self.__loggers.clear()
+
     def on_state_change(self, state):
         _logger.debug(f"on_state_change {state}")
         futures = []

{lima2_client-3.1a0 → lima2_client-3.1.2}/src/lima2/master_file/generate.py

@@ -27,6 +27,7 @@ import gevent
 import gevent.event
 
 from lima2.client.pipeline import FrameType, Pipeline
+from lima2.client.topology import TopologyKind
 
 logger = logging.getLogger(__name__)
 
@@ -66,12 +67,54 @@ class MasterFileTask:
         self.task.join()
 
 
+def check_generation(
+    ctrl_params: dict,
+    recv_params: dict,
+    proc_params: dict,
+    topology_kind: TopologyKind,
+) -> list[dict]:
+    """Check the parameters to be sent to prepare to ensure master file info"""
+
+    # group all active saving subsystems
+    active_saving_params: list[dict] = []
+
+    # first check receiver raw saving or SDK saving
+    for params in [recv_params, ctrl_params]:
+        if "saving" in params and params["saving"]["enabled"]:
+            active_saving_params.append(params["saving"])
+            break
+
+    # then check the saving streams of the current pipeline
+    for source, params in proc_params.items():
+        # Skip other subsystems
+        if not source.startswith("saving"):
+            continue
+        # Skip source if channel is disabled
+        if params["enabled"]:
+            active_saving_params.append(params)
+
+    need_frame_lut = topology_kind == TopologyKind.UNEVEN
+
+    # include detector frame_idx dataset in HDF5 files
+    for saving_params in active_saving_params:
+        if need_frame_lut and "include_frame_idx" in saving_params:
+            saving_params["include_frame_idx"] = True
+
+    # allow retreiving recv-det-frame-idx mapping
+    if need_frame_lut and "frame_idx_enabled" in proc_params:
+        logger.debug("Enabling frame_idx generation")
+        proc_params["frame_idx_enabled"] = True
+
+    return ctrl_params, recv_params, proc_params
+
+
 def enable_generation(
     pipeline: Pipeline,
     num_frames: int,
     ctrl_params: dict,
     recv_params: dict,
     proc_params: dict,
+    topology_kind: TopologyKind,
     rr_offset: int = 0,
     lut_source: LUTSource = LUTSource.AUTO,
 ) -> dict[str, MasterFileTask]:
@@ -144,6 +187,11 @@ def enable_generation(
         proc_params=proc_params,
     )
 
+    need_frame_lut = topology_kind == TopologyKind.UNEVEN
+
+    # Check strict Round-Robin only when needed
+    check_strict_rr = topology_kind == TopologyKind.ROUND_ROBIN
+
     for source, frame_info, saving_params, cnt_name in active_saving_params:
         base_path = saving_params["base_path"]
         filename_prefix = saving_params["filename_prefix"]
@@ -171,10 +219,12 @@ def enable_generation(
                 this_lut_source = LUTSource.ROUND_ROBIN
         if this_lut_source is None:
             raise ValueError(f"Cannot satisfy {lut_source=}: {file_lut=}, {recv_lut=}")
+        elif this_lut_source == LUTSource.ROUND_ROBIN and need_frame_lut:
+            raise ValueError(f"Cannot use {this_lut_source} with {topology_kind}")
 
         logger.info(
             f"Master file (channel={source}) will be generated "
-            f"at {master_file_path}..."
+            f"at {master_file_path} [{this_lut_source}]..."
         )
 
         if frame_info is not None:
@@ -201,6 +251,7 @@ def enable_generation(
             end_event=end_event,
             cnt_name=cnt_name,
             config=config,
+            check_strict_rr=check_strict_rr,
         )
 
     lut_sources = [s["lut_source"] for s in generate_params.values()]
@@ -260,7 +311,7 @@ class MasterFileGeneration:
         end_event: Optional[gevent.event.Event] = None
         cnt_name: Optional[str] = None
         config: Optional[dict] = None
-        check_strict_rr: bool = True
+        check_strict_rr: bool = False
 
     def __init__(self, params: Params):
         self._p = params

{lima2_client-3.1a0 → lima2_client-3.1.2/src/lima2_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lima2-client
-Version: 3.1a0
+Version: 3.1.2
 Summary: Python client library for Lima2 detector
 Author: BCU (ESRF)
 License: Copyright (c) 2020-2024 Beamline Control Unit, ESRF
@@ -24,7 +24,7 @@ Requires-Dist: gevent
 Requires-Dist: jsonschema
 Requires-Dist: jsonschema-default
 Requires-Dist: beartype
-Requires-Dist: numpy
+Requires-Dist: numpy<2.3
 Requires-Dist: pyyaml
 Requires-Dist: typing-extensions
 Requires-Dist: h5py

{lima2_client-3.1a0 → lima2_client-3.1.2}/src/lima2_client.egg-info/requires.txt

@@ -3,7 +3,7 @@ gevent
 jsonschema
 jsonschema-default
 beartype
-numpy
+numpy<2.3
 pyyaml
 typing-extensions
 h5py