lima2.client 2.0.0__tar.gz → 2.0rc2__tar.gz

{lima2_client-2.0.0/src/lima2.client.egg-info → lima2_client-2.0rc2}/PKG-INFO

@@ -1,21 +1,22 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: lima2.client
-Version: 2.0.0
+Version: 2.0rc2
 Summary: Python client library for Lima2 detector
-Home-page: https://gitlab.esrf.fr/limagroup/Lima2-client
+Home-page: https://gitlab.esrf.fr/limagroup/lima2-client
 Author: BCU (ESRF)
-License: LGPLv3
+License: MIT
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/markdown
-License-File: LICENCE
+License-File: LICENSE
 Requires-Dist: pytango
 Requires-Dist: gevent
 Requires-Dist: jsonschema
 Requires-Dist: jsonschema-default
 Requires-Dist: finite-state-machine
 Requires-Dist: beartype
+Requires-Dist: numpy
 Requires-Dist: pyyaml
 Requires-Dist: typing-extensions
 Provides-Extra: shell

{lima2_client-2.0.0 → lima2_client-2.0rc2}/setup.cfg

@@ -4,11 +4,11 @@ author = BCU (ESRF)
 description = Python client library for Lima2 detector
 long_description = file: README.md
 long_description_content_type = text/markdown
-license = LGPLv3
-url = https://gitlab.esrf.fr/limagroup/Lima2-client
+license = MIT
+url = https://gitlab.esrf.fr/limagroup/lima2-client
 classifiers = 
 	Intended Audience :: Science/Research
-	License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+	License :: OSI Approved :: MIT License
 	Programming Language :: Python :: 3
 
 [options]
@@ -19,6 +19,7 @@ install_requires =
 	jsonschema-default
 	finite-state-machine
 	beartype
+	numpy
 	pyyaml
 	typing-extensions
 
@@ -42,6 +43,10 @@ required_plugins =
 addopts = -v --forked
 pythonpath = src
 
+[coverage:run]
+omit = 
+	src/lima2/client/shell.py
+
 [egg_info]
 tag_build = 
 tag_date = 0

{lima2_client-2.0.0 → lima2_client-2.0rc2}/src/lima2/client/__init__.py

@@ -3,7 +3,7 @@
 # This file is part of the Lima2 project
 #
 # Copyright (c) 2020-2024 Beamline Control Unit, ESRF
-# Distributed under the MIT licence. See LICENSE for more info.
+# Distributed under the MIT license. See LICENSE for more info.
 
 """Lima2.Client package
 
@@ -16,6 +16,6 @@
 from lima2.client.client import Client
 from lima2.client.detector import CommError
 from lima2.client.state_machine import State
-from lima2.client.processing import Processing
+from lima2.client.pipeline import Pipeline
 
-__all__ = [Client, CommError, State, Processing]
+__all__ = ["Client", "CommError", "State", "Pipeline"]

{lima2_client-2.0.0 → lima2_client-2.0rc2}/src/lima2/client/channel.py

@@ -3,7 +3,7 @@
 # This file is part of the Lima2 project
 #
 # Copyright (c) 2020-2024 Beamline Control Unit, ESRF
-# Distributed under the MIT licence. See LICENSE for more info.
+# Distributed under the MIT license. See LICENSE for more info.
 
 import numpy as np
 from abc import ABC, abstractmethod

{lima2_client-2.0.0 → lima2_client-2.0rc2}/src/lima2/client/client.py

@@ -3,7 +3,7 @@
 # This file is part of the Lima2 project
 #
 # Copyright (c) 2020-2024 Beamline Control Unit, ESRF
-# Distributed under the MIT licence. See LICENSE for more info.
+# Distributed under the MIT license. See LICENSE for more info.
 
 """User-facing interface exposing Lima2's control and acquisition API.
 
@@ -18,18 +18,20 @@ individual receivers, for instance if one of them is stuck on a frame while the
 processing data.
 """
 
+import os
 from uuid import UUID
 
 import tango as tg
 import yaml
 from beartype import beartype
-from typing_extensions import Optional, Self
+from typing_extensions import Any, Optional
 
-from . import pipelines, state_machine
-from .aggregator import Aggregator, ProgressCounter, SingleCounter
-from .detector import Detector
-from .processing import Processing, Topology
-from .utils import docstring_from
+from lima2.client import pipelines, progress_counter, state_machine, topology
+from lima2.client.detector import Detector
+from lima2.client.pipeline import Pipeline
+from lima2.client.progress_counter import ProgressCounter, SingleCounter
+from lima2.client.topology import TopologyKind
+from lima2.client.utils import docstring_from
 
 
 @beartype
@@ -47,17 +49,18 @@ class Client:
         The topology is queried from the control device properties.
         """
 
