187 adding catalogs section in the pyaml configuration file new implementation

examples/SOLEIL_examples/p.yaml

@@ -14,6 +14,9 @@ controls:
 - type: tango.pyaml.controlsystem
   name: live
   tango_host: localhost:11000
+  catalog: bpm-catalog
+catalogs:
+- catalogs.yaml
 arrays: arrays.yaml
 devices:
 - devices.yaml

pyaml/accelerator.py

@@ -9,6 +9,7 @@
 from .common.element_holder import ElementHolder
 from .common.exception import PyAMLConfigException
 from .configuration import ConfigurationManager, UnsupportedConfigurationRootError
+from .configuration.catalog import Catalog
 from .configuration.factory import Factory
 from .control.controlsystem import ControlSystem
 from .lattice.simulator import Simulator
@@ -58,6 +59,7 @@ class ConfigModel(BaseModel):
     alphac: float | None = None
     harmonic_number: int | None = None
     controls: list[ControlSystem] = None
+    catalogs: list[Catalog] = None
     simulators: list[Simulator] = None
     data_folder: str
     description: str | None = None
@@ -74,6 +76,14 @@ def __init__(self, cfg: ConfigModel):
         __live = None
         self._controls: dict[str, ElementHolder] = {}
         self._simulators: dict[str, ElementHolder] = {}
+        self._catalogs: dict[str, Catalog] = {}
+
+        if cfg.catalogs is not None:
+            for catalog in cfg.catalogs:
+                name = catalog.get_name()
+                if name in self._catalogs:
+                    raise PyAMLConfigException(f"catalog {name} already defined")
+                self._catalogs[name] = catalog
 
         if cfg.controls is not None:
             for c in cfg.controls:
@@ -82,6 +92,7 @@ def __init__(self, cfg: ConfigModel):
                 else:
                     # Add as dynamic attribute
                     setattr(self, c.name(), c)
+                c.set_catalog(self._resolve_control_system_catalog(c))
                 c.fill_device(cfg.devices)
                 c._peer = self
                 self._controls[c.name()] = c
@@ -249,6 +260,14 @@ def modes(self) -> dict[str, "ElementHolder"]:
         modes.update(self._controls)
         return modes
 
+    def get_catalog(self, name: str) -> Catalog:
+        if name not in self._catalogs:
+            raise PyAMLConfigException(f"catalog {name} not defined")
+        return self._catalogs[name]
+
+    def catalogs(self) -> dict[str, Catalog]:
+        return self._catalogs
+
     def __repr__(self):
         return repr(self._cfg).replace("ConfigModel", self.__class__.__name__)
 
@@ -270,6 +289,7 @@ def from_dict(config_dict: dict, ignore_external=False) -> "Accelerator":
         if ignore_external:
             # control systems are external, so remove controls field
             config_dict.pop("controls", None)
+            config_dict.pop("catalogs", None)
         # Ensure factory is clean before building a new accelerator
         Factory.clear()
         return Factory.depth_first_build(config_dict, ignore_external)
@@ -302,3 +322,13 @@ def load(filename: str, use_fast_loader: bool = False, ignore_external=False) ->
                 "Use the factory APIs to build sub-elements directly."
             ) from ex
         return manager.build(ignore_external=ignore_external)
+
+    def _resolve_control_system_catalog(self, control_system: ControlSystem) -> Catalog | None:
+        catalog = control_system.get_catalog_config()
+        if catalog is None:
+            return None
+        if isinstance(catalog, str):
+            return self.get_catalog(catalog)
+        if isinstance(catalog, Catalog):
+            return catalog
+        raise PyAMLConfigException(f"Invalid catalog configuration for control system {control_system.name()}")

pyaml/apidoc/gen_api.py

@@ -31,6 +31,7 @@
     "pyaml.common.element",
     "pyaml.common.element_holder",
     "pyaml.common.exception",
+    "pyaml.configuration.catalog",
     "pyaml.configuration.csvcurve",
     "pyaml.configuration.csvmatrix",
     "pyaml.configuration.curve",

pyaml/bpm/bpm_model.py

@@ -1,10 +1,5 @@
 from abc import ABCMeta, abstractmethod
 
-import numpy as np
-from numpy.typing import NDArray
-
-from ..control.deviceaccess import DeviceAccess
-
 
 class BPMModel(metaclass=ABCMeta):
     """
@@ -13,7 +8,7 @@ class BPMModel(metaclass=ABCMeta):
     """
 
     @abstractmethod
-    def get_pos_devices(self) -> list[DeviceAccess | None]:
+    def get_pos_devices(self) -> list[str]:
         """
         Get device handles used for position reading
 
@@ -25,7 +20,7 @@ def get_pos_devices(self) -> list[DeviceAccess | None]:
         pass
 
     @abstractmethod
-    def get_tilt_device(self) -> DeviceAccess | None:
+    def get_tilt_device(self) -> str | None:
         """
         Get device handle used for tilt access
 
@@ -37,7 +32,7 @@ def get_tilt_device(self) -> DeviceAccess | None:
         pass
 
     @abstractmethod
-    def get_offset_devices(self) -> list[DeviceAccess | None]:
+    def get_offset_devices(self) -> list[str | None]:
         """
         Get device handles used for offset access
 
@@ -47,101 +42,3 @@ def get_offset_devices(self) -> list[DeviceAccess | None]:
             h and v offset devices
         """
         pass
