iqm-client 29.6.0__tar.gz → 29.8.0__tar.gz

{iqm_client-29.6.0 → iqm_client-29.8.0}/CHANGELOG.rst

@@ -2,6 +2,23 @@
 Changelog
 =========
 
+Version 29.8.0 (2025-07-23)
+===========================
+
+Features
+--------
+
+- An update to IQMFacadeBackend such that all available IQMFakeBackends are usable for simulation, rather than
+just IQMFakeAdonis
+
+Version 29.7.0 (2025-07-15)
+===========================
+
+Bug fixes
+---------
+
+- Fix Resonance example links in Qiskit user guide
+
 Version 29.6.0 (2025-07-15)
 ===========================
 

{iqm_client-29.6.0 → iqm_client-29.8.0}/PKG-INFO

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

{iqm_client-29.6.0 → iqm_client-29.8.0}/docs/user_guide_qiskit.rst

@@ -29,7 +29,7 @@ IQM Resonance
    your token, you have the option to regenerate it at any time. However, be aware that regenerating
    your API token will invalidate any previously generated token.
 3. Download one of the demo notebooks from `IQM Academy <https://www.iqmacademy.com/tutorials/>`_ or the
-   `resonance_example.py example file <https://raw.githubusercontent.com/iqm-finland/sdk/main/iqm-client/src/iqm/qiskit_iqm/examples/resonance_example.py>`_
+   `resonance_example.py example file <https://raw.githubusercontent.com/iqm-finland/sdk/refs/heads/main/iqm_client/src/iqm/qiskit_iqm/examples/resonance_example.py>`_
    (Save Page As...)
 4. Install Qiskit on IQM as instructed below.
 5. Add your API token to the example (either as the parameter ``token`` to the :class:`.IQMProvider`
@@ -92,7 +92,7 @@ If you are using IQM Resonance, you have two options to authenticate:
 1. Set the :envvar:`IQM_TOKEN` environment variable to the API token obtained from the Resonance dashboard.
 2. Pass the ``token`` parameter to :class:`.IQMProvider`. This will be forwarded to
    :class:`~iqm.iqm_client.iqm_client.IQMClient`. For an example, see the `resonance_example.py file
-   <https://raw.githubusercontent.com/iqm-finland/sdk/main/iqm-client/src/iqm/qiskit_iqm/examples/resonance_example.py>`_
+   <https://raw.githubusercontent.com/iqm-finland/sdk/refs/heads/main/iqm_client/src/iqm/qiskit_iqm/examples/resonance_example.py>`_
 
 On-premises devices
 ~~~~~~~~~~~~~~~~~~~
@@ -734,9 +734,10 @@ Results from such executions are random bits. This may be useful when developing
 Qiskit on IQM contains :class:`.IQMFacadeBackend`, which allows to combine the mock remote execution with a local
 noisy quantum circuit simulation. This way you can both validate your integration as well as get an idea of the expected circuit execution results.
 
-To run a circuit this way, use the ``"facade_adonis"`` backend retrieved from the provider. Note that the provider must be
-initialized with the URL of a quantum computer with the equivalent architecture (i.e. names of qubits, their
-connectivity, and the native gateset should match the 5-qubit Adonis architecture).
+To run a circuit this way, use the ``"facade_x"``, (where `x` is one of the adonis, aprhodite, apollo, deneb or garnet architectures) backend retrieved from the provider.
+Note that the provider must be initialized with the URL of a quantum computer with the equivalent architecture (i.e. names of qubits, their
+connectivity, and the native gateset should match the desired architecture). 
+Additionally, the URL should point to a mock environment rather than a real device as the execution results from the remote will be discarded and replaced by a simulated result generated by Qiskit Aer.
 
 .. code-block:: python
 

{iqm_client-29.6.0 → iqm_client-29.8.0}/src/iqm/qiskit_iqm/iqm_provider.py

@@ -21,9 +21,17 @@ from typing import Any
 from uuid import UUID
 import warnings
 
-from iqm.iqm_client import Circuit, CircuitCompilationOptions, CircuitValidationError, IQMClient, RunRequest
+from iqm.iqm_client import (
+    Circuit,
+    CircuitCompilationOptions,
+    CircuitValidationError,
+    IQMClient,
+    RunRequest,
+)
 from iqm.iqm_client.util import to_json_dict
+from iqm.qiskit_iqm import IQMFakeAphrodite, IQMFakeApollo, IQMFakeDeneb
 from iqm.qiskit_iqm.fake_backends import IQMFakeAdonis
+from iqm.qiskit_iqm.fake_backends.fake_garnet import IQMFakeGarnet
 from iqm.qiskit_iqm.iqm_backend import IQMBackendBase
 from iqm.qiskit_iqm.iqm_job import IQMJob
 from iqm.qiskit_iqm.qiskit_to_iqm import serialize_instructions
@@ -257,26 +265,31 @@ class IQMBackend(IQMBackendBase):
         return Circuit(name=circuit.name, instructions=instructions, metadata=metadata)
 
 
+facade_names = {
+    "facade_adonis": IQMFakeAdonis(),
+    "facade_aphrodite": IQMFakeAphrodite(),
+    "facade_apollo": IQMFakeApollo(),
+    "facade_deneb": IQMFakeDeneb(),
+    "facade_garnet": IQMFakeGarnet(),
+}
+
+
 class IQMFacadeBackend(IQMBackend):
-    """Facade backend for mimicking the execution of quantum circuits on IQM quantum computers. Allows to submit a
-     circuit to the IQM server, and if the execution was successful, performs a simulation with a respective IQM noise
-     model locally, then returns the simulated results.
+    """Simulates the execution of quantum circuits on a mock IQM quantum computer.
+
+    Can be used to submit a circuit to a mock IQM server that has no real quantum hardware,
+    and if the mock execution is successful, simulates the circuit locally using an error model that
+    is representative of the mocked QPU. Finally returns the simulated results.
 
     Args:
-        client: client instance for communicating with an IQM server
-        **kwargs: optional arguments to be passed to the parent Backend initializer
+        client: Client instance for communicating with an IQM server.
+        **kwargs: Optional arguments to be passed to the parent class.
 
     """
 
     def __init__(self, client: IQMClient, **kwargs):
-        self.fake_adonis = IQMFakeAdonis()
-        target_architecture = client.get_static_quantum_architecture()
-
-        if not self.fake_adonis.validate_compatible_architecture(target_architecture):
-            raise ValueError("Quantum architecture of the remote quantum computer does not match Adonis.")
-
         super().__init__(client, **kwargs)
-        self.name = "facade_adonis"
+        self.backend = self._determine_facade_backend_from_sqa()
 
     def _validate_no_empty_cregs(self, circuit: QuantumCircuit) -> bool:
         """Returns True if given circuit has no empty (unused) classical registers, False otherwise."""
@@ -289,6 +302,12 @@ class IQMFacadeBackend(IQMBackend):
             return False
         return True
 
+    def _determine_facade_backend_from_sqa(self) -> IQMFacadeBackend:
+        for backend in facade_names.values():
+            if backend.validate_compatible_architecture(self.client.get_static_quantum_architecture()):
+                return backend
+        raise ValueError("Quantum architecture of the remote quantum computer does not match facade input.")
+
     def run(self, run_input: QuantumCircuit | list[QuantumCircuit], **options) -> JobV1:
         circuits = [run_input] if isinstance(run_input, QuantumCircuit) else run_input
         circuits_validated_cregs: list[bool] = [self._validate_no_empty_cregs(circuit) for circuit in circuits]
@@ -302,7 +321,7 @@ class IQMFacadeBackend(IQMBackend):
         iqm_backend_job.result()  # get and discard results
         if iqm_backend_job.status() == JobStatus.ERROR:
             raise RuntimeError("Remote execution did not succeed.")
-        return self.fake_adonis.run(run_input, **options)
+        return self.backend.run(run_input, **options)
 
 
 class IQMProvider:
@@ -336,7 +355,9 @@ class IQMProvider:
         client = IQMClient(self.url, **self.user_auth_args)
 
         if name and name.startswith("facade_"):
-            if name == "facade_adonis":
+            if name in facade_names:
+                if not facade_names[name].validate_compatible_architecture(client.get_static_quantum_architecture()):
+                    raise ValueError("Quantum architecture of the remote quantum computer does not match facade input.")
                 return IQMFacadeBackend(client)
 
             warnings.warn(f"Unknown facade backend: {name}. A regular backend associated with {self.url} will be used.")

{iqm_client-29.6.0 → iqm_client-29.8.0}/src/iqm_client.egg-info/PKG-INFO

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

iqm_client-29.8.0/version.txt

@@ -0,0 +1 @@
+29.8.0

iqm_client-29.6.0/version.txt

@@ -1 +0,0 @@
-29.6.0