iqm-client 31.8.0__tar.gz → 32.1.1__tar.gz

{iqm_client-31.8.0 → iqm_client-32.1.1}/CHANGELOG.rst

@@ -2,6 +2,31 @@
 Changelog
 =========
 
+Version 32.1.1 (2025-10-27)
+===========================
+
+- Bump version for 4.3.1 release. No functional changes.
+
+Version 32.1.0 (2025-10-13)
+===========================
+
+Features
+--------
+
+- Add support for the ``with circuit.if_test()`` construction for classical control in Qiskit :issue:`SW-1724`.
+- Deprecate the ``c_if`` method in favor of the new ``if_test`` method for classical control in Qiskit :issue:`SW-1724`.
+- Bugfix: Fixed the transpiler bug causing classical conditionals to be ignored in certain cases :issue:`SW-1856`.
+- Using one of our transpiler plugins that do not apply MoveGate routing, no longer raises an error when the target backend is not set in the transpiler. e.g. ``transpile(circuit, scheduling_method="only_rz_optimization", basis_gates=['r','cz', 'if_else'])``.
+
+Version 32.0.0 (2025-10-09)
+===========================
+
+Breaking changes
+----------------
+
+- Remove the Cortex CLI authentication utility. See the updated user guides.
+- Remove :mod:`iqm.qiskit_iqm.examples.resonance_example`.
+
 Version 31.8.0 (2025-10-06)
 ===========================
 

{iqm_client-31.8.0 → iqm_client-32.1.1}/INTEGRATION_GUIDE.rst

@@ -100,22 +100,9 @@ Authentication
 --------------
 
 IQM uses bearer token authentication to manage access to quantum computers.
-Currently, there are three mutually exclusive ways of providing an authentication
-token to IQM client:
-
-1. The recommended way is to use :ref:`IQM Client CLI <User guide CLI>`
-   to manage the authentication tokens and store them into a file. IQM client can then read
-   the token from the file and use it for authentication. The file path can be provided to
-   IQM client in environment variable :envvar:`IQM_TOKENS_FILE`.
-   Alternatively, the tokens file path can be provided as argument ``tokens_file`` to
-   :class:`.IQMClient` constructor.
-
-2. It is also possible to use plaintext token obtained from a server dashboard. These
-   tokens may have longer lifespan than access tokens generated by IQM Client CLI, and thus
-   IQM client won't attempt to refresh them. The generated token can be provided to IQM
-   client in environment variable :envvar:`IQM_TOKEN`.
-   Alternatively, the token can be provided as argument ``token`` to :class:`.IQMClient`
-   constructor.
+Get your personal token from the web dashboard. The generated token can be provided to IQM
+client via an environment variable :envvar:`IQM_TOKEN`.
+Alternatively, the token can be provided as argument ``token`` to :class:`.IQMClient` constructor.
 
 Circuit transpilation
 ---------------------

{iqm_client-31.8.0 → iqm_client-32.1.1}/PKG-INFO

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

{iqm_client-31.8.0 → iqm_client-32.1.1}/docs/index.rst

@@ -10,8 +10,6 @@ Includes `Qiskit <https://qiskit.org/>`_ and `Cirq <https://quantumai.google/cir
 `IQM's <https://www.meetiqm.com>`_ quantum computers. See user guides for :ref:`Qiskit <User guide Qiskit>` and
 :ref:`Cirq <User guide Cirq>` for introductions on how to install and use the adapters.
 
-Also includes a :ref:`CLI utility <User guide CLI>` for managing user authentication when using IQM quantum computers.
-
 Contents
 ========
 
@@ -21,7 +19,6 @@ Contents
    readme
    API
    integration_guide
-   user_guide_cli
    user_guide_qiskit
    user_guide_cirq
    license

{iqm_client-31.8.0 → iqm_client-32.1.1}/docs/user_guide_cirq.rst

@@ -435,23 +435,12 @@ as explained in the :ref:`routing` section above.
 Authentication
 ^^^^^^^^^^^^^^
 
-IQM Resonance
-"""""""""""""
+There are two options to authenticate:
 
-If you are using IQM Resonance, you have two options to authenticate:
-
-1. Set the :envvar:`IQM_TOKEN` environment variable with the API token obtained from the Resonance dashboard.
+1. Set the :envvar:`IQM_TOKEN` environment variable with the API token obtained from the web dashboard.
 2. Pass the ``token`` parameter to :class:`.IQMSampler`. This will be forwarded to
    :class:`~iqm.iqm_client.iqm_client.IQMClient`.
 
-On-premises devices
-"""""""""""""""""""
-
-If the IQM server you are connecting to requires authentication, you may use
-:ref:`IQM Client CLI <User guide CLI>` to retrieve and automatically refresh access tokens,
-then set the :envvar:`IQM_TOKENS_FILE` environment variable, as instructed, to point to the tokens file.
-See IQM Client CLI's `documentation <https://docs.meetiqm.com/iqm-client/user_guide_cli.html>`__ for details.
-
 Batch execution
 ^^^^^^^^^^^^^^^
 

{iqm_client-31.8.0 → iqm_client-32.1.1}/docs/user_guide_qiskit.rst

@@ -16,26 +16,22 @@ Hello, world!
 -------------
 
 Here's a quick and easy way to run a small computation on an IQM quantum computer to check that
-things are set up correctly, either
-through the IQM cloud service Resonance, or using an on-premises quantum computer.
+things are set up correctly.
 
-IQM Resonance
-~~~~~~~~~~~~~
-
-1. Login to `IQM Resonance <https://resonance.meetiqm.com>`_ with your credentials.
-2. Upon your first visit to IQM Resonance, you can generate your unique, non-recoverable API token
+1. Login to the web dashboard with your credentials. If you're using the IQM Resonance cloud service, go to
+   `IQM Resonance <https://resonance.meetiqm.com>`_.
+2. Upon your first visit, you can generate your unique, non-recoverable API token
    directly from the Dashboard page by selecting ``Generate token``. It's important to copy the token
    immediately from the window, as you won't be able to do so once the window is closed. If you lose
    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/refs/heads/main/iqm_client/src/iqm/qiskit_iqm/examples/resonance_example.py>`_
+3. Store your API token in the environment variable :envvar:`IQM_TOKEN`.
+4. Download one of the demo notebooks from `IQM Academy <https://www.iqmacademy.com/tutorials/>`_ or the
+   `bell_measure.py example file <https://raw.githubusercontent.com/iqm-finland/sdk/refs/heads/main/iqm_client/src/iqm/qiskit_iqm/examples/bell_measure.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`
-   constructor, or by setting the environment variable :envvar:`IQM_TOKEN`)
+5. Install Qiskit on IQM as instructed below.
 6. Run the Jupyter notebook (or run
-   ``python resonance_example.py --url https://cocos.resonance.meetiqm.com/<RESONANCE QC NAME>``
+   ``python bell_measure.py --url https://<IQM server URL>``
    if you decided to go for the Python script).
 7. If you're connecting to a real quantum computer, the output should show almost half of the
    measurements resulting in '00000' and almost half in '11111' - if this is the case, things are
@@ -45,20 +41,6 @@ You can find a video guide on how to set things up `here <https://www.iqmacademy
 More ready-to-run examples can also be found at `IQM Academy <https://www.iqmacademy.com/tutorials/>`_.
 
 
-On-premises device
-~~~~~~~~~~~~~~~~~~
-
-1. Download the `bell_measure.py example file <https://raw.githubusercontent.com/iqm-finland/sdk/refs/heads/main/iqm_client/src/iqm/qiskit_iqm/examples/bell_measure.py>`_ (Save Page As...).
-2. Install Qiskit on IQM as instructed below.
-3. Install IQM Client CLI and log in as instructed in the
-   `documentation <https://docs.meetiqm.com/iqm-client/user_guide_cli.html#installing-iqm-client-cli>`__
-4. Set the environment variable as instructed by IQM Client CLI after logging in.
-5. Run ``$ python bell_measure.py --url https://<YOUR IQM SERVER>`` - replace the example URL with the correct one.
-6. If you're connecting to a real quantum computer, the output should show almost half of the
-   measurements resulting in '00' and almost half in '11' - if this is the case, things are set up
-   correctly!
-
-
 Installation
 ------------
 
@@ -86,25 +68,13 @@ After installation, Qiskit on IQM can be imported in your Python code as follows
 Authentication
 --------------
 
-IQM Resonance
-~~~~~~~~~~~~~
-
-If you are using IQM Resonance, you have two options to authenticate:
+There are two options to authenticate:
 
-1. Set the :envvar:`IQM_TOKEN` environment variable to the API token obtained from the Resonance dashboard.
+1. Set the :envvar:`IQM_TOKEN` environment variable to the API token obtained from the web 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/refs/heads/main/iqm_client/src/iqm/qiskit_iqm/examples/resonance_example.py>`_
+   :class:`~iqm.iqm_client.iqm_client.IQMClient`. For an example, see
+   `bell_measure.py <https://raw.githubusercontent.com/iqm-finland/sdk/refs/heads/main/iqm_client/src/iqm/qiskit_iqm/examples/bell_measure.py>`_
 
-On-premises devices
-~~~~~~~~~~~~~~~~~~~
-
-If the IQM server you are connecting to requires authentication, you may use
-:ref:`IQM Client CLI <User guide CLI>` to retrieve and automatically refresh access tokens,
-then set the :envvar:`IQM_TOKENS_FILE` environment variable, as instructed, to point to the tokens file.
-See IQM Client CLI's `documentation <https://docs.meetiqm.com/iqm-client/user_guide_cli.html>`__ for details.
-
-You may also authenticate yourself by setting the access token in the the :envvar:`IQM_TOKEN` variable
 
 Running quantum circuits on an IQM quantum computer
 ---------------------------------------------------
@@ -180,10 +150,9 @@ circuit(s) are sampled:
 
     As of ``iqm-client >= 30.1.0``, structured quality metrics and calibration data are available to
     ``IQMTarget`` for improved transpilation. To import the latest valid quality metric data corresponding
-    to the default calibration set into ``IQMTarget``, set ``use_metrics`` to ``True`` when initializing the 
+    to the default calibration set into ``IQMTarget``, set ``use_metrics`` to ``True`` when initializing the
     class. For Resonance users, this data is not yet available via the Resonance API, so use the default setting
     of ``use_metrics`` of ``False``.
-    
 
 You can optionally provide IQMBackend specific options as additional keyword arguments to
 :meth:`.IQMBackend.run`, documented at :meth:`.IQMBackend.create_run_request`.
@@ -310,11 +279,11 @@ support currently has several limitations:
   apply the gate if the bit is 1, and apply an identity gate if the bit is 0.
 * The availability of the controlled gates depends on the instrumentation of the quantum computer.
 
-The classical control can be applied on a circuit instruction using :meth:`~qiskit.circuit.Instruction.c_if`:
+The classical control can be applied on a circuit instruction using :meth:`~qiskit.circuit.QuantumCircuit.if_test`:
 
 .. code-block:: python
 
-    from qiskit import QuantumCircuit
+    from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister
 
     qr = QuantumRegister(2, 'q')
     cr = ClassicalRegister(1, 'c')
@@ -322,26 +291,27 @@ The classical control can be applied on a circuit instruction using :meth:`~qisk
 
     circuit.h(0)
     circuit.measure(0, cr[0])
-    circuit.x(1).c_if(cr, 1)
+    with circuit.if_test((cr[0], 1)):
+        circuit.x(1)  # apply X gate on qubit 1 if cr[0] is 1
     circuit.measure_all()
 
     print(circuit.draw(output='text'))
 
 ::
 
-            ┌───┐┌─┐        ░ ┌─┐
-       q_0: ┤ H ├┤M├────────░─┤M├───
-            └───┘└╥┘ ┌───┐  ░ └╥┘┌─┐
-       q_1: ──────╫──┤ X ├──░──╫─┤M├
-                  ║  └─╥─┘  ░  ║ └╥┘
-                  ║ ┌──╨──┐    ║  ║
-       c: 1/══════╩═╡ 0x1 ╞════╬══╬═
-                  0 └─────┘    ║  ║
-    meas: 2/═══════════════════╩══╩═
-                               0  1
+            ┌───┐┌─┐                           ░ ┌─┐   
+       q_0: ┤ H ├┤M├───────────────────────────░─┤M├───
+            └───┘└╥┘  ┌──────  ┌───┐ ───────┐  ░ └╥┘┌─┐
+       q_1: ──────╫───┤ If-0  ─┤ X ├  End-0 ├──░──╫─┤M├
+                  ║   └──╥───  └───┘ ───────┘  ░  ║ └╥┘
+                  ║ ┌────╨────┐                   ║  ║ 
+       c: 1/══════╩═╡ c_0=0x1 ╞═══════════════════╬══╬═
+                  0 └─────────┘                   ║  ║ 
+    meas: 2/══════════════════════════════════════╩══╩═
+                                                  0  1 
 
 
-The first measurement operation stores its result in the 1-bit classical register ``c``. If the
+The first measurement operation stores its result in the classical register ``c``. If the
 result is 1, the ``X`` gate will be applied. If it is zero, an identity gate of corresponding
 duration is applied instead.
 
@@ -350,9 +320,7 @@ between the '00 0' and '11 1' bins of the histogram (even though the state itsel
 
 .. note::
 
-   Because the gates can only take feedback from one classical bit you must place the measurement result
-   in a 1-bit classical register, ``c`` in the above example.
-
+   ``if_test`` blocks cannot be nested.
 
 Resetting qubits
 ~~~~~~~~~~~~~~~~

{iqm_client-31.8.0 → iqm_client-32.1.1}/src/iqm/iqm_client/authentication.py

@@ -22,9 +22,6 @@ from typing import Any
 
 from iqm.iqm_client.errors import ClientAuthenticationError, ClientConfigurationError
 
-AUTH_CLIENT_ID = "iqm_client"
-AUTH_REALM = "cortex"
-AUTH_REQUESTS_TIMEOUT = float(os.environ.get("IQM_CLIENT_REQUESTS_TIMEOUT", 60.0))
 REFRESH_MARGIN_SECONDS = 60
 
 

iqm_client-31.8.0/src/iqm/qiskit_iqm/examples/resonance_example.py → iqm_client-32.1.1/src/iqm/qiskit_iqm/examples/bell_measure.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Qiskit on IQM developers
+# Copyright 2023 Qiskit on IQM developers
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -11,44 +11,45 @@
 # 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.
-"""This file is an example of using Qiskit on IQM to run a simple but non-trivial quantum circuit on
-Resonance, the IQM quantum cloud service.
+"""An example on using Qiskit on IQM to run a simple quantum circuit on an IQM quantum computer.
+
 See the Qiskit on IQM user guide for instructions:
 https://docs.meetiqm.com/iqm-client/user_guide_qiskit.html
 """
 
 import argparse
 
-from iqm.qiskit_iqm import IQMProvider
+from iqm.qiskit_iqm.iqm_provider import IQMProvider
 from qiskit import QuantumCircuit, transpile
 
 
-def resonance_example(server_url: str, api_token: str | None) -> dict[str, int]:
-    """Run a circuit via IQM Resonance.
+def bell_measure(server_url: str, token: str | None = None, shots: int = 1000) -> dict[str, int]:
+    """Execute a quantum circuit that prepares and measures a generalized Bell (aka GHZ) state.
 
     Args:
-        server_url: URL of the IQM Resonance QC used for execution
-        api_token: IQM Resonance API token for authentication
+        server_url: URL of the IQM server used for execution
+        token: API token for authentication. If not given, uses :env:`IQM_TOKEN`.
+        shots: Requested number of shots.
 
     Returns:
-        a mapping of bitstrings representing qubit measurement results to counts for each result
+        Mapping of bitstrings representing qubit measurement results to counts for each result.
 
     """
-    SHOTS = 1000
-
+    print(f"Executing a circuit on {server_url}")
     # Initialize a backend without metrics as IQMClient._get_calibration_quality_metrics is not supported by resonance
-    backend = IQMProvider(server_url, token=api_token).get_backend()
+    backend = IQMProvider(server_url, token=token).get_backend()
+    if backend.num_qubits < 2:
+        raise ValueError("We need two qubits for the Bell state.")
 
     # Just to make sure that "get_static_quantum_architecture" method works
     static_quantum_architecture = backend.client.get_static_quantum_architecture()
     print(f"static_quantum_architecture={static_quantum_architecture}")
 
-    # Define a quantum circuit
-    num_qb = min(backend.num_qubits, 5)  # use at most 5 qubits
-    qc = QuantumCircuit(num_qb)
-
+    # Define a quantum circuit for a GHZ state
+    n_qubits = min(backend.num_qubits, 5)  # use at most 5 qubits
+    qc = QuantumCircuit(n_qubits)
     qc.h(0)
-    for qb in range(1, num_qb):
+    for qb in range(1, n_qubits):
         qc.cx(0, qb)
     qc.barrier()
     qc.measure_all()
@@ -58,26 +59,22 @@ def resonance_example(server_url: str, api_token: str | None) -> dict[str, int]:
     print(qc_transpiled.draw(output="text"))
 
     # Run the circuit
-    job = backend.run(qc_transpiled, shots=SHOTS)
+    job = backend.run(qc_transpiled, shots=shots)
     return job.result().get_counts()
 
 
 if __name__ == "__main__":
     argparser = argparse.ArgumentParser()
     argparser.add_argument(
-        "--url",
-        help="URL of the IQM Resonance QC",
-        # For example https://cocos.resonance.meetiqm.com/garnet
-        default="https://cocos.resonance.meetiqm.com/<RESONANCE QC NAME>",
+        "--url", required=True, help='IQM server URL, for example "https://cocos.resonance.meetiqm.com/garnet"'
     )
     argparser.add_argument(
         "--token",
-        help="IQM Resonance access token",
+        help="API token for authentication",
         # Provide the API token explicitly or set it as an environment variable
         # following the https://docs.meetiqm.com/iqm-client/user_guide_qiskit.html#authentication
-        default="<INSERT YOUR TOKEN>",
     )
 
     args = argparser.parse_args()
-    results = resonance_example(args.url, args.token)
-    print(results)
+    counts = bell_measure(args.url, args.token)
+    print(counts)

{iqm_client-31.8.0 → iqm_client-32.1.1}/src/iqm/qiskit_iqm/iqm_naive_move_pass.py

@@ -98,7 +98,7 @@ class IQMNaiveResonatorMoving(TransformationPass):
         # Convert the circuit to the IQMClientCircuit format and run the transpiler.
         iqm_circuit = IQMClientCircuit(
             name="Transpiling Circuit",
-            instructions=tuple(serialize_instructions(circuit, self.idx_to_component)),
+            instructions=tuple(serialize_instructions(circuit, self.idx_to_component, overwrite_layout=layout)),
             metadata=None,
         )
         try:

{iqm_client-31.8.0 → iqm_client-32.1.1}/src/iqm/qiskit_iqm/iqm_target.py

@@ -26,7 +26,7 @@ from iqm.iqm_client import (
     ObservationFinder,
 )
 from iqm.qiskit_iqm.move_gate import MoveGate
-from qiskit.circuit import Delay, Gate, Parameter, Reset
+from qiskit.circuit import Delay, Gate, IfElseOp, Parameter, Reset
 from qiskit.circuit.library import CZGate, IGate, Measure, RGate
 from qiskit.providers import QubitProperties
 from qiskit.transpiler import InstructionProperties, Target
@@ -44,6 +44,7 @@ _QISKIT_IQM_GATE_MAP: dict[str, Gate] = {
     "cz": CZGate(),
     "move": MoveGate(),
     "id": IGate(),
+    "if_else": IfElseOp,
 }
 """Maps IQM native operation names to corresponding Qiskit gate objects."""
 
@@ -126,8 +127,13 @@ class IQMTarget(Target):
         if "prx" in op_loci:
             add_gate("prx")
 
-        # HACK reset gate shares cc_prx loci for now, until reset is also in the DQA/metrics
         if "cc_prx" in op_loci:
+            # IfElseOp is a global 'gate' so it's slightly different from the others.
+            self.add_instruction(
+                instruction=_QISKIT_IQM_GATE_MAP["if_else"],
+                name="if_else",
+            )
+            # HACK reset gate shares cc_prx loci for now, until reset is also in the DQA/metrics
             self.add_instruction(
                 _QISKIT_IQM_GATE_MAP["reset"],
                 {self.locus_to_idx(locus): None for locus in op_loci["cc_prx"]},