iqm-exa-common 25.34__tar.gz → 26.1__tar.gz

{iqm_exa_common-25.34 → iqm_exa_common-26.1}/CHANGELOG.rst

@@ -2,8 +2,61 @@
 Changelog
 =========
 
+Version 26.1 (2025-02-28)
+=========================
+
+
+Bug fix
+-------
+- Fix protobuf deserialisation to not align SettingNode names
+
+Version 26.0 (2025-02-27)
+=========================
+
+
+Features
+--------
+
+Breaking changes
+****************
+
+- Remove Pydantic based ``ParameterModel``, ``SettingModel``, ``SettingNodeModel``, and ``SweepModel``,
+  and inherit ``Parameter``, ``Setting``, ``SettingNode``, and ``Sweep`` from Pydantic model directly.
+  As a result, the signature of usage has changed. :issue:`SW-798`
+    - Instead of ``copy``, ``model_copy`` (with an optional ``update`` parameter) should be used.
+    - For deserialization, for now, use :meth:`SettingNode.deserialize` (Pydantic native approach will be implemented later)
+- ``FunctionSweep`` and ``FunctionOptions`` has been deleted.
+- :class:`.SettingNode` now supports "the path notation" when inserting/getting nodes
+
+  - Example: ``settings["flux.my.new.path.foo"] = SettingNode(...)`` adds the specified node under the specified path.
+    Any missing subnodes will be added.
+
+- :class:`.SettingNode` and :class:`.Setting` now have an attribute ``path`` which will be populated by their relative
+  path within the settings tree when inserting/creating the node. The base class will also automatically align the name
+  of a node with its path, but there is an attribute ``align_name`` which can be set to ``False`` to not align
+  (used e.g. in the controllers section of the EXA settings tree).
+- Remove deprecated ``QCMClient.get_chad`` and ``QCMClient.get_qubit_design_properties``.
+
+Features
+--------
+
+- Settings can now be declared read-only by setting ``read_only = True`` when
+  initialising the setting.
+- Modified the html representation of settings tree to support read_only settings.
+- Methods :meth:`.SettingNode.get_gate_node_for_locus`, :meth:`.SettingNode.get_gate_properties_for_locus`,
+  :meth:`.SettingNode.get_default_implementation`, and :meth:`.SettingNode.get_locus_node_paths_for` added
+  for accessing EXA-specific gate/characterization nodes in the settings tree.
+- Methods :meth:`.SettingNode.add_for_path` and :meth:`.get_node_for_path` that facilitate dealing with long paths
+  in setting trees.
+  in setting trees.
+- ``Sweep.options`` is deprecated, use ``Sweep.data`` instead. ``data`` can be still generated using different
+  sweep options.
+- ``ExponentialSweep``, ``FixedSweep``, and ``LinearSweep`` are deprecated, use ``Sweep`` instead.
+- Split ``DataType.NUMBER`` to ``DataType.FLOAT`` and ``DataType.INT``. ``DataType.NUMBER`` is now handled as a
+  deprecated alias for ``DataType.FLOAT``.
+
 Version 25.34 (2025-02-06)
---------------------------
+==========================
 
 Bug fixes
 ---------
@@ -11,7 +64,7 @@ Bug fixes
 - Bump mechanize test dependency.
 
 Version 25.33 (2025-02-04)
---------------------------
+==========================
 
 Features
 --------
@@ -20,7 +73,7 @@ Features
 
 
 Version 25.32 (2025-02-04)
---------------------------
+==========================
 
 Features
 --------
@@ -29,14 +82,14 @@ Features
 
 
 Version 25.31 (2025-01-28)
---------------------------
+==========================
 
 Features
 ********
 - Support broader range of `numpy` versions and verify compatibily with ruff, see migration guide `https://numpy.org/doc/stable/numpy_2_0_migration_guide.html`.
 
 Version 25.30 (2025-01-28)
---------------------------
+==========================
 
 Bug Fixes
 ---------