-        self.detector = Detector(ctl_dev, *rcv_devs)
+        self._detector = Detector(ctl_dev, *rcv_devs)
 
         try:
+            # Get the topology property from control
             topology_prop = ctl_dev.get_property("receiver_topology")
             topology_name = topology_prop["receiver_topology"][0]
-            self.topology = Topology(topology_name)
+            self.topology_kind = TopologyKind(topology_name)
         except IndexError:
             # Property does not exist
             raise RuntimeError(
                 "Could not find 'receiver_topology' property in control device"
-            )
+            ) from None
         except ValueError as e:
             # Invalid topology (no matching name in Topology enum)
             raise ValueError(
@@ -65,10 +68,9 @@ class Client:
             ) from e
 
         self.recv_devs = rcv_devs
-        self.aggregator = Aggregator.from_topology(self.topology)
 
         # Cache of processing pipelines by uuid (see method `pipeline`)
-        self.__pipelines: dict[UUID, Processing] = {}
+        self.__pipelines: dict[UUID, Pipeline] = {}
 
         self.tango_db = tg.Database()
 
@@ -76,8 +78,8 @@ class Client:
     def from_yaml(
         cls,
         config_filename: str = "l2c_config.yaml",
-    ) -> Self:
-        with open(config_filename) as config_f:
+    ) -> "Client":
+        with open(os.path.abspath(config_filename)) as config_f:
             # Raises on io/parsing error
             config = yaml.safe_load(config_f)
 
@@ -89,13 +91,9 @@ class Client:
 
         return Client(ctl_dev=ctl_dev, rcv_devs=rcv_devs)
 
-    ####################################################################################
-    # Client properties
-    ####################################################################################
-
     @property
-    def nb_recvs(self):
-        return len(self.recv_devs)
+    def detector(self) -> Detector:
+        return self._detector
 
     ####################################################################################
     # Detector properties
@@ -103,17 +101,17 @@ class Client:
 
     @property
     @docstring_from(Detector.det_info)
-    def det_info(self):
+    def det_info(self) -> dict[str, Any]:
         return self.detector.det_info
 
     @property
     @docstring_from(Detector.det_status)
-    def det_status(self):
+    def det_status(self) -> dict[str, Any]:
         return self.detector.det_status
 
     @property
     @docstring_from(Detector.det_capabilities)
-    def det_capabilities(self):
+    def det_capabilities(self) -> dict[str, Any]:
         return self.detector.det_capabilities
 
     @property
@@ -123,31 +121,42 @@ class Client:
 
     @property
     @docstring_from(Detector.params_default)
-    def params_default(self) -> dict:
+    def params_default(self) -> dict[str, Any]:
         return self.detector.params_default
 
     ####################################################################################
     # Control
     ####################################################################################
 
-    @docstring_from(Detector.prepare_acq)
-    def prepare_acq(self, *args, **kwargs):
-        self.detector.prepare_acq(*args, **kwargs)
+    def prepare_acq(
+        self, uuid: UUID, ctrl_params: dict, acq_params: dict, proc_params: dict
+    ) -> None:
+        """Prepare acquisition with a given uuid and set of params."""
+
+        # Adjust params for distributed acquisition
+        ctl, acq, proc = topology.distribute_acq(
+            ctl_params=ctrl_params,
+            acq_params=acq_params,
+            proc_params=proc_params,
+            num_receivers=len(self.recv_devs),
+        )
+
+        self.detector.prepare_acq(uuid, ctl, acq, proc)
 
     @docstring_from(Detector.start_acq)
-    def start_acq(self):
+    def start_acq(self) -> None:
         self.detector.start_acq()
 
     @docstring_from(Detector.trigger)
-    def trigger(self):
+    def trigger(self) -> None:
         self.detector.trigger()
 
     @docstring_from(Detector.stop_acq)
-    def stop_acq(self):
+    def stop_acq(self) -> None:
         self.detector.stop_acq()
 
     @docstring_from(Detector.reset_acq)
-    def reset_acq(self):
+    def reset_acq(self) -> None:
         self.detector.reset_acq()
 
     ####################################################################################
@@ -168,7 +177,7 @@ class Client:
     @property
     def nb_frames_xferred(self) -> ProgressCounter:
         """Aggregated number of frames transferred"""
