iqm-exa-common 26.33.0__tar.gz → 27.1.0__tar.gz

{iqm_exa_common-26.33.0 → iqm_exa_common-27.1.0}/CHANGELOG.rst

@@ -2,6 +2,22 @@
 Changelog
 =========
 
+Version 27.1.0 (2025-09-19)
+===========================
+
+Features
+--------
+
+- Add chip layout to hold the coordinates of the chip design record.
+
+Version 27.0.0 (2025-09-12)
+===========================
+
+Breaking changes
+----------------
+
+- Remove deprecated sweeps.
+
 Version 26.33.0 (2025-09-03)
 ============================
 

{iqm_exa_common-26.33.0/src/iqm_exa_common.egg-info → iqm_exa_common-27.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-exa-common
-Version: 26.33.0
+Version: 27.1.0
 Summary: Framework for control and measurement of superconducting qubits: common library
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License

{iqm_exa_common-26.33.0 → iqm_exa_common-27.1.0}/src/exa/common/control/sweep/sweep.py

@@ -15,13 +15,11 @@
 """Base immutable class for sweeps specifications."""
 
 from typing import Any
-import warnings
 
-from exa.common.control.sweep.option import CenterSpanOptions, StartStopOptions, SweepOptions
+from exa.common.control.sweep.option import CenterSpanOptions, StartStopOptions
 from exa.common.control.sweep.sweep_values import SweepValues
 from exa.common.data.base_model import BaseModel
 from exa.common.data.parameter import Parameter
-from exa.common.errors.exa_error import InvalidSweepOptionsTypeError
 
 
 class Sweep(BaseModel):
@@ -33,30 +31,6 @@ class Sweep(BaseModel):
     data: SweepValues
     """List of values for :attr:`parameter`"""
 
-    def __init__(
-        self, parameter: Parameter, options: SweepOptions | None = None, *, data: SweepValues | None = None, **kwargs
-    ) -> None:
-        if options is None and data is None:
-            raise ValueError("Either 'options' or 'data' is required.")
-        if options is not None and data is not None:
-            raise ValueError(
-                "Can't use both 'options' and 'data' at the same time, give only either of the parameters."
-            )
-        if options is not None:
-            warnings.warn("'options' attribute is deprecated, use 'data' instead.", DeprecationWarning)
-
-            if not isinstance(options, SweepOptions):
-                raise InvalidSweepOptionsTypeError(str(type(options)))
-
-            if isinstance(options, StartStopOptions):
-                data = self.__from_start_stop(parameter, options)
-            elif isinstance(options, CenterSpanOptions):
-                data = self.__from_center_span(parameter, options)
-            else:
-                data = options.data
-
-        super().__init__(parameter=parameter, data=data, **kwargs)  # type: ignore[call-arg]  # type: ignore[call-arg]
-
     def model_post_init(self, __context: Any) -> None:
         if not all(self.parameter.validate(value) for value in self.data):
             raise ValueError(f"Invalid range data {self.data} for parameter type {self.parameter.data_type}.")
@@ -75,6 +49,6 @@ class Sweep(BaseModel):
         return options.data
 
     @staticmethod
-    def _validate_value(parameter: Parameter, value: int | float | complex | str | bool, value_label: str):
+    def _validate_value(parameter: Parameter, value: complex | str | bool, value_label: str) -> None:
         if not parameter.validate(value):
             raise ValueError(f"Invalid {value_label} value {value} for parameter type {parameter.data_type}.")

iqm_exa_common-27.1.0/src/exa/common/errors/exa_error.py

@@ -0,0 +1,22 @@
+class ExaError(Exception):
+    """Base class for exa errors.
+
+    Attributes:
+        message: Error message.
+
+    """
+
+    def __init__(self, message: str, *args) -> None:
+        super().__init__(message, *args)
+        self.message = message
+
+    def __str__(self) -> str:
+        return self.message
+
+
+class UnknownSettingError(ExaError, AttributeError):
+    """This SettingNode does not have a given key."""
+
+
+class EmptyComponentListError(ExaError, ValueError):
+    """Error raised when an empty list is given as components for running an experiment."""

iqm_exa_common-27.1.0/src/exa/common/qcm_data/chip_layout.py

@@ -0,0 +1,123 @@
+# Copyright 2025 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.
+
+"""Chip layout class."""
+
+from __future__ import annotations
+
+from functools import cached_property
+
+import numpy as np
+
+from exa.common.errors.exa_error import ExaError
+
+
+class ChipLayout:
+    """The chip layout contains the components and their 2D cartesian coordinates."""
+
+    def __init__(
+        self,
+        qubits: dict[str, tuple[float, float]],
+        couplers: dict[str, tuple[float, float]],
+        computational_resonators: dict[str, tuple[float, float]],
+    ) -> None:
+        self._qubits = list(qubits)
+        self._couplers = list(couplers)
+        self._computational_resonators = list(computational_resonators)
+        self._coordinates = {
+            comp: (x, y) for comp, (x, y) in [*qubits.items(), *couplers.items(), *computational_resonators.items()]
+        }
+
+    @classmethod
+    def from_chip_design_record(cls, record: dict) -> ChipLayout:
+        """Construct the chip layout from a raw chip design record.
+
+        Args:
+            record: The chip design record as returned by station control.
+
+        Returns:
+            The corresponding chip layout.
+
+        """
+        qubits = record["content"]["components"].get("qubit", [])
+        couplers = record["content"]["components"].get("tunable_coupler", [])
+        comprs = record["content"]["components"].get("computational_resonator", [])
+        if all("locations" in component for component in [*qubits, *couplers, *comprs]):
+            return cls(
+                qubits={
+                    qubit["name"]: (qubit["locations"]["metro"]["x"], qubit["locations"]["metro"]["y"])
+                    for qubit in qubits
+                },
+                couplers={
+                    coupler["name"]: (coupler["locations"]["metro"]["x"], coupler["locations"]["metro"]["y"])
+                    for coupler in couplers
+                },
+                computational_resonators={
+                    compr["name"]: (compr["locations"]["metro"]["x"], compr["locations"]["metro"]["y"])
+                    for compr in comprs
+                },
+            )
+        raise ExaError("Chip design record is missing locations.")
+
+    def normalize_coordinates(self, scale: float) -> None:
+        self._coordinates = {comp: (xx * scale, yy * scale) for comp, (xx, yy) in self._coordinates.items()}
+
+    def mirror_yaxis(self) -> None:
+        self._coordinates = {comp: (xx, -yy) for comp, (xx, yy) in self._coordinates.items()}
+
+    def rotate_layout(self) -> None:
+        self._coordinates = {
+            comp: ((xx + yy) / np.sqrt(2), (-xx + yy) / np.sqrt(2)) for comp, (xx, yy) in self._coordinates.items()
+        }
+
+    def move_origin(self) -> None:
+        x_min, y_min = (
+            min([xx for comp, (xx, yy) in self._coordinates.items()]),
+            min([yy for comp, (xx, yy) in self._coordinates.items()]),
+        )
+        self._coordinates = {comp: (xx - x_min, yy - y_min) for comp, (xx, yy) in self._coordinates.items()}
+
+    @property
+    def qubits(self) -> list[str]:
+        return self._qubits
+
+    @property
+    def couplers(self) -> list[str]:
+        return self._couplers
+
+    @property
+    def computational_resonators(self) -> list[str]:
+        return self._computational_resonators
+
+    @cached_property
+    def components(self) -> list[str]:
+        return [*self._qubits, *self._couplers, *self._computational_resonators]
+
+    def get_coordinates(self, component: str) -> tuple[float, float]:
+        """Get the coordinates for the given component.
+
+        Args:
+            component: The name of the component.
+
+        Returns:
+            The 2D cartesian coordinates.
+
+        """
+        if component not in self.components:
+            raise ValueError(f"Component {component} not in chip layout.")
+        return self._coordinates[component]
+
+    def get_all_qubit_coordinates(self) -> dict[str, tuple[float, float]]:
+        """Get the coordinates for all qubits."""
+        return {qubit: self._coordinates[qubit] for qubit in self._qubits}

{iqm_exa_common-26.33.0 → iqm_exa_common-27.1.0/src/iqm_exa_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-exa-common
-Version: 26.33.0
+Version: 27.1.0
 Summary: Framework for control and measurement of superconducting qubits: common library
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License

{iqm_exa_common-26.33.0 → iqm_exa_common-27.1.0}/src/iqm_exa_common.egg-info/SOURCES.txt

@@ -31,9 +31,6 @@ src/exa/common/api/proto_serialization/sequence.py
 src/exa/common/api/proto_serialization/setting_node.py
 src/exa/common/control/__init__.py
 src/exa/common/control/sweep/__init__.py
-src/exa/common/control/sweep/exponential_sweep.py
-src/exa/common/control/sweep/fixed_sweep.py
-src/exa/common/control/sweep/linear_sweep.py
 src/exa/common/control/sweep/sweep.py
 src/exa/common/control/sweep/sweep_values.py
 src/exa/common/control/sweep/option/__init__.py
@@ -65,6 +62,7 @@ src/exa/common/logger/__init__.py
 src/exa/common/logger/logger.py
 src/exa/common/qcm_data/__init__.py
 src/exa/common/qcm_data/chad_model.py
+src/exa/common/qcm_data/chip_layout.py
 src/exa/common/qcm_data/chip_topology.py
 src/exa/common/qcm_data/file_adapter.py
 src/exa/common/qcm_data/immutable_base_model.py

iqm_exa_common-27.1.0/version.txt

@@ -0,0 +1 @@
+27.1.0

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

@@ -1,53 +0,0 @@
-# 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
-
-from typing_extensions import deprecated
-
-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
-from exa.common.helpers.deprecation import format_deprecated
-
-
-@deprecated(format_deprecated(old="`ExponentialSweep`", new="`Sweep`", since="28.3.2025"))
-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:
-        if options and not isinstance(options, StartStopBaseOptions | CenterSpanBaseOptions):
-            raise InvalidSweepOptionsTypeError(str(type(options)))
-        super().__init__(parameter, options, data=data, **kwargs)

iqm_exa_common-26.33.0/src/exa/common/control/sweep/fixed_sweep.py

@@ -1,37 +0,0 @@
-# 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 arbitrary values."""
-
-from typing import Any
-
-from typing_extensions import deprecated
-
-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
-from exa.common.helpers.deprecation import format_deprecated
-
-
-@deprecated(format_deprecated(old="`FixedSweep`", new="`Sweep`", since="28.3.2025"))
-class FixedSweep(Sweep):
-    """A sweep over arbitrary set of values, given by `options`."""
-
-    def __init__(
-        self, parameter: Parameter, options: FixedOptions | None = None, *, data: list[Any] | None = None, **kwargs
-    ) -> None:
-        if options and not isinstance(options, FixedOptions):
-            raise InvalidSweepOptionsTypeError(str(type(options)))
-        super().__init__(parameter, options, data=data, **kwargs)

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

@@ -1,51 +0,0 @@
-# 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
-
-from typing_extensions import deprecated
-
-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
-from exa.common.helpers.deprecation import format_deprecated
-
-
-@deprecated(format_deprecated(old="`LinearSweep`", new="`Sweep`", since="28.3.2025"))
-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:
-        if options and not isinstance(options, StartStopOptions | CenterSpanOptions):
-            raise InvalidSweepOptionsTypeError(str(type(options)))
-        super().__init__(parameter, options, data=data, **kwargs)

iqm_exa_common-26.33.0/src/exa/common/errors/exa_error.py

@@ -1,35 +0,0 @@
-from typing_extensions import deprecated
-
-from exa.common.helpers.deprecation import format_deprecated
-
-
-class ExaError(Exception):
-    """Base class for exa errors.
-
-    Attributes:
-        message: Error message.
-
-    """
-
-    def __init__(self, message: str, *args):
-        super().__init__(message, *args)
-        self.message = message
-
-    def __str__(self):
-        return self.message
-
-
-class UnknownSettingError(ExaError, AttributeError):
-    """This SettingNode does not have a given key."""
-
-
-class EmptyComponentListError(ExaError, ValueError):
-    """Error raised when an empty list is given as components for running an experiment."""
-
-
-@deprecated(format_deprecated(old="`InvalidSweepOptionsTypeError`", new="`Sweep.data`", since="28.3.2025"))
-class InvalidSweepOptionsTypeError(ExaError, TypeError):
-    """The type of sweep options is invalid."""
-
-    def __init__(self, options: str, *args):
-        super().__init__(f"Options have unsupported type of {options}", *args)

iqm_exa_common-26.33.0/version.txt

@@ -1 +0,0 @@
-26.33.0