@@ -45,7 +98,7 @@ Bug Fixes
   computational resonators.
 
 Version 25.29 (2025-01-27)
---------------------------
+==========================
 
 Features
 --------
@@ -53,7 +106,7 @@ Features
 - Bump version for an updated repo organization. No functional changes. :issue:`SW-1042`
 
 Version 25.28 (2025-01-08)
---------------------------
+==========================
 
 Features
 --------
@@ -61,14 +114,14 @@ Features
 - Remove gitlab links from public pages. :issue:`SW-776`
 
 Version 25.27 (2024-12-19)
---------------------------
+==========================
 
 Features
 ********
 - Bumps xarray
 
 Version 25.26 (2024-12-12)
---------------------------
+==========================
 
 Features
 --------
@@ -76,7 +129,7 @@ Features
 - Bump exa-experiments
 
 Version 25.25 (2024-12-11)
---------------------------
+==========================
 
 Features
 --------
@@ -84,7 +137,7 @@ Features
 - Fix public PyPI publishing. :issue:`SW-776`
 
 Version 25.24 (2024-12-11)
---------------------------
+==========================
 
 Features
 --------
@@ -92,7 +145,7 @@ Features
 - Change license info to Apache 2.0. :issue:`SW-776`
 
 Version 25.23 (2024-12-09)
---------------------------
+==========================
 
 Features
 --------
@@ -100,7 +153,7 @@ Features
 Fix extlinks to MRs and issues in sphinx docs config :issue:`SW-916`
 
 Version 25.22 (2024-12-05)
---------------------------
+==========================
 
 Features
 --------
@@ -108,14 +161,14 @@ Features
 - Fix intersphinx reference paths in docs :issue:`SW-916`
 
 Version 25.21 (2024-12-04)
---------------------------
+==========================
 
 Test
 ****
 - Adds unit test for sorting couplers
 
 Version 25.20 (2024-12-04)
---------------------------
+==========================
 
 Features
 --------
@@ -123,7 +176,7 @@ Features
 - Bump version for an updated repo organization. No functional changes. :issue:`SW-665`
 
 Version 25.19 (2024-11-29)
---------------------------
+==========================
 
 Features
 --------
@@ -132,7 +185,7 @@ Features
   gates, required for :issue:`GBC-589`.
 
 Version 25.18 (2024-11-27)
---------------------------
+==========================
 
 Features
 --------
@@ -140,7 +193,7 @@ Features
 - Expand allowed CHEDDAR versions in `qcm_data_client` to include versions 2.x.
 
 Version 25.17 (2024-11-19)
---------------------------
+==========================
 
 Features
 --------
@@ -148,7 +201,7 @@ Features
 - Bump version for an updated repo organization. No functional changes. :issue:`SW-774`
 
 Version 25.16 (2024-11-15)
---------------------------
+==========================
 
 Bug fixes
 ---------
@@ -156,7 +209,7 @@ Bug fixes
 - Remove iqm-internal web links in customer docs artifacts.
 
 Version 25.15 (2024-11-08)
---------------------------
+==========================
 
 Features
 --------
@@ -164,43 +217,43 @@ Features
 - New changelog workflow, no functional changes. :issue:`SW-774`
 
 Version 25.14 (2024-10-30)
---------------------------
+==========================
 
 - Bump Pydantic to version 2.9.2, :issue:`SW-804`.
 
 
 Version 25.13 (2024-10-28)
---------------------------
+==========================
 
 - Bump NumPy to version 1.25.2.
 
 
 Version 25.12 (2024-10-24)
---------------------------
+==========================
 
 - Add sweep validation to :func:`convert_sweeps_to_list_of_tuples` function.
 
 
 Version 25.11 (2024-10-11)
---------------------------
+==========================
 
 - Add :func:`get_all_common_resonators`
 
 
 Version 25.10 (2024-10-02)