-
-    def x_pos_index(self) -> int | None:
-        """
-        Returns the index of the horizontal position in
-        an array, otherwise a scalar value is expected from the
-        corresponding DeviceAccess
-
-        Returns
-        -------
-        int
-            Index in the array, None for a scalar value
-        """
-        return None
-
-    def y_pos_index(self) -> int | None:
-        """
-        Returns the index of the veritcal position in
-        an array, otherwise a scalar value is expected from the
-        corresponding DeviceAccess
-
-        Returns
-        -------
-        int
-            Index in the array, None for a scalar value
-        """
-        return None
-
-    def is_pos_indexed(self) -> bool:
-        """
-        Check if position values are indexed (array-based).
-
-        Returns
-        -------
-        bool
-            True if both x and y positions are indexed, False otherwise
-        """
-        return self.x_pos_index() is not None and self.y_pos_index() is not None
-
-    def tilt_index(self) -> int | None:
-        """
-        Returns the index of the tilt angle in
-        an array, otherwise a scalar value is expected from the
-        corresponding DeviceAccess
-
-        Returns
-        -------
-        int
-            Index in the array, None for a scalar value
-        """
-        return None
-
-    def is_tilt_indexed(self) -> bool:
-        """
-        Check if tilt value is indexed (array-based).
-
-        Returns
-        -------
-        bool
-            True if tilt is indexed, False otherwise
-        """
-        return self.tilt_index() is not None
-
-    def x_offset_index(self) -> int | None:
-        """
-        Returns the index of the horizontal offset in
-        an array, otherwise a scalar value is expected from the
-        corresponding DeviceAccess
-
-        Returns
-        -------
-        int
-            Index in the array, None for a scalar value
-        """
-        return None
-
-    def y_offset_index(self) -> int | None:
-        """
-        Returns the index of the veritcal offset in
-        an array, otherwise a scalar value is expected from the
-        corresponding DeviceAccess
-
-        Returns
-        -------
-        int
-            Index in the array, None for a scalar value
-        """
-        return None
-
-    def is_offset_indexed(self) -> bool:
-        """
-        Check if offset values are indexed (array-based).
-
-        Returns
-        -------
-        bool
-            True if both x and y offsets are indexed, False otherwise
-        """
-        return self.x_offset_index() is not None and self.y_offset_index() is not None

pyaml/bpm/bpm_simple_model.py

@@ -1,11 +1,8 @@
-import numpy as np
-from numpy.typing import NDArray
 from pydantic import BaseModel, ConfigDict
 
 from pyaml.bpm.bpm_model import BPMModel
 
 from ..common.element import __pyaml_repr__
-from ..control.deviceaccess import DeviceAccess
 
 # Define the main class name for this module
 PYAMLCLASS = "BPMSimpleModel"
@@ -17,24 +14,16 @@ class ConfigModel(BaseModel):
 
     Parameters
     ----------
-    x_pos : DeviceAccess, optional
-        Horizontal position device
-    y_pos : DeviceAccess, optional
-        Vertical position device
-    x_pos_index : int, optional
-        Index in the array when specified, otherwise scalar
-        value is expected
-    y_pos_index : int, optional
-        Index in the array when specified, otherwise scalar
-        value is expected
+    x_pos : str
+        Horizontal position catalog key
+    y_pos : str
+        Vertical position catalog key
     """
 
     model_config = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
 
-    x_pos: DeviceAccess | None
-    y_pos: DeviceAccess | None
-    x_pos_index: int | None = None
-    y_pos_index: int | None = None
+    x_pos: str
+    y_pos: str
 
 
 class BPMSimpleModel(BPMModel):
@@ -48,7 +37,7 @@ def __init__(self, cfg: ConfigModel):
         self.__x_pos = cfg.x_pos
         self.__y_pos = cfg.y_pos
 
-    def get_pos_devices(self) -> list[DeviceAccess | None]:
+    def get_pos_devices(self) -> list[str]:
         """
         Get device handles used for position reading
 
@@ -59,7 +48,7 @@ def get_pos_devices(self) -> list[DeviceAccess | None]:
         """
         return [self.__x_pos, self.__y_pos]
 
-    def get_tilt_device(self) -> DeviceAccess | None:
+    def get_tilt_device(self) -> str | None:
         """
         Get device handle used for tilt access
 
@@ -70,7 +59,7 @@ def get_tilt_device(self) -> DeviceAccess | None:
         """
         return None
 
-    def get_offset_devices(self) -> list[DeviceAccess | None]:
+    def get_offset_devices(self) -> list[str | None]:
         """
         Get device handles used for offset access
 
@@ -81,31 +70,5 @@ def get_offset_devices(self) -> list[DeviceAccess | None]:
         """
         return [None, None]
 
-    def x_pos_index(self) -> int | None:
-        """
-        Returns the index of the horizontal position in
-        an array, otherwise a scalar value is expected from the
-        corresponding DeviceAccess
-
-        Returns
-        -------
-        int
-            Index in the array, None for a scalar value
-        """
-        return self._cfg.x_pos_index
-
-    def y_pos_index(self) -> int | None:
-        """
-        Returns the index of the veritcal position in
-        an array, otherwise a scalar value is expected from the
-        corresponding DeviceAccess
-
-        Returns
-        -------
-        int
-            Index in the array, None for a scalar value
-        """
-        return self._cfg.y_pos_index
-
     def __repr__(self):
         return __pyaml_repr__(self)