iqm-client 31.5.0__tar.gz → 31.7.0__tar.gz

{iqm_client-31.5.0 → iqm_client-31.7.0}/CHANGELOG.rst

@@ -2,6 +2,22 @@
 Changelog
 =========
 
+Version 31.7.0 (2025-10-03)
+===========================
+
+Bug fixes
+---------
+
+- Skip following mypy imports to iqm-data-definitions until errors are fixed. :issue:`SW-1670`
+
+Version 31.6.0 (2025-10-01)
+===========================
+
+Features
+--------
+
+- Clarify the docs on IQM server URLS and facade backends.
+
 Version 31.5.0 (2025-09-30)
 ===========================
 

{iqm_client-31.5.0 → iqm_client-31.7.0}/PKG-INFO

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

{iqm_client-31.5.0 → iqm_client-31.7.0}/docs/user_guide_qiskit.rst

@@ -34,7 +34,9 @@ IQM Resonance
 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`)
-6. Run the Jupyter notebook (or run ``python resonance_example.py`` if you decided to go for the Python script).
+6. Run the Jupyter notebook (or run
+   ``python resonance_example.py --url https://cocos.resonance.meetiqm.com/<RESONANCE QC NAME>``
+   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
    set up correctly!
@@ -51,7 +53,7 @@ On-premises device
 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 --cortex_server_url https://demo.qc.iqm.fi/cocos`` - replace the example URL with the correct one.
+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!
@@ -153,7 +155,7 @@ circuit(s) are sampled:
     from qiskit import transpile
     from iqm.qiskit_iqm import IQMProvider
 
-    iqm_server_url = "https://demo.qc.iqm.fi"  # Replace this with the correct URL
+    iqm_server_url = "https://<IQM SERVER>"  # Replace this with the correct URL
     provider = IQMProvider(iqm_server_url)
     backend = provider.get_backend()
 
@@ -735,11 +737,22 @@ a copy of the IQMFakeBackend instance with an updated error profile:
 Running a quantum circuit on a facade backend
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Circuits can be executed against a mock environment: an IQM server that has no real quantum computer hardware.
-Results from such executions are random bits. This may be useful when developing and testing software integrations.
+Circuits can be executed against a *mock environment*: an IQM server that has no real quantum computer hardware.
+Results from such executions are just random bits. This may be useful when developing and testing software integrations.
 
-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.
+.. note::
+
+   IQM Resonance typically provides a mock environment for each real quantum computer it has.
+   For example, the URL
+   https://cocos.resonance.meetiqm.com/garnet refers to a real quantum computer named Garnet,
+   whereas https://cocos.resonance.meetiqm.com/garnet:mock refers to the corresponding mock environment.
+
+   On-premises users should ask their admin whether a mock environment is available, and which IQM server
+   URL to use.
+
+Qiskit on IQM contains :class:`.IQMFacadeBackend`, which allows to combine a 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 :meth:`IQMProvider.get_backend` with one of the backend names
 ``facade_adonis, facade_apollo, facade_aphrodite, facade_deneb`` or ``facade_garnet`` to obtain
@@ -747,11 +760,16 @@ a facade backend.
 ``facade_adonis, facade_apollo, facade_aphrodite`` represent typical Crystal 5, Crystal 20 and Crystal 54 architecture QPUs,
 whereas ``facade_deneb`` and  ``facade_garnet`` represent the corresponding IQM Resonance quantum computers
 more specifically.
-
-Note that the provider must be initialized with the URL of a quantum computer with the corresponding
+The provider must be initialized with the URL of a quantum computer with the corresponding
 static quantum 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 server rather than a real quantum computer, as the execution results
-from the server will be discarded and replaced by a simulated result generated by Qiskit Aer.
+
+.. important::
+
+   When using a facade backend, the IQM server URL of :class:`IQMProvider` should always point to a mock environment
+   rather than a real quantum computer, as the execution results from the server will be discarded and replaced by
+   a locally simulated result generated by Qiskit Aer. If you use a real quantum computer with a facade backend,
+   you will just waste your credits and/or computation time.
+
 
 .. code-block:: python
 
@@ -763,9 +781,9 @@ from the server will be discarded and replaced by a simulated result generated b
     circuit.cx(0, 1)
     circuit.measure_all()
 
-    iqm_server_url = "https://demo.qc.iqm.fi/"  # Replace this with the correct URL
+    iqm_server_url = "https://cocos.resonance.meetiqm.com/garnet:mock"  # Replace this with the correct mock env URL
     provider = IQMProvider(iqm_server_url)
-    backend = provider.get_backend('facade_adonis')
+    backend = provider.get_backend('facade_garnet')
     transpiled_circuit = transpile(circuit, backend=backend)
     job = backend.run(transpiled_circuit, shots=1000)
     print(job.result().get_counts())

{iqm_client-31.5.0 → iqm_client-31.7.0}/pyproject.toml

@@ -29,9 +29,14 @@ explicit_package_bases = true
 mypy_path = "$MYPY_CONFIG_FILE_DIR/src"
 namespace_packages = true
 [[tool.mypy.overrides]]
-module = [ "iqm.data_definitions.*", "iqm.models.*", "daemon.*", "quimb.*", "qiskit.*", "qiskit_aer.*", "grpc.*", "lmfit.*", "emukit.*", "mockito.*", "sklearn.*", "dill.*", "uncertainties.*", "GPy.*", "pythonjsonlogger.*",]
+module = [ "daemon.*", "quimb.*", "qiskit.*", "qiskit_aer.*", "grpc.*", "lmfit.*", "emukit.*", "mockito.*", "sklearn.*", "dill.*", "uncertainties.*", "GPy.*", "pythonjsonlogger.*",]
 ignore_missing_imports = true
 
+[[tool.mypy.overrides]]
+module = [ "iqm.data_definitions.*", "iqm.models.*",]
+follow_imports = "skip"
+follow_imports_for_stubs = true
+
 [tool.ruff]
 exclude = [ "*.ipynb", "*.rst",]
 extend-include = [ "sub-setup-py.template",]

{iqm_client-31.5.0 → iqm_client-31.7.0}/src/iqm/qiskit_iqm/examples/bell_measure.py

@@ -47,8 +47,9 @@ def bell_measure(server_url: str) -> dict[str, int]:
 if __name__ == "__main__":
     argparser = argparse.ArgumentParser()
     argparser.add_argument(
-        "--cortex_server_url",
-        help="URL of the IQM server",
-        default="https://demo.qc.iqm.fi/cocos",
+        "--url",
+        help="IQM server URL",
+        # For example https://cocos.resonance.meetiqm.com/garnet
+        default="https://<IQM SERVER>",
     )
-    print(bell_measure(argparser.parse_args().cortex_server_url))
+    print(bell_measure(argparser.parse_args().url))

{iqm_client-31.5.0 → iqm_client-31.7.0}/src/iqm/qiskit_iqm/examples/resonance_example.py

@@ -68,7 +68,7 @@ if __name__ == "__main__":
         "--url",
         help="URL of the IQM Resonance QC",
         # For example https://cocos.resonance.meetiqm.com/garnet
-        default="https://cocos.resonance.meetiqm.com/<QUANTUM COMPUTER>",
+        default="https://cocos.resonance.meetiqm.com/<RESONANCE QC NAME>",
     )
     argparser.add_argument(
         "--token",

{iqm_client-31.5.0 → iqm_client-31.7.0}/src/iqm/qiskit_iqm/examples/transpile_example.py

@@ -51,8 +51,9 @@ if __name__ == "__main__":
     argparser = argparse.ArgumentParser()
     argparser.add_argument(
         "--url",
-        help="URL of the IQM service",
-        default="https://cocos.resonance.meetiqm.com/deneb",
+        help="IQM server URL",
+        # For example https://cocos.resonance.meetiqm.com/garnet
+        default="https://<IQM SERVER>",
     )
     circuit_transpiled, results = transpile_example(argparser.parse_args().url)
     print(circuit_transpiled)

{iqm_client-31.5.0 → iqm_client-31.7.0}/src/iqm/qiskit_iqm/iqm_provider.py

@@ -289,16 +289,20 @@ facade_names: dict[str, IQMFakeBackend] = {
 
 
 class IQMFacadeBackend(IQMBackend):
-    """Simulates the execution of quantum circuits on a mock IQM quantum computer.
+    """Simulates locally the execution of quantum circuits on a remote 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 broadly representative of the mocked QPU. Finally returns the *simulated results*.
+    This backend is meant to be used to run circuits on a mock IQM server that has no real quantum hardware,
+    and if the mock execution is successful, simulate the circuits locally using an error model that
+    is broadly representative of the mocked QPU. Finally it returns the *simulated results*.
 
-    .. note::
+    If you just want to run a local simulation, use :class:`.IQMFakeBackend` directly.
 
-       There is usually no point in using a facade backend with a real quantum computer, since the computation
-       results will be replaced with a local simulation.
+    .. important::
+
+       When using a facade backend, the IQM server URL of :class:`IQMProvider` should always point to a mock environment
+       rather than a real quantum computer, as the execution results from the server will be discarded and replaced by
+       a locally simulated result generated by Qiskit Aer. If you use a real quantum computer with a facade backend,
+       you will just waste your credits and/or computation time.
 
     Args:
         client: Client instance for communicating with an IQM server.

{iqm_client-31.5.0 → iqm_client-31.7.0}/src/iqm_client.egg-info/PKG-INFO

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

iqm_client-31.7.0/version.txt

@@ -0,0 +1 @@
+31.7.0

iqm_client-31.5.0/version.txt

@@ -1 +0,0 @@
-31.5.0