---------------------------
+==========================
 
 - Bump `iqm-data-definitions` to 2.0.
 
 
 Version 25.9 (2024-09-23)
--------------------------
+=========================
 
 - Bump dependency `requests` to version 2.32.3
 
 
 Version 25.8 (2024-09-10)
--------------------------
+=========================
 
 Features
 --------
@@ -209,7 +262,7 @@ Features
 
 
 Version 25.7 (2024-08-23)
--------------------------
+=========================
 
 Bug fix
 -------
@@ -217,7 +270,7 @@ Bug fix
 
 
 Version 25.6 (2024-08-16)
--------------------------
+=========================
 
 Bug fix
 -------
@@ -226,7 +279,7 @@ Bug fix
 
 
 Version 25.5 (2024-08-15)
--------------------------
+=========================
 
 Features
 --------
@@ -237,7 +290,7 @@ Features
 
 
 Version 25.4 (2024-07-12)
--------------------------
+=========================
 
 Features
 --------
@@ -246,7 +299,7 @@ Features
 
 
 Version 25.3 (2024-07-05)
--------------------------
+=========================
 
 Features
 --------
@@ -257,7 +310,7 @@ Features
 
 
 Version 25.2 (2024-07-04)
--------------------------
+=========================
 
 Features
 --------
@@ -266,7 +319,7 @@ Features
 
 
 Version 25.1 (2024-06-27)
--------------------------
+=========================
 
 Features
 --------