-        return self.aggregator(
+        return progress_counter.aggregate(
             [
                 SingleCounter(
                     name="nb_frames_xferred",
@@ -191,7 +200,7 @@ class Client:
             return []
         return [UUID(u) for u in {y for x in uuids for y in x}]
 
-    def pipeline(self, uuid: Optional[UUID] = None) -> Optional[Processing]:
+    def pipeline(self, uuid: Optional[UUID] = None) -> Pipeline:
         """Get a specific pipeline by uuid. Return the current one by default (uuid=None)"""
         if uuid is None:
             return self.current_pipeline
@@ -208,16 +217,26 @@ class Client:
             self.tango_db.get_device_info(instance).class_name for instance in instances
         ]
 
-        # Select the processing according to the Tango class (Homogeneous processing for now)
+        # Select the pipeline according to the Tango class (Homogeneous processing for now)
         pipeline_class = pipelines.get_class(tango_class_name=class_names[0])
 
+        # Note: sort list of pipeline instances by name such that pipelines are ordered
+        # by receiver index. This is necessary e.g. in a strict round-robin topology to
+        # be able to find a frame by index.
+        proc_devs = [tg.DeviceProxy(url) for url in sorted(list(instances))]
+
         # Instantiate pipeline
-        self.__pipelines[uuid] = pipeline_class(uuid, list(instances), self.topology)
+        self.__pipelines[uuid] = pipeline_class(uuid, proc_devs, self.topology_kind)
 
         return self.__pipelines[uuid]
 
     @property
-    def current_pipeline(self) -> Optional[Processing]:
+    def current_pipeline(self) -> Pipeline:
+        """Return the current pipeline as a Pipeline object.
+
+        Raises if no pipeline has been created, or if receivers disagree on the
+        current pipeline's uuid.
+        """
         uuids: list[str] = [recv.current_pipeline for recv in self.recv_devs]
 
         if all([uuid == "" for uuid in uuids]):
@@ -230,7 +249,7 @@ class Client:
 
         return self.pipeline(uuids[0])
 
-    def erase_pipeline(self, uuid: UUID):
+    def erase_pipeline(self, uuid: UUID) -> None:
         """Erase a pipeline instance"""
         self.__pipelines.pop(uuid, None)
         for recv in self.recv_devs:
@@ -247,7 +266,7 @@ class Client:
                 f"State: {self.detector.state}",
                 "Controller:",
                 f" {self.detector.ctrl}",
-                f"Receivers ({self.topology}):",
+                f"Receivers ({self.topology_kind}):",
                 *[f" - {recv}" for recv in self.detector.recvs],
                 "Progress counters:",
                 f" - {self.nb_frames_acquired}",

{lima2_client-2.0.0 → lima2_client-2.0rc2}/src/lima2/client/convert.py

@@ -3,7 +3,7 @@
 # This file is part of the Lima2 project
 #
 # Copyright (c) 2020-2024 Beamline Control Unit, ESRF
-# Distributed under the MIT licence. See LICENSE for more info.
+# Distributed under the MIT license. See LICENSE for more info.
 
 """Convertion routines.
 

{lima2_client-2.0.0 → lima2_client-2.0rc2}/src/lima2/client/detector.py

@@ -3,7 +3,7 @@
 # This file is part of the Lima2 project
 #
 # Copyright (c) 2020-2024 Beamline Control Unit, ESRF
-# Distributed under the MIT licence. See LICENSE for more info.
+# Distributed under the MIT license. See LICENSE for more info.
 
 """Low level interface to the detector.
 
@@ -23,12 +23,11 @@ from __future__ import annotations
 import json
 import logging
 import uuid
-import jsonschema
-from jsonschema_default import create_from
-
-from beartype import beartype
 
+import jsonschema
 import tango
+from beartype import beartype
+from jsonschema_default import create_from
 
 from lima2.client import state_machine as fsm
 from lima2.client.state_machine import State
@@ -69,6 +68,12 @@ class Detector:
         # Preconditions
         if not recv_devs:
             raise ValueError("Must provide at least one receiver")
+        elif len(recv_devs) > 1:
+            rank_order = [d.recv_rank for d in recv_devs]
+            if not all([r == i for i, r in enumerate(rank_order)]):
+                raise ValueError(
+                    f"Receiver MPI rank order does not match client order: {rank_order}"
+                )
 
         self.__ctrl = ctrl_dev
         self.__recvs = list(recv_devs)
@@ -81,7 +86,7 @@ class Detector:
             ) from e
 
         self.__params_schema = None
-        self.__fsm = fsm.StateMachine(self)
+        self.__fsm = fsm.StateMachine(self.__ctrl, self.__recvs)
         self.__try_sync_hard()
 
         if _logger.getEffectiveLevel() == logging.DEBUG:
@@ -120,7 +125,7 @@ class Detector:
         Group:
             Info
         """
-        return json.loads(self.__ctrl.det_info)
+        return json.loads(self.__ctrl.det_info)  # type: ignore
 
     @property
     def det_status(self) -> dict:
@@ -142,7 +147,7 @@ class Detector:
         Group:
             Status
         """
-        return json.loads(self.__ctrl.det_status)
+        return json.loads(self.__ctrl.det_status)  # type: ignore
 
     @property
     def det_capabilities(self) -> dict:
@@ -159,7 +164,7 @@ class Detector:
         Group:
             Info
         """
-        return json.loads(self.__ctrl.det_capabilities)
+        return json.loads(self.__ctrl.det_capabilities)  # type: ignore
 
     def __try_params_schema(self):
         """
@@ -416,16 +421,15 @@ class Detector:
             f"prepare_acq({uuid}, {ctrl_params}, {acq_params}, {proc_params})"
         )
 
-        # Validate ctrl_params and recv_params against schema
-        def get_acq_params_schema(name) -> str:
-            return self.params_schema[name]["acq_params"]
-
         jsonschema.validate(
-            instance=ctrl_params, schema=get_acq_params_schema(self.ctrl.name())
+            instance=ctrl_params,
+            schema=self.params_schema[self.ctrl.name()]["acq_params"],
         )
+
         for i, recv in enumerate(self.__recvs):
             jsonschema.validate(
-                instance=acq_params[i], schema=get_acq_params_schema(recv.name())
+                instance=acq_params[i],
+                schema=self.params_schema[recv.name()]["acq_params"],
             )
 
         # TODO: Validate proc_params against the schema
@@ -516,7 +520,7 @@ class Detector:
         Group:
             Status
         """
-        return self.__ctrl.nb_frames_acquired
+        return self.__ctrl.nb_frames_acquired  # type: ignore
 
     @property
     def nb_frames_xferred(self) -> list[int]:

{lima2_client-2.0.0 → lima2_client-2.0rc2}/src/lima2/client/devencoded/__init__.py

@@ -3,4 +3,4 @@
 # This file is part of the Lima2 project
 #
 # Copyright (c) 2020-2024 Beamline Control Unit, ESRF
-# Distributed under the MIT licence. See LICENSE for more info.
+# Distributed under the MIT license. See LICENSE for more info.

{lima2_client-2.0.0 → lima2_client-2.0rc2}/src/lima2/client/devencoded/dense_frame.py

@@ -3,14 +3,16 @@
 # This file is part of the Lima2 project
 #
 # Copyright (c) 2020-2024 Beamline Control Unit, ESRF
-# Distributed under the MIT licence. See LICENSE for more info.
+# Distributed under the MIT license. See LICENSE for more info.
 
 """Utility functions to decode Lima data from device server.
 """
 
+from dataclasses import dataclass
 import struct
 import numpy
 import typing
+from typing_extensions import Union
 import enum
 
 from .exception import DevEncodedFormatNotSupported
@@ -19,6 +21,8 @@ DATA_HEADER_FORMAT = "<IHHIIHHHHHHHHIIIIIIQ"
 DATA_MAGIC = struct.unpack(">I", b"DTAY")[0]
 DATA_HEADER_SIZE = struct.calcsize(DATA_HEADER_FORMAT)
 
+EncodedFrame = Union[bytes, tuple[str, bytes]]
+
 
 class IMAGE_MODES(enum.Enum):
     DARRAY_UINT8 = 0
@@ -48,12 +52,13 @@ MODE_TO_NUMPY = {
 }
 
 
-class Frame(typing.NamedTuple):
+@dataclass
+class Frame:
     """
     Provide data frame from Lima including few metadata
     """
 
-    data: numpy.array
+    data: numpy.ndarray
     """Data of the frame"""
 
     idx: typing.Optional[int]
@@ -66,7 +71,7 @@ class Frame(typing.NamedTuple):
         return self.data is None
 
 
-def decode(raw_data: bytes) -> Frame:
+def decode(raw_data: EncodedFrame) -> Frame:
     """Decode data provided by Lima device image attribute
 
     See https://lima1.readthedocs.io/en/latest/applications/tango/python/doc/#devencoded-data-array

{lima2_client-2.0.0 → lima2_client-2.0rc2}/src/lima2/client/devencoded/exception.py

@@ -3,7 +3,7 @@
 # This file is part of the Lima2 project
 #
 # Copyright (c) 2020-2024 Beamline Control Unit, ESRF
-# Distributed under the MIT licence. See LICENSE for more info.
+# Distributed under the MIT license. See LICENSE for more info.
 
 
 class DevEncodedFormatNotSupported(Exception):

{lima2_client-2.0.0 → lima2_client-2.0rc2}/src/lima2/client/devencoded/sparse_frame.py

@@ -3,32 +3,33 @@
 # This file is part of the Lima2 project
 #
 # Copyright (c) 2020-2024 Beamline Control Unit, ESRF
-# Distributed under the MIT licence. See LICENSE for more info.
+# Distributed under the MIT license. See LICENSE for more info.
 
 """Utility functions to decode Lima data from device server.
 """
 
 from __future__ import annotations
 
+from dataclasses import dataclass
 import struct
 import numpy as np
-import typing
 
 from .exception import DevEncodedFormatNotSupported
 
-from lima2.client.devencoded.dense_frame import Frame
+from lima2.client.devencoded.dense_frame import Frame, EncodedFrame
 
 DATA_HEADER_FORMAT = "<HHII"
 DATA_HEADER_SIZE = struct.calcsize(DATA_HEADER_FORMAT)
 
 
-class SparseFrame(typing.NamedTuple):
+@dataclass
+class SparseFrame:
     """
     Provide sparse data frame from Lima including few metadata
     """
 
-    index: np.array
-    intensity: np.array
+    index: np.ndarray
+    intensity: np.ndarray
 
     idx: int | None
     """Index of the frame where 0 is the first frame"""
@@ -54,7 +55,7 @@ class SparseFrame(typing.NamedTuple):
         return Frame(dense, self.idx)
 
 
-def decode(raw_data: bytes) -> SparseFrame:
+def decode(raw_data: EncodedFrame) -> SparseFrame:
     """Decode data provided by Lima2
 
     Argument:

{lima2_client-2.0.0 → lima2_client-2.0rc2}/src/lima2/client/devencoded/sparse_frame_with_background.py

@@ -3,7 +3,7 @@
 # This file is part of the Lima2 project
 #
 # Copyright (c) 2020-2024 Beamline Control Unit, ESRF
-# Distributed under the MIT licence. See LICENSE for more info.
+# Distributed under the MIT license. See LICENSE for more info.
 
 """Utility functions to decode Lima data from device server.
 """
@@ -11,6 +11,7 @@
 import struct
 import numpy as np
 import typing
+from dataclasses import dataclass
 
 from .exception import DevEncodedFormatNotSupported
 
@@ -18,15 +19,16 @@ DATA_HEADER_FORMAT = "<HHIII"
 DATA_HEADER_SIZE = struct.calcsize(DATA_HEADER_FORMAT)
 
 
-class SparseFrameWithBackground(typing.NamedTuple):
+@dataclass
+class SparseFrameWithBackground:
     """
     Provide sparse data frame from Lima including few metadata
     """
 
-    index: np.array
-    intensity: np.array
-    background_avg: np.array
-    background_std: np.array
+    index: np.ndarray
+    intensity: np.ndarray
+    background_avg: np.ndarray
+    background_std: np.ndarray
 
     idx: typing.Optional[int]
     """Index of the frame where 0 is the first frame"""

{lima2_client-2.0.0 → lima2_client-2.0rc2}/src/lima2/client/devencoded/structured_array.py

@@ -3,7 +3,7 @@
 # This file is part of the Lima2 project
 #
 # Copyright (c) 2020-2024 Beamline Control Unit, ESRF
-# Distributed under the MIT licence. See LICENSE for more info.
+# Distributed under the MIT license. See LICENSE for more info.
 
 """Utility functions to decode Lima data from device server.
 """
@@ -72,7 +72,7 @@ def decode(raw_data: bytes, dtype) -> numpy.ndarray:
             "Image header version not supported (found %s)." % version
         )
 
-    data = numpy.frombuffer(raw_data, offset=header_size, dtype=dtype)
+    data: numpy.ndarray = numpy.frombuffer(raw_data, offset=header_size, dtype=dtype)
 
     # Create a memory copy only if it is needed
     if not data.flags.writeable: