iqm-client 30.1.0__tar.gz → 31.0.0__tar.gz

{iqm_client-30.1.0 → iqm_client-31.0.0}/CHANGELOG.rst

@@ -2,6 +2,28 @@
 Changelog
 =========
 
+Version 31.0.0 (2025-09-11)
+===========================
+
+Breaking changes
+----------------
+
+- Use :class:`iqm.pulse.Circuit` and :class:`iqm.pulse.CircuitOperation` as the new
+  circuit and instruction formats. The old :class:`Circuit`, :class:`Instruction` and :class:`NativeOperation` models defined in
+  :mod:`iqm.iqm_client.models` are removed. :issue:`SW-1663`
+- The quantum operation parameters ``angle_t`` and ``phase_t`` (in units of full turns) are no longer supported.
+  Use ``angle`` and ``phase`` (in units of radians) instead. :issue:`SW-1663`
+- :func:`iqm.cirq_iqm.serialize.instruction_to_operation` renamed to :func:`iqm.cirq_iqm.serialize.circuit_operation_to_operation`.
+- :func:`iqm.cirq_iqm.serialize.map_operation` renamed to :func:`iqm.cirq_iqm.serialize.operation_to_circuit_operation`.
+
+Version 30.2.0 (2025-09-03)
+===========================
+
+Features
+--------
+
+- Enable ruff rule for missing annotations and mark exemptions.
+
 Version 30.1.0 (2025-08-28)
 ===========================
 

{iqm_client-30.1.0 → iqm_client-31.0.0}/INTEGRATION_GUIDE.rst

@@ -26,19 +26,23 @@ requires only the URL of the IQM quantum computer.
 
     iqm_client = IQMClient(server_url)
 
-To submit a quantum circuit for execution, it has to be specified using the :class:`.Circuit` class.
-The available native instructions are documented in the :class:`.Instruction` class.
+To submit a quantum circuit for execution, it has to be specified using the
+:class:`iqm.pulse.Circuit` class. The available native instructions are documented in
+:mod:`iqm.iqm_client.models` and in :class:`iqm.pulse.CircuitOperation`.
 
 .. code-block:: python
 
-    from iqm.iqm_client import Circuit, Instruction
+    from math import pi
+
+    from iqm.pulse.builder import CircuitOperation
+    from iqm.pulse.circuit_operations import Circuit
 
     instructions = (
-        Instruction(
-            name="prx", qubits=("QB1",), args={"phase_t": 0.7, "angle_t": 0.25}
+        CircuitOperation(
+            name="prx", locus=("QB1",), args={"phase": 1.4 * pi, "angle": 0.5 * pi}
         ),
-        Instruction(name="cz", qubits=("QB1", "QB2"), args={}),
-        Instruction(name="measure", qubits=("QB2",), args={"key": "Qubit 2"}),
+        CircuitOperation(name="cz", locus=("QB1", "QB2"), args={}),
+        CircuitOperation(name="measure", locus=("QB2",), args={"key": "Qubit 2"}),
     )
 
     circuit = Circuit(name="quantum_circuit", instructions=instructions)
@@ -143,7 +147,8 @@ A typical Star architecture use case would look something like this:
 
 .. code-block:: python
 
-    from iqm.iqm_client import Circuit, IQMClient, simplify_architecture, transpile_insert_moves, transpile_remove_moves
+    from iqm.iqm_client import IQMClient, simplify_architecture, transpile_insert_moves, transpile_remove_moves
+    from iqm.pulse.circuit_operations import Circuit
 
     client = IQMClient(URL_TO_STAR_SERVER)
     dqa = client.get_dynamic_quantum_architecture()

{iqm_client-30.1.0 → iqm_client-31.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-client
-Version: 30.1.0
+Version: 31.0.0
 Summary: Client library for accessing an IQM quantum computer
 Author-email: IQM Finland Oy <developers@meetiqm.com>
 License:                                  Apache License
@@ -218,6 +218,7 @@ License-File: LICENSE.txt
 License-File: AUTHORS.rst
 Requires-Dist: iqm-station-control-client<10,>=9
 Requires-Dist: iqm-exa-common<27,>=26
+Requires-Dist: iqm-pulse<13,>=12
 Requires-Dist: numpy<3.0,>=1.26.4
 Requires-Dist: packaging==24.1
 Requires-Dist: pydantic<3.0,>=2.9.2
@@ -225,6 +226,7 @@ Requires-Dist: requests==2.32.3
 Provides-Extra: cirq
 Requires-Dist: iqm-station-control-client<10,>=9; extra == "cirq"
 Requires-Dist: iqm-exa-common<27,>=26; extra == "cirq"
+Requires-Dist: iqm-pulse<13,>=12; extra == "cirq"
 Requires-Dist: cirq-core[contrib]~=1.2; extra == "cirq"
 Requires-Dist: ply==3.11; extra == "cirq"
 Requires-Dist: llvmlite>=0.44.0; extra == "cirq"
@@ -232,6 +234,7 @@ Requires-Dist: numba>=0.61.0; extra == "cirq"
 Provides-Extra: cli
 Requires-Dist: iqm-station-control-client<10,>=9; extra == "cli"
 Requires-Dist: iqm-exa-common<27,>=26; extra == "cli"
+Requires-Dist: iqm-pulse<13,>=12; extra == "cli"
 Requires-Dist: click<9,>=8.1.6; extra == "cli"
 Requires-Dist: jsonschema>=4.6.0; extra == "cli"
 Requires-Dist: psutil>=5.9.2; extra == "cli"
@@ -240,6 +243,7 @@ Requires-Dist: python-daemon>=2.3.0; extra == "cli"
 Provides-Extra: qiskit
 Requires-Dist: iqm-station-control-client<10,>=9; extra == "qiskit"
 Requires-Dist: iqm-exa-common<27,>=26; extra == "qiskit"
+Requires-Dist: iqm-pulse<13,>=12; extra == "qiskit"
 Requires-Dist: qiskit<=1.4.2,>=1.0; extra == "qiskit"
 Requires-Dist: qiskit-aer<0.18,>=0.13.1; extra == "qiskit"
 

{iqm_client-30.1.0 → iqm_client-31.0.0}/docs/conf.py

@@ -160,16 +160,23 @@ intersphinx_mapping = {
     "numpy": ("https://numpy.org/doc/stable", None),
     "scipy": ("https://docs.scipy.org/doc/scipy", None),
     "qiskit": ("https://docs.quantum.ibm.com/api/qiskit", None),
+    "iqm.pulse": ("../iqm-pulse", "../../iqm-pulse/build/sphinx/objects.inv"),
 }
 
+# update intersphinx_mapping so it reads inventory from gitlab pages, but
+# generate links to the pages under local file path
+# this is used only in `docs with generated links to local target` ci\cd job
 use_local_target = os.getenv("USE_LOCAL_TARGET", "").lower()
-if use_local_target != "true":
+if use_local_target == "true":
+    intersphinx_mapping.update(
+        {"iqm.pulse": ("../iqm-pulse", "https://iqm.gitlab-pages.iqm.fi/qccsw/exa/exa-repo/iqm-pulse/objects.inv")}
+    )
+else:
     extlinks = {
         "issue": ("https://jira.iqm.fi/browse/%s", "issue %s"),
         "mr": ("https://gitlab.iqm.fi/iqm/qccsw/exa/exa-repo/-/merge_requests/%s", "MR %s"),
     }
 
-
 # -- Options for sphinxcontrib.bibtex -------------------------------------------------
 
 # List of all bibliography files used.

{iqm_client-30.1.0 → iqm_client-31.0.0}/pyproject.toml

@@ -72,7 +72,7 @@ nb_diff_ignore = [ "/metadata/language_info", "/metadata/widgets", "/cells/*/exe
 
 [tool.ruff.lint]
 ignore = [ "D203", "D213",]
-select = [ "E4", "E7", "E9", "E5", "F", "Q", "PL", "I", "D", "UP007", "UP006", "UP035",]
+select = [ "E4", "E7", "E9", "E5", "F", "Q", "PL", "I", "D", "UP007", "UP006", "UP035", "ANN001", "ANN201", "ANN202",]
 unfixable = [ "F401",]
 
 [tool.ruff.lint.isort]
@@ -85,9 +85,9 @@ relative-imports-order = "closest-to-furthest"
 [tool.ruff.lint.per-file-ignores]
 "**/__init__.py" = [ "F401", "PLR0402",]
 "**/docs/*" = [ "E402", "D100",]
-"**/setup.py" = [ "D100", "D103", "I001",]
+"**/setup.py" = [ "D100", "D103", "I001", "ANN201",]
 "**/src/*" = [ "PLR2004", "D400", "D415", "D205", "D401", "D417", "D100", "D101", "D107", "D102", "D105", "D103", "D404", "D104",]
-"**/tests/*" = [ "F632", "PLR2004", "PLR0402", "PLC0414", "D",]
+"**/tests/*" = [ "F632", "PLR2004", "PLR0402", "PLC0414", "D", "ANN001", "ANN201", "ANN202",]
 
 [tool.ruff.lint.pylint]
 max-args = 8

iqm_client-31.0.0/requirements/base.in.internal

@@ -0,0 +1,2 @@
+iqm-pulse
+iqm-station-control-client

{iqm_client-30.1.0 → iqm_client-31.0.0}/requirements/base.txt

@@ -1,5 +1,6 @@
 iqm-station-control-client>=9,<10
 iqm-exa-common>=26,<27
+iqm-pulse>=12,<13
 numpy >= 1.26.4, < 3.0
 packaging == 24.1
 pydantic >= 2.9.2, <3.0

{iqm_client-30.1.0 → iqm_client-31.0.0}/requirements/cirq.txt

@@ -1,5 +1,6 @@
 iqm-station-control-client>=9,<10
 iqm-exa-common>=26,<27
+iqm-pulse>=12,<13
 cirq-core[contrib] ~= 1.2
 ply == 3.11
 llvmlite >= 0.44.0

{iqm_client-30.1.0 → iqm_client-31.0.0}/requirements/cli.txt

@@ -1,5 +1,6 @@
 iqm-station-control-client>=9,<10
 iqm-exa-common>=26,<27
+iqm-pulse>=12,<13
 click >= 8.1.6, < 9
 jsonschema >= 4.6.0
 psutil >= 5.9.2

{iqm_client-30.1.0 → iqm_client-31.0.0}/requirements/qiskit.txt

@@ -1,4 +1,5 @@
 iqm-station-control-client>=9,<10
 iqm-exa-common>=26,<27
+iqm-pulse>=12,<13
 qiskit >= 1.0, <= 1.4.2
 qiskit-aer >= 0.13.1, < 0.18

{iqm_client-30.1.0 → iqm_client-31.0.0}/src/iqm/cirq_iqm/devices/iqm_device.py

@@ -364,5 +364,5 @@ class IQMDevice(devices.Device):
             if len(qubits_updated) != 0:
                 raise ValueError(f"Circuit ends with a qubit state in the resonator {res!r}.")
 
-    def __eq__(self, other):
+    def __eq__(self, other):  # noqa: ANN001
         return self.__class__ == other.__class__ and self._metadata == other._metadata

{iqm_client-30.1.0 → iqm_client-31.0.0}/src/iqm/cirq_iqm/devices/iqm_device_metadata.py

@@ -166,5 +166,5 @@ class IQMDeviceMetadata(devices.DeviceMetadata):
         """Returns the ``cirq.Gateset`` of supported gates on this device."""
         return self._gateset
 
-    def _value_equality_values_(self):
+    def _value_equality_values_(self):  # noqa: ANN202
         return *super()._value_equality_values_(), self._gateset

{iqm_client-30.1.0 → iqm_client-31.0.0}/src/iqm/cirq_iqm/iqm_sampler.py

@@ -85,7 +85,7 @@ class IQMSampler(cirq.work.Sampler):
         """Returns the device used by the sampler."""
         return self._device
 
-    def close_client(self):
+    def close_client(self):  # noqa: ANN201
         """Close IQMClient's session with the user authentication server. Discard the client."""
         if not self._client:
             return

{iqm_client-30.1.0 → iqm_client-31.0.0}/src/iqm/cirq_iqm/optimizers.py

@@ -92,7 +92,7 @@ class MergeOneParameterGroupGates(circuits.PointOptimizer):
     GATE_MERGING_TOLERANCE = 1e-10
 
     @classmethod
-    def _normalize_par(cls, par):
+    def _normalize_par(cls, par):  # noqa: ANN001
         """Normalizes the given parameter value to (-period/2, period/2]."""
         shift = cls.PERIOD / 2
         return operator.mod(par - shift, -cls.PERIOD) + shift

{iqm_client-30.1.0 → iqm_client-31.0.0}/src/iqm/cirq_iqm/serialize.py

@@ -14,6 +14,8 @@
 
 """Helper functions for serializing and deserializing quantum circuits between Cirq and IQM circuit formats."""
 
+from math import pi
+
 from cirq import Circuit, KeyCondition, NamedQid
 from cirq.ops import (
     ClassicallyControlledOperation,
@@ -26,9 +28,10 @@ from cirq.ops import (
     XPowGate,
     YPowGate,
 )
-from iqm import iqm_client
 from iqm.cirq_iqm.iqm_gates import IQMMoveGate
-from iqm.iqm_client import Instruction
+
+import iqm.pulse
+from iqm.pulse import CircuitOperation
 
 # Mapping from IQM operation names to cirq operations
 _IQM_CIRQ_OP_MAP: dict[str, tuple[type[Gate], ...]] = {
@@ -43,11 +46,11 @@ _IQM_CIRQ_OP_MAP: dict[str, tuple[type[Gate], ...]] = {
 }
 
 
-def instruction_to_operation(instr: Instruction) -> Operation:
-    """Convert an IQM instruction to a Cirq Operation.
+def circuit_operation_to_operation(circuit_operation: CircuitOperation) -> Operation:
+    """Convert an IQM circuit operation to a Cirq Operation.
 
     Args:
-        instr: the IQM instruction
+        circuit_operation: the IQM circuit_operation
 
     Returns:
         Operation: the converted operation
@@ -56,23 +59,29 @@ def instruction_to_operation(instr: Instruction) -> Operation:
         OperationNotSupportedError When the circuit contains an unsupported operation.
 
     """
-    if instr.name not in _IQM_CIRQ_OP_MAP:
-        raise OperationNotSupportedError(f"Operation {instr.name} not supported.")
+    if circuit_operation.name not in _IQM_CIRQ_OP_MAP:
+        raise OperationNotSupportedError(f"Operation {circuit_operation.name} not supported.")
 
-    qubits = [NamedQid(qubit, dimension=2) for qubit in instr.qubits]
+    qubits = [NamedQid(qubit, dimension=2) for qubit in circuit_operation.locus]
 
-    if instr.name == "cc_prx":
+    if circuit_operation.name == "cc_prx":
         # special case
-        args = {"exponent": 2 * instr.args["angle_t"], "phase_exponent": 2 * instr.args["phase_t"]}
+        args = {
+            "exponent": circuit_operation.args["angle"] / pi,
+            "phase_exponent": circuit_operation.args["phase"] / pi,
+        }
         # ignore feedback_qubit, we currently only support 1-qubit KeyConditions so it can be
         # added in serialize_circuit
-        return PhasedXPowGate(**args)(*qubits).with_classical_controls(instr.args["feedback_key"])
-
-    cirq_op = _IQM_CIRQ_OP_MAP[instr.name][0]
-    if instr.name == "prx":
-        args = {"exponent": 2 * instr.args["angle_t"], "phase_exponent": 2 * instr.args["phase_t"]}
-    elif instr.name == "measure":
-        args = {"num_qubits": len(qubits), "key": instr.args["key"]}
+        return PhasedXPowGate(**args)(*qubits).with_classical_controls(circuit_operation.args["feedback_key"])
+
+    cirq_op = _IQM_CIRQ_OP_MAP[circuit_operation.name][0]
+    if circuit_operation.name == "prx":
+        args = {
+            "exponent": circuit_operation.args["angle"] / pi,
+            "phase_exponent": circuit_operation.args["phase"] / pi,
+        }
+    elif circuit_operation.name == "measure":
+        args = {"num_qubits": len(qubits), "key": circuit_operation.args["key"]}
         # ignore feedback_key, in Cirq it has to be the same as key
     else:
         # cz, move, reset have no args
@@ -84,7 +93,7 @@ class OperationNotSupportedError(RuntimeError):
     """Raised when a given operation is not supported by the IQM server."""
 
 
-def map_operation(operation: Operation) -> Instruction:
+def operation_to_circuit_operation(operation: Operation) -> CircuitOperation:
     """Map a Cirq Operation to the IQM data transfer format.
 
     Assumes the circuit has been transpiled so that it only contains operations natively supported by the
@@ -94,7 +103,7 @@ def map_operation(operation: Operation) -> Instruction:
         operation: a Cirq Operation
 
     Returns:
-        Instruction: the converted operation
+        CircuitOperation: the converted operation
 
     Raises:
         OperationNotSupportedError When the circuit contains an unsupported operation.
@@ -102,25 +111,25 @@ def map_operation(operation: Operation) -> Instruction:
     """
     locus = tuple(qubit.name if isinstance(qubit, NamedQid) else str(qubit) for qubit in operation.qubits)
     if isinstance(operation.gate, (PhasedXPowGate, XPowGate, YPowGate)):
-        return Instruction(
+        return CircuitOperation(
             name="prx",
-            qubits=locus,
-            args={"angle_t": operation.gate.exponent / 2, "phase_t": operation.gate.phase_exponent / 2},
+            locus=locus,
+            args={"angle": operation.gate.exponent * pi, "phase": operation.gate.phase_exponent * pi},
         )
     if isinstance(operation.gate, MeasurementGate):
         if any(operation.gate.full_invert_mask()):
             raise OperationNotSupportedError("Invert mask not supported")
 
-        return Instruction(
+        return CircuitOperation(
             name="measure",
-            qubits=locus,
+            locus=locus,
             args={"key": operation.gate.key},
         )
     if isinstance(operation.gate, CZPowGate):
         if operation.gate.exponent == 1.0:
-            return Instruction(
+            return CircuitOperation(
                 name="cz",
-                qubits=locus,
+                locus=locus,
                 args={},
             )
         raise OperationNotSupportedError(
@@ -128,14 +137,14 @@ def map_operation(operation: Operation) -> Instruction:
         )
 
     if isinstance(operation.gate, IQMMoveGate):
-        return Instruction(
+        return CircuitOperation(
             name="move",
-            qubits=locus,
+            locus=locus,
             args={},
         )
 
     if isinstance(operation.gate, ResetChannel):
-        return Instruction(name="reset", qubits=locus)
+        return CircuitOperation(name="reset", locus=locus)
 
     if isinstance(operation, ClassicallyControlledOperation):
         if len(operation._conditions) > 1:
@@ -143,12 +152,12 @@ def map_operation(operation: Operation) -> Instruction:
         if not isinstance(operation._conditions[0], KeyCondition):
             raise OperationNotSupportedError("Only KeyConditions are supported as classical controls.")
         if isinstance(operation._sub_operation.gate, (PhasedXPowGate, XPowGate, YPowGate)):
-            return Instruction(
+            return CircuitOperation(
                 name="cc_prx",
-                qubits=locus,
+                locus=locus,
                 args={
-                    "angle_t": operation._sub_operation.gate.exponent / 2,
-                    "phase_t": operation._sub_operation.gate.phase_exponent / 2,
+                    "angle": operation._sub_operation.gate.exponent * pi,
+                    "phase": operation._sub_operation.gate.phase_exponent * pi,
                     "feedback_qubit": "",
                     "feedback_key": str(operation._conditions[0]),
                 },
@@ -162,7 +171,7 @@ def map_operation(operation: Operation) -> Instruction:
     raise OperationNotSupportedError(f"{type(operation.gate)} not natively supported.")
 
 
-def serialize_circuit(circuit: Circuit) -> iqm_client.Circuit:
+def serialize_circuit(circuit: Circuit) -> iqm.pulse.Circuit:
     """Serializes a quantum circuit into the IQM data transfer format.
 
     Args:
@@ -174,10 +183,10 @@ def serialize_circuit(circuit: Circuit) -> iqm_client.Circuit:
     """
     total_ops_list = [op for moment in circuit for op in moment]
     cc_prx_support = any(isinstance(op, ClassicallyControlledOperation) for op in total_ops_list)
-    instructions = list(map(map_operation, total_ops_list))
+    instructions = tuple(map(operation_to_circuit_operation, total_ops_list))
 
     if cc_prx_support:
-        mkey_to_measurement = {}
+        mkey_to_measurement: dict[str, CircuitOperation] = {}
         for inst in instructions:
             if inst.name == "measure":
                 if inst.args["key"] in mkey_to_measurement:
@@ -190,15 +199,15 @@ def serialize_circuit(circuit: Circuit) -> iqm_client.Circuit:
                     raise OperationNotSupportedError(
                         f"cc_prx has feedback_key {feedback_key}, but no measure operation with that key precedes it."
                     )
-                if len(measurement.qubits) != 1:
+                if len(measurement.locus) != 1:
                     raise OperationNotSupportedError("cc_prx must depend on the measurement result of a single qubit.")
-                inst.args["feedback_qubit"] = measurement.qubits[0]
+                inst.args["feedback_qubit"] = measurement.locus[0]
                 measurement.args["feedback_key"] = feedback_key
 
-    return iqm_client.Circuit(name="Serialized from Cirq", instructions=instructions, metadata=None)
+    return iqm.pulse.Circuit(name="Serialized from Cirq", instructions=instructions, metadata=None)
 
 
-def deserialize_circuit(circuit: iqm_client.Circuit) -> Circuit:
+def deserialize_circuit(circuit: iqm.pulse.Circuit) -> Circuit:
     """Deserializes a quantum circuit from the IQM data transfer format to a Cirq Circuit.
 
     Args:
@@ -210,7 +219,7 @@ def deserialize_circuit(circuit: iqm_client.Circuit) -> Circuit:
     """
     return Circuit(
         map(
-            instruction_to_operation,
+            circuit_operation_to_operation,
             circuit.instructions,
         )
     )

{iqm_client-30.1.0 → iqm_client-31.0.0}/src/iqm/iqm_client/cli/cli.py

@@ -58,7 +58,7 @@ class ClickLoggingHandler(logging.Handler):
         super().__init__(level=logging.NOTSET)
         self.formatter = logging.Formatter("%(message)s")
 
-    def emit(self, record):
+    def emit(self, record):  # noqa: ANN001, ANN201
         click.echo(self.format(record))
 
 
@@ -463,7 +463,7 @@ def auth() -> None:
     help="Location of the configuration file to be used.",
 )
 @click.option("-v", "--verbose", is_flag=True, help="Print extra information.")
-def status(config_file, verbose) -> None:
+def status(config_file, verbose) -> None:  # noqa: ANN001
     """Check status of authentication."""
     _set_log_level_by_verbosity(verbose)
 
@@ -503,7 +503,7 @@ def status(config_file, verbose) -> None:
         click.echo(f"Token manager: {click.style('NOT RUNNING', fg='red')}")
 
 
-def _validate_iqm_client_cli_auth_login(no_daemon, no_refresh, config_file) -> ConfigFile:
+def _validate_iqm_client_cli_auth_login(no_daemon, no_refresh, config_file) -> ConfigFile:  # noqa: ANN001
     """Checks if provided combination of auth login options is valid:
        - no_daemon and no_refresh are mutually exclusive
        - config file should pass validation

{iqm_client-30.1.0 → iqm_client-31.0.0}/src/iqm/iqm_client/iqm_client.py

@@ -243,7 +243,7 @@ class IQMClient:
                 # validate the circuit against the static information in iqm.iqm_client.models._SUPPORTED_OPERATIONS
                 validate_circuit(circuit)
             except ValueError as e:
-                raise CircuitValidationError(f"The circuit at index {i} failed the validation").with_traceback(
+                raise CircuitValidationError(f"The circuit at index {i} failed the validation: {e}").with_traceback(
                     e.__traceback__
                 )