{iqm_exa_common-25.34/src/iqm_exa_common.egg-info → iqm_exa_common-26.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-exa-common
-Version: 25.34
+Version: 26.1
 Summary: Framework for control and measurement of superconducting qubits: common library
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License
@@ -215,7 +215,7 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Requires-Dist: iqm-data-definitions<3.0,>=2.6
 Requires-Dist: numpy<3.0,>=1.25.2
-Requires-Dist: pydantic<3.0,>=2.9.2
+Requires-Dist: pydantic<3.0,>=2.10.4
 Requires-Dist: python-dotenv==0.21.1
 Requires-Dist: xarray==2024.10.0
 Requires-Dist: requests==2.32.3

{iqm_exa_common-25.34 → iqm_exa_common-26.1}/requirements/base.in

@@ -1,6 +1,6 @@
 iqm-data-definitions >= 2.6, < 3.0
 numpy >= 1.25.2, < 3.0
-pydantic >= 2.9.2, < 3.0
+pydantic >= 2.10.4, < 3.0
 python-dotenv == 0.21.1
 xarray == 2024.10.0
 requests == 2.32.3

{iqm_exa_common-25.34 → iqm_exa_common-26.1}/requirements/base.txt

@@ -1,6 +1,6 @@
 iqm-data-definitions >= 2.6, < 3.0
 numpy >= 1.25.2, < 3.0
-pydantic >= 2.9.2, < 3.0
+pydantic >= 2.10.4, < 3.0
 python-dotenv == 0.21.1
 xarray == 2024.10.0
 requests == 2.32.3

{iqm_exa_common-25.34 → iqm_exa_common-26.1}/src/exa/common/api/proto_serialization/_parameter.py

@@ -27,13 +27,14 @@ _collection_types_inv = {v: k for k, v in _COLLECTION_TYPES.items()}
 
 _DATA_TYPES = {
     DataType.ANYTHING: ppb.Parameter.DataType.DATA_TYPE_UNSPECIFIED,
-    DataType.NUMBER: ppb.Parameter.DataType.DATA_TYPE_FLOAT64,
+    DataType.NUMBER: ppb.Parameter.DataType.DATA_TYPE_FLOAT64,  # Deprecated
     DataType.STRING: ppb.Parameter.DataType.DATA_TYPE_STRING,
     DataType.COMPLEX: ppb.Parameter.DataType.DATA_TYPE_COMPLEX128,
     DataType.BOOLEAN: ppb.Parameter.DataType.DATA_TYPE_BOOL,
+    DataType.INT: ppb.Parameter.DataType.DATA_TYPE_INT64,
+    DataType.FLOAT: ppb.Parameter.DataType.DATA_TYPE_FLOAT64,
 }
-_data_types_inv = {v: k for k, v in _DATA_TYPES.items()}
-_data_types_inv[ppb.Parameter.DataType.DATA_TYPE_INT64] = DataType.NUMBER  # TODO add DataType.INT?
+_data_types_inv = {v: k for k, v in _DATA_TYPES.items() if k != DataType.NUMBER}
 
 
 def pack(parameter: Parameter) -> ppb.Parameter:

{iqm_exa_common-25.34 → iqm_exa_common-26.1}/src/exa/common/api/proto_serialization/nd_sweep.py

@@ -18,8 +18,6 @@ import iqm.data_definitions.common.v1.sweep_pb2 as spb
 
 from exa.common.api.proto_serialization import sequence
 import exa.common.api.proto_serialization._parameter as param_proto
-from exa.common.control.sweep.fixed_sweep import FixedSweep
-from exa.common.control.sweep.option.fixed_options import FixedOptions
 from exa.common.control.sweep.sweep import Sweep
 from exa.common.data.parameter import DataType, Parameter
 from exa.common.sweep.util import NdSweep
@@ -41,10 +39,7 @@ def pack(nd_sweep: NdSweep, minimal: bool = True) -> spb.CartesianSweep:
 
 
 def unpack(proto: spb.CartesianSweep) -> NdSweep:
-    """Convert protobuf representation into a NdSweep. Reverse operation of :func:`.pack`.
-
-    Note: All sweeps will be of type :class:`.FixedSweep`.
-    """
+    """Convert protobuf representation into a NdSweep. Reverse operation of :func:`.pack`."""
     nd_sweep = []
     for parallel_proto in reversed(proto.parallel_sweeps):
         parallel = tuple(_unpack_single_sweep(sweep) for sweep in parallel_proto.single_parameter_sweeps)
@@ -59,10 +54,10 @@ def _pack_single_sweep(sweep: Sweep, minimal: bool) -> spb.SingleParameterSweep:
     return spb.SingleParameterSweep(**kwargs)
 
 
-def _unpack_single_sweep(proto: spb.SingleParameterSweep) -> FixedSweep:
+def _unpack_single_sweep(proto: spb.SingleParameterSweep) -> Sweep:
     sweep_values = sequence.unpack(proto.values)
     if proto.HasField("parameter"):
         parameter = param_proto.unpack(proto.parameter)
     else:
         parameter = Parameter(proto.parameter_name, data_type=DataType.ANYTHING)
-    return FixedSweep(parameter, FixedOptions(sweep_values))
+    return Sweep(parameter=parameter, data=sweep_values)

{iqm_exa_common-25.34 → iqm_exa_common-26.1}/src/exa/common/api/proto_serialization/sequence.py

@@ -37,18 +37,18 @@ def pack(values: Sequence) -> dpb.Sequence:
     if not values:
         return target
     dtype = type(values[0])
-    if dtype == complex:  # noqa: E721
+    if dtype is complex:
         target_field = target.complex128_array
         target_field.real.MergeFrom(np.real(values))
         target_field.imag.MergeFrom(np.imag(values))
         return target
-    if dtype == bool:  # noqa: E721
+    if dtype is bool:
         target_field = target.bool_array
-    elif dtype == int:  # noqa: E721
+    elif dtype is int:
         target_field = target.int64_array
-    elif dtype == float:  # noqa: E721
+    elif dtype is float:
         target_field = target.float64_array
-    elif dtype == str:  # noqa: E721
+    elif dtype is str:
         target_field = target.string_array
     else:
         raise TypeError(f"Unsupported numpy array type {dtype} for a sequence.")

{iqm_exa_common-25.34 → iqm_exa_common-26.1}/src/exa/common/api/proto_serialization/setting_node.py

@@ -85,4 +85,6 @@ def unpack(proto: spb.SettingNode) -> SettingNode:
     """
     settings = {key: _unpack_setting(content) for key, content in proto.settings.items()}
     nodes = {key: unpack(content) for key, content in proto.subnodes.items()}
-    return SettingNode(name=proto.name, **(settings | nodes))
+    # Names are currently NEVER aligned with the paths when deserializing. This is safe to do, since currently nothing
+    # in the server-side assumes path==name, but if such logic is added this needs to be reconsidered.
+    return SettingNode(name=proto.name, **(settings | nodes), align_name=False)

iqm_exa_common-26.1/src/exa/common/control/sweep/exponential_sweep.py

@@ -0,0 +1,51 @@
+# Copyright 2024 IQM
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Sweep specification with exponentially spaced values."""
+
+from typing import Any
+import warnings
+
+from exa.common.control.sweep.option import CenterSpanBaseOptions, StartStopBaseOptions
+from exa.common.control.sweep.sweep import Sweep
+from exa.common.data.parameter import Parameter
+from exa.common.errors.exa_error import InvalidSweepOptionsTypeError
+
+
+class ExponentialSweep(Sweep):
+    """Generates parameter values spaced evenly on a geometric progression based on `options`.
+
+    - If `options` is instance of :class:`.StartStopBaseOptions`,
+      the start and stop of the interval are calculated from powers of start and stop.
+    - If `options` is instance of :class:`.CenterSpanBaseOptions`,
+      the start and stop of the interval are calculated from powers of start and stop,
+      which are derived from center and span.
+
+    Raises:
+        ValueError: Error is raised if `options` is inconsistent.
+
+    """
+
+    def __init__(
+        self,
+        parameter: Parameter,
+        options: StartStopBaseOptions | CenterSpanBaseOptions | None = None,
+        *,
+        data: list[Any] | None = None,
+        **kwargs,
+    ) -> None:
+        warnings.warn("ExponentialSweep is deprecated, use Sweep instead.", DeprecationWarning)
+        if options and not isinstance(options, StartStopBaseOptions | CenterSpanBaseOptions):
+            raise InvalidSweepOptionsTypeError(str(type(options)))
+        super().__init__(parameter, options, data=data, **kwargs)

{iqm_exa_common-25.34 → iqm_exa_common-26.1}/src/exa/common/control/sweep/fixed_sweep.py

@@ -14,26 +14,22 @@
 
 """Sweep specification with arbitrary values."""
 
-from dataclasses import dataclass
-
-import numpy as np
+from typing import Any
+import warnings
 
 from exa.common.control.sweep.option import FixedOptions
 from exa.common.control.sweep.sweep import Sweep
+from exa.common.data.parameter import Parameter
 from exa.common.errors.exa_error import InvalidSweepOptionsTypeError
 
 
-@dataclass(frozen=True)
 class FixedSweep(Sweep):
     """A sweep over arbitrary set of values, given by `options`."""
 
-    def __post_init__(self):
-        if not isinstance(self.options, FixedOptions):
-            raise InvalidSweepOptionsTypeError(str(type(self.options)))
-
-        if not all(self.parameter.validate(value) for value in self.options.fixed):
-            raise ValueError(
-                f"Invalid fixed range data {self.options.fixed} for parameter type {self.parameter.data_type.name}."
-            )
-        data = np.asarray(self.options.fixed).tolist()
-        object.__setattr__(self, "_data", data)
+    def __init__(
+        self, parameter: Parameter, options: FixedOptions | None = None, *, data: list[Any] | None = None, **kwargs
+    ) -> None:
+        warnings.warn("FixedSweep is deprecated, use Sweep instead.", DeprecationWarning)
+        if options and not isinstance(options, FixedOptions):
+            raise InvalidSweepOptionsTypeError(str(type(options)))
+        super().__init__(parameter, options, data=data, **kwargs)

iqm_exa_common-26.1/src/exa/common/control/sweep/linear_sweep.py

@@ -0,0 +1,49 @@
+# Copyright 2024 IQM
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Sweep specification with linearly spaced values."""
+
+from typing import Any
+import warnings
+
+from exa.common.control.sweep.option import CenterSpanOptions, StartStopOptions
+from exa.common.control.sweep.sweep import Sweep
+from exa.common.data.parameter import Parameter
+from exa.common.errors.exa_error import InvalidSweepOptionsTypeError
+
+
+class LinearSweep(Sweep):
+    """Generates evenly spaced parameter values based on `options`.
+
+    - If `options` is instance of :class:`.StartStopOptions`, then start and stop options are used for interval
+    - If `options` is instance of :class:`.CenterSpanOptions`,
+      then the start and stop of the interval are calculated from center and span values
+
+    Raises:
+        ValueError: Error is raised if `options` is inconsistent.
+
+    """
+
+    def __init__(
+        self,
+        parameter: Parameter,
+        options: StartStopOptions | CenterSpanOptions | None = None,
+        *,
+        data: list[Any] | None = None,
+        **kwargs,
+    ) -> None:
+        warnings.warn("LinearSweep is deprecated, use Sweep instead.", DeprecationWarning)
+        if options and not isinstance(options, StartStopOptions | CenterSpanOptions):
+            raise InvalidSweepOptionsTypeError(str(type(options)))
+        super().__init__(parameter, options, data=data, **kwargs)

{iqm_exa_common-25.34 → iqm_exa_common-26.1}/src/exa/common/control/sweep/option/__init__.py

@@ -11,12 +11,12 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
 """Range specifications for Sweeps."""
 
 from .center_span_base_options import CenterSpanBaseOptions
 from .center_span_options import CenterSpanOptions
 from .fixed_options import FixedOptions
-from .function_options import FunctionOptions
 from .start_stop_base_options import StartStopBaseOptions
 from .start_stop_options import StartStopOptions
 from .sweep_options import SweepOptions

{iqm_exa_common-25.34 → iqm_exa_common-26.1}/src/exa/common/control/sweep/option/center_span_base_options.py

@@ -12,12 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Range specification used with ExponentialSweep."""
+"""Range specification used with exponential sweeps."""
 
 from dataclasses import dataclass
-from typing import Union
 
 from exa.common.control.sweep.option.constants import DEFAULT_BASE, DEFAULT_COUNT
+from exa.common.control.sweep.option.start_stop_base_options import StartStopBaseOptions
 from exa.common.control.sweep.option.sweep_options import SweepOptions
 
 
@@ -32,17 +32,17 @@ class CenterSpanBaseOptions(SweepOptions):
     """
 
     #: Value of interval center for the power.
-    center: Union[int, float]
+    center: int | float
     #: Size of the interval for the power
-    span: Union[int, float]
+    span: int | float
     #: Number of values to generate. Default to
     #: :const:`exa.common.control.sweep.option.constants.DEFAULT_COUNT`.
-    count: int = None
+    count: int | None = None
     #: Number, that is raised to the power of the range with the center `center` and the size of `span`.
     # Default to :const:`exa.common.control.sweep.option.constants.DEFAULT_BASE`.
-    base: Union[int, float] = None
+    base: int | float | None = None
     #: Order of generated values. Default to ascending
-    asc: bool = None
+    asc: bool | None = None
 
     def __post_init__(self):
         if self.count is None:
@@ -51,3 +51,10 @@ class CenterSpanBaseOptions(SweepOptions):
             object.__setattr__(self, "base", DEFAULT_BASE)
         if self.asc is None:
             object.__setattr__(self, "asc", True)
+
+    @property
+    def data(self) -> list[int | float | complex]:
+        start = self.center - (self.span / 2)
+        stop = self.center + (self.span / 2)
+        (start, stop) = (start, stop) if self.asc else (stop, start)
+        return StartStopBaseOptions(start, stop, count=self.count, base=self.base).data