iqm-client 29.9.0__tar.gz → 29.11.0__tar.gz

{iqm_client-29.9.0 → iqm_client-29.11.0}/CHANGELOG.rst

@@ -2,6 +2,22 @@
 Changelog
 =========
 
+Version 29.11.0 (2025-08-07)
+============================
+
+Features
+--------
+
+- Added :meth:`IQMClient.get_structured_metrics` for obtaining quality metric information.
+
+Version 29.10.0 (2025-07-31)
+============================
+
+Features
+--------
+
+- Support QIR programs in iqm-client
+
 Version 29.9.0 (2025-07-29)
 ===========================
 

{iqm_client-29.9.0 → iqm_client-29.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-client
-Version: 29.9.0
+Version: 29.11.0
 Summary: Client library for accessing an IQM quantum computer
 Author-email: IQM Finland Oy <developers@meetiqm.com>
 License:                                  Apache License

{iqm_client-29.9.0 → iqm_client-29.11.0}/src/iqm/cirq_iqm/iqm_sampler.py

@@ -25,7 +25,7 @@ import warnings
 import cirq
 from iqm.cirq_iqm.devices.iqm_device import IQMDevice, IQMDeviceMetadata
 from iqm.cirq_iqm.serialize import serialize_circuit
-from iqm.iqm_client import CircuitCompilationOptions, IQMClient, JobAbortionError, RunRequest
+from iqm.iqm_client import CircuitBatch, CircuitCompilationOptions, IQMClient, JobAbortionError, RunRequest
 import numpy as np
 
 
@@ -151,7 +151,7 @@ class IQMSampler(cirq.work.Sampler):
         if isinstance(programs, cirq.Circuit):
             programs, _ = self._resolve_parameters(programs, params)
 
-        serialized_circuits = [serialize_circuit(circuit) for circuit in programs]
+        serialized_circuits: CircuitBatch = [serialize_circuit(circuit) for circuit in programs]
 
         if not self._client:
             raise RuntimeError("Cannot submit circuits since session to IQM client has been closed.")

{iqm_client-29.9.0 → iqm_client-29.11.0}/src/iqm/iqm_client/iqm_client.py

@@ -45,6 +45,7 @@ from iqm.iqm_client.models import (
     ClientLibrary,
     ClientLibraryDict,
     DynamicQuantumArchitecture,
+    QIRCode,
     QualityMetricSet,
     QuantumArchitectureSpecification,
     RunCounts,
@@ -64,6 +65,7 @@ import requests
 from requests import HTTPError
 
 from iqm.station_control.client.iqm_server.iqm_server_client import IqmServerClient
+from iqm.station_control.client.qon import ObservationFinder
 from iqm.station_control.client.utils import init_station_control
 from iqm.station_control.interface.models import ObservationLite
 from iqm.station_control.interface.station_control import StationControlInterface
@@ -232,6 +234,8 @@ class IQMClient:
 
         for i, circuit in enumerate(circuits):
             try:
+                if isinstance(circuit, (QIRCode)):
+                    continue
                 # validate the circuit against the static information in iqm.iqm_client.models._SUPPORTED_OPERATIONS
                 validate_circuit(circuit)
             except ValueError as e:
@@ -904,3 +908,33 @@ class IQMClient:
         except json.decoder.JSONDecodeError as e:
             raise EndpointRequestError(f"Invalid response: {response.text}, {e!r}") from e
         return model
+
+    def get_structured_metrics(self, calibration_set_id: UUID | None = None) -> ObservationFinder:
+        """Retrieve the given calibration set and related quality metrics from the server.
+
+        Args:
+            calibration_set_id: ID of the calibration set to retrieve.
+                If ``None``, the current default calibration set is retrieved.
+
+        Returns:
+            Requested calibration set and related quality metrics in a searchable structure.
+
+        Raises:
+            EndpointRequestError: did not understand the endpoint response
+            ClientAuthenticationError: no valid authentication provided
+            HTTPException: HTTP exceptions
+
+        """
+        if isinstance(self._station_control, IqmServerClient):
+            raise ValueError("The get_structured_metrics method is not supported by IqmServerClient.")
+
+        if not calibration_set_id:
+            # find out the default calset id
+            default_calset = self._station_control.get_default_calibration_set()
+            calibration_set_id = default_calset.observation_set_id
+
+        calset_obs = self._station_control.get_observation_set_observations(calibration_set_id)
+        quality_metrics = self._station_control.get_calibration_set_quality_metrics(calibration_set_id)
+        qm_obs = quality_metrics.observations
+
+        return ObservationFinder(list(calset_obs) + qm_obs)

{iqm_client-29.9.0 → iqm_client-29.11.0}/src/iqm/iqm_client/models.py

@@ -459,7 +459,10 @@ class Circuit(BaseModel):
         return instructions
 
 
-CircuitBatch = list[Circuit]
+QIRCode = str
+"""QIR program code in string representation"""
+
+CircuitBatch = list[Circuit | QIRCode]
 """Type that represents a list of quantum circuits to be executed together in a single batch."""
 
 
@@ -473,7 +476,12 @@ def validate_circuit(circuit: Circuit) -> None:
         pydantic.error_wrappers.ValidationError: validation failed
 
     """
-    Circuit.model_validate(circuit.__dict__)
+    if isinstance(circuit, Circuit):
+        Circuit.model_validate(circuit.__dict__)
+    elif isinstance(circuit, QIRCode):
+        pass
+    else:
+        raise ValueError("Every circuit in a batch should be of type <Circuit> or <QIRCode>")
 
 
 class SingleQubitMapping(BaseModel):
@@ -706,6 +714,20 @@ class GateInfo(BaseModel):
         loci_sorted = sorted(loci_set, key=lambda locus: tuple(map(_component_sort_key, locus)))
         return tuple(loci_sorted)
 
+    def get_default_implementation(self, locus: Locus) -> str:
+        """Default implementation of this gate for the given locus.
+
+        Args:
+            locus: gate locus
+
+        Returns:
+            Name of the default implementation of this gate for ``locus``.
+
+        """
+        if (impl := self.override_default_implementation.get(locus)) is not None:
+            return impl
+        return self.default_implementation
+
 
 class DynamicQuantumArchitecture(BaseModel):
     """Dynamic quantum architecture as returned by server.

{iqm_client-29.9.0 → iqm_client-29.11.0}/src/iqm/iqm_client/validation.py

@@ -18,6 +18,7 @@ from iqm.iqm_client.models import (
     DynamicQuantumArchitecture,
     Instruction,
     MoveGateValidationMode,
+    QIRCode,
 )
 
 
@@ -49,6 +50,8 @@ def validate_qubit_mapping(
 
     # check if qubit mapping covers all qubits in the circuits
     for i, circuit in enumerate(circuits):
+        if isinstance(circuit, (QIRCode)):
+            continue
         diff = circuit.all_qubits() - set(qubit_mapping)
         if diff:
             raise CircuitValidationError(
@@ -86,6 +89,9 @@ def validate_circuit_instructions(
 
     """
     for index, circuit in enumerate(circuits):
+        if isinstance(circuit, QIRCode):
+            continue
+
         measurement_keys: set[str] = set()
         for instr in circuit.instructions:
             validate_instruction(architecture, instr, qubit_mapping)

{iqm_client-29.9.0 → iqm_client-29.11.0}/src/iqm/qiskit_iqm/iqm_job.py

@@ -24,6 +24,7 @@ import warnings
 from iqm.iqm_client import (
     DEFAULT_TIMEOUT_SECONDS,
     APITimeoutError,
+    Circuit,
     CircuitMeasurementResults,
     HeraldingMode,
     IQMClient,
@@ -79,8 +80,11 @@ class IQMJob(JobV1):
         expect_exact_shots = iqm_result.metadata.heralding_mode == HeraldingMode.NONE
 
         return [
-            (circuit.name, self._format_measurement_results(measurements, requested_shots, expect_exact_shots))
-            for measurements, circuit in zip(iqm_result.measurements, iqm_result.metadata.circuits)
+            (
+                circuit.name if isinstance(circuit, Circuit) else f"circuit_{i}",
+                self._format_measurement_results(measurements, requested_shots, expect_exact_shots),
+            )
+            for i, (measurements, circuit) in enumerate(zip(iqm_result.measurements, iqm_result.metadata.circuits))
         ]
 
     @staticmethod
@@ -194,7 +198,9 @@ class IQMJob(JobV1):
             # was created manually from a job_id. In that case retrieve circuit metadata from
             # RunResult.metadata.request.circuits[n].metadata
             if self.circuit_metadata is None and results.metadata.request is not None:
-                self.circuit_metadata = [c.metadata for c in results.metadata.circuits]
+                self.circuit_metadata = [
+                    c.metadata if isinstance(c, Circuit) else {} for c in results.metadata.circuits
+                ]
 
         result_dict = {
             "backend_name": None,

{iqm_client-29.9.0 → iqm_client-29.11.0}/src/iqm/qiskit_iqm/iqm_provider.py

@@ -23,6 +23,7 @@ import warnings
 
 from iqm.iqm_client import (
     Circuit,
+    CircuitBatch,
     CircuitCompilationOptions,
     CircuitValidationError,
     IQMClient,
@@ -111,7 +112,7 @@ class IQMBackend(IQMBackendBase):
         run_request = self.create_run_request(run_input, **options)
         job_id = self.client.submit_run_request(run_request)
         job = IQMJob(self, str(job_id), shots=run_request.shots)
-        job.circuit_metadata = [c.metadata for c in run_request.circuits]
+        job.circuit_metadata = [c.metadata if isinstance(c, Circuit) else {} for c in run_request.circuits]
         return job
 
     def create_run_request(
@@ -181,7 +182,7 @@ class IQMBackend(IQMBackendBase):
         if circuit_callback:
             circuit_callback(circuits)
 
-        circuits_serialized: list[Circuit] = [self.serialize_circuit(circuit, qubit_mapping) for circuit in circuits]
+        circuits_serialized: CircuitBatch = [self.serialize_circuit(circuit, qubit_mapping) for circuit in circuits]
 
         if self._use_default_calibration_set:
             default_calset_id = self.client.get_dynamic_quantum_architecture(None).calibration_set_id

{iqm_client-29.9.0 → iqm_client-29.11.0}/src/iqm_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-client
-Version: 29.9.0
+Version: 29.11.0
 Summary: Client library for accessing an IQM quantum computer
 Author-email: IQM Finland Oy <developers@meetiqm.com>
 License:                                  Apache License

iqm_client-29.11.0/version.txt

@@ -0,0 +1 @@
+29.11.0

iqm_client-29.9.0/version.txt

@@ -1 +0,0 @@
-29.9.0