iqm-client 33.0.0__py3-none-any.whl → 33.0.2__py3-none-any.whl

iqm/iqm_server_client/iqm_server_client.py

@@ -31,7 +31,6 @@ from urllib.parse import urlparse
 from uuid import UUID
 import warnings
 
-from iqm.iqm_server_client.errors import ClientConfigurationError
 from iqm.iqm_server_client.models import (
     CalibrationSet,
     JobData,
@@ -48,7 +47,7 @@ import requests
 
 from exa.common.data.setting_node import SettingNode
 from exa.common.errors.station_control_errors import map_from_status_code_to_error
-from iqm.station_control.client.authentication import TokenManager
+from iqm.station_control.client.authentication import ClientConfigurationError, TokenManager
 from iqm.station_control.client.list_models import (
     DutList,
     ListModel,

iqm/qiskit_iqm/examples/bell_measure.py

@@ -13,8 +13,8 @@
 # limitations under the License.
 """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
+See the Qiskit on IQM user guide for instructions, found in the documentation at
+https://docs.meetiqm.com/iqm-client/
 """
 
 import argparse
@@ -72,7 +72,7 @@ if __name__ == "__main__":
         "--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
+        # following the Qiskit user guide at https://docs.meetiqm.com/iqm-client/
     )
 
     args = argparser.parse_args()

iqm/qiskit_iqm/examples/transpile_example.py

@@ -12,8 +12,10 @@
 # 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 an IQM quantum
-computer. See the Qiskit on IQM user guide for instructions:
-https://docs.meetiqm.com/iqm-client/user_guide_qiskit.html
+computer.
+
+See the Qiskit on IQM user guide for instructions, found in the documentation at
+https://docs.meetiqm.com/iqm-client/
 """
 
 import argparse

iqm/qiskit_iqm/iqm_job.py

@@ -30,7 +30,7 @@ from iqm.iqm_client import (
 from iqm.iqm_client import (
     JobStatus as IQMJobStatus,
 )
-from iqm.iqm_client.errors import APITimeoutError
+from iqm.iqm_client.errors import APITimeoutError, CircuitExecutionError
 from iqm.qiskit_iqm.qiskit_to_iqm import MeasurementKey
 import numpy as np
 from qiskit.providers import JobStatus, JobV1
@@ -147,7 +147,7 @@ class IQMJob(JobV1):
             for s in range(shots)
         ]
 
-    def submit(self):  # noqa: ANN201
+    def submit(self) -> None:
         raise NotImplementedError(
             "You should never have to submit jobs by calling this method. When running circuits through "
             "RemoteIQMBackend, the submission will happen under the hood. The job instance that you get is only for "
@@ -183,10 +183,11 @@ class IQMJob(JobV1):
 
         """
         job = self._iqm_job
-        # TODO we might want to cache these
+        # TODO we might want to cache these as well
         circuits, job_parameters = job.payload()
+
+        # wait for job to finish if it hasn't already
         if job.status not in IQMJobStatus.terminal_statuses():
-            # wait for job to finish and cache the result
             status = job.wait_for_completion(timeout_secs=timeout)
             if status not in IQMJobStatus.terminal_statuses():
                 msg = f"The job {job.job_id} didn't finish in {timeout} seconds."
@@ -196,9 +197,29 @@ class IQMJob(JobV1):
                     msg += " Cancelled."
                 raise APITimeoutError(msg)
 
-            # retrieve the results if job completed successfully
-            if status == IQMJobStatus.COMPLETED and (result_batch := job.result()) is not None:
-                # now job has up-to-date information
+        # job has reached a terminal status, which means no status update is necessary, and we can return a Result
+        result_dict: dict[str, Any] = {
+            "backend_name": self.backend().name,
+            "backend_version": "",
+            "qobj_id": "",
+            "job_id": str(job.job_id),
+            "success": False,
+            "date": date.today().isoformat(),
+            "results": [],
+            # the ones below go into result._metadata
+            "circuits": circuits,
+            "parameters": job_parameters,
+            "timeline": job.data.timeline.copy(),
+        }
+
+        # try to return results if job completed successfully
+        if job.status == IQMJobStatus.COMPLETED:
+            if self._iqm_result is None:
+                # retrieve and cache the results
+                if (result_batch := job.result()) is None:
+                    raise CircuitExecutionError(
+                        f"No results were available for job {job.job_id} even though it is completed."
+                    )
                 # IQMBackend.run() populates IQMJob.circuit_metadata, so it may be None if this IQMJob
                 # was created manually from a job_id. In that case retrieve circuit metadata from
                 # the job payload which we just retrieved.
@@ -214,21 +235,7 @@ class IQMJob(JobV1):
                     job_parameters.heralding_mode == HeraldingMode.NONE,
                 )
 
-        # job has reached a terminal status, which means we can return a Result
-        result_dict: dict[str, Any] = {
-            "backend_name": self.backend().name,
-            "backend_version": "",
-            "qobj_id": "",
-            "job_id": str(job.job_id),
-            "success": False,
-            "date": date.today().isoformat(),
-            "results": [],
-            # the ones below go into result._metadata
-            "circuits": circuits,
-            "parameters": job_parameters,
-            "timeline": job.data.timeline.copy(),
-        }
-        if self._iqm_result:
+            # return the results
             result_dict["success"] = True  # job is successful iff it is IQMJobStatus.COMPLETED (and we got result data)
             result_dict["results"] = [
                 {

{iqm_client-33.0.0.dist-info → iqm_client-33.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-client
-Version: 33.0.0
+Version: 33.0.2
 Summary: Client library for accessing an IQM quantum computer
 Author-email: IQM Finland Oy <developers@meetiqm.com>
 License: Apache License
@@ -220,8 +220,8 @@ Requires-Dist: numpy <3.0,>=1.26.4
 Requires-Dist: packaging ==24.1
 Requires-Dist: pydantic <3.0,>=2.9.2
 Requires-Dist: requests ==2.32.3
-Requires-Dist: iqm-pulse
-Requires-Dist: iqm-station-control-client
+Requires-Dist: iqm-pulse <13,>=12.7.2
+Requires-Dist: iqm-station-control-client <13,>=12.0.2
 Provides-Extra: cirq
 Requires-Dist: cirq-core[contrib] ~=1.2 ; extra == 'cirq'
 Requires-Dist: ply ==3.11 ; extra == 'cirq'
@@ -250,16 +250,15 @@ adapters for `IQM's <https://www.meetiqm.com>`_ quantum computers, which allow y
   (currently only the Qiskit adapter contains IQM noise models)
 * Run quantum circuits on an IQM quantum computer
 
-Also includes a `CLI utility <https://docs.meetiqm.com/iqm-client/user_guide_cli.html>`_ for managing user
-authentication when using IQM quantum computers.
+Also includes a CLI utility for managing user authentication when using IQM quantum computers.
 
 Installation
 ============
 
-For executing code on an IQM quantum computer, you can use for example
-`Qiskit on IQM <https://docs.meetiqm.com/iqm-client/user_guide_qiskit.html>`_ or
-`Cirq on IQM <https://docs.meetiqm.com/iqm-client/user_guide_cirq.html>`_, which can be installed as optional
-features of IQM Client from the Python Package Index (PyPI), e.g.:
+For executing code on an IQM quantum computer, you can use for example the
+Qiskit on IQM or Cirq on IQM user guides found in the documentation.
+Qiskit on IQM and Cirq on IQM are optional features that can be installed alongside the base IQM Client library.
+An example showing how to install from the public Python Package Index (PyPI):
 
 .. code-block:: bash
 
@@ -271,8 +270,7 @@ features of IQM Client from the Python Package Index (PyPI), e.g.:
     Python environment, you should first uninstall them with ``$ pip uninstall qiskit-iqm cirq-iqm``.
     In this case, you should also include the ``--force-reinstall`` option in the ``iqm-client`` installation command.
 
-The `CLI utility <https://docs.meetiqm.com/iqm-client/user_guide_cli.html>`_ for managing user authentication can also
-be installed as an optional feature:
+The CLI utility for managing user authentication can also be installed as an optional feature:
 
 .. code-block:: bash
 
@@ -294,10 +292,15 @@ Documentation
 
 Documentation for the latest version is `available online <https://docs.meetiqm.com/iqm-client/>`_.
 You can build documentation for any older version locally by downloading the corresponding package from PyPI,
-and running the docs builder. For versions 20.12 and later this is done by running ``./docbuild`` in the
-``iqm-client`` root directory, and for earlier versions by running ``tox run -e docs``.
+and running the docs builder. For versions greater than equal to 20.12 but less than 33.0.0 this is done by
+running ``./docbuild`` in the ``iqm-client`` root directory, and for earlier versions by running ``tox run -e docs``.
 
 ``./docbuild`` or ``tox run -e docs`` will build the documentation at ``./build/sphinx/html``.
+
+Versions greater than or equal to 33.0.0 use the command:
+``sphinx-build -q -d build/.doctrees/iqm-client iqm-client/docs build/docs/iqm-client``
+(``build/docs/`` directory has to be created first).
+
 These commands require installing the ``sphinx`` and ``sphinx-book-theme`` Python packages and
 `graphviz <https://graphviz.org/>`_.
 

{iqm_client-33.0.0.dist-info → iqm_client-33.0.2.dist-info}/RECORD

@@ -26,15 +26,14 @@ iqm/iqm_client/transpile.py,sha256=ZicsOJiT5zEaaYMWuFddnJT2e4e9Oyu7B5pO8Z_ah7M,3
 iqm/iqm_client/util.py,sha256=obzh1g6PNEXOj7k3gUkiylNUhyqutbWlxlEpfyyU_fk,1505
 iqm/iqm_client/validation.py,sha256=SyshUOxmnlwb0haWEAVkgynGOYUMV7Os281sUe29tpE,12621
 iqm/iqm_server_client/__init__.py,sha256=hqfe65DmdYu5qDbYsg3Uq94DRe2zkbMJP_XFYsMbGSQ,645
-iqm/iqm_server_client/errors.py,sha256=I48dRY_Sies2vQzyjzQxhHm_J5RopyL5hqAmlnBy67w,192
-iqm/iqm_server_client/iqm_server_client.py,sha256=en2C4hZ4VzHtg07EtxpuC-cFEw2kzTi1_GzfYKk-NWY,31365
+iqm/iqm_server_client/iqm_server_client.py,sha256=ROcz3sCg4smAyB1vzxAU00BxuYTf0getcz8SEc8Fx04,31325
 iqm/iqm_server_client/models.py,sha256=YpyppxEu2obSIaUvuc3_mRKcGscs8YLrcWrTk7EHKzM,5597
 iqm/iqm_server_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 iqm/qiskit_iqm/__init__.py,sha256=VPmcMV5nBOEIhVsOceIUkdZtWJ3tGlaKrDFP-FRuOCs,1667
 iqm/qiskit_iqm/iqm_backend.py,sha256=3ydSroylh_Us-5RJfOQgOkL7eqF4fWe5ejXueDTcAj8,5584
 iqm/qiskit_iqm/iqm_circuit.py,sha256=jaPo3zc5FC0vAIumh5d56fr44fDaJXXwcquBzQEy1Yg,1400
 iqm/qiskit_iqm/iqm_circuit_validation.py,sha256=SzfCJclUh1kK6Kcz5puKlCtE0hZfWxYYKF35EagU204,1750
-iqm/qiskit_iqm/iqm_job.py,sha256=SdyZeQi5CoGxBeJyfIvOM7DA0ONJ5tbTHpk4hajpUFk,12395
+iqm/qiskit_iqm/iqm_job.py,sha256=K-gM3fWYmpVh8e7inljn17sofpyf0YMyPyENuwAzSpE,12675
 iqm/qiskit_iqm/iqm_move_layout.py,sha256=vFdba0DStu8Pebi3qxZBYOLCYC2Atl28YlSzbSGER4Y,10557
 iqm/qiskit_iqm/iqm_naive_move_pass.py,sha256=GcS2DyYWwG-qMyczXqTXxMxNqRB4IVeWNP3CzguKpBw,15639
 iqm/qiskit_iqm/iqm_provider.py,sha256=pK1CcAOQKG5jXYfjxshuVSmMLWQG1-k0cyghRmGpWN8,19273
@@ -45,8 +44,8 @@ iqm/qiskit_iqm/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 iqm/qiskit_iqm/qiskit_to_iqm.py,sha256=imMmuOi_tuujIrGzBFnGOtxpGHcIkncXutr5QFekJl4,20677
 iqm/qiskit_iqm/transpiler_plugins.py,sha256=BrCkUFQUdi0m8K8V0ERYgtPAkvoX4VlYIJwnFKyCN9Q,8831
 iqm/qiskit_iqm/examples/__init__.py,sha256=M4ElQHCo-WxtVXK39bF3QiFT3IGXPtZ1khqexHiTBEc,20
-iqm/qiskit_iqm/examples/bell_measure.py,sha256=-20oihBKuK4s9rA_9fuyJBM3Du8NWZUTZ8YhI3Q4TpM,3064
-iqm/qiskit_iqm/examples/transpile_example.py,sha256=vGcs2OpsYTVcWyX-qzmfjio4JcIBi_Dk-hrQRGO4oGs,2401
+iqm/qiskit_iqm/examples/bell_measure.py,sha256=pwSGeggb8HuUWh4SYUkbLDeZI00gxRmVw0svA_hbn-Y,3056
+iqm/qiskit_iqm/examples/transpile_example.py,sha256=FNpHy6nxJgaXhgbl7_SavHRNaNMyk4lSkd_0a2GSKh4,2410
 iqm/qiskit_iqm/fake_backends/__init__.py,sha256=fkw2UHT-3aJbAKvR1WYUN7_4N5Gdwpx9bm6vlWj1tm0,874
 iqm/qiskit_iqm/fake_backends/fake_adonis.py,sha256=DWftCPu6ElE4P47Z-y3bojg0unDJ6F5ur2aDqfoY85s,2248
 iqm/qiskit_iqm/fake_backends/fake_aphrodite.py,sha256=oB5wFtZ2VYy0TxoL-eBgYnVAwamGPYlzIQK89npwQUg,15533
@@ -54,10 +53,10 @@ iqm/qiskit_iqm/fake_backends/fake_apollo.py,sha256=C05u3knnCsA8DCuWU31EwUvJ6xile
 iqm/qiskit_iqm/fake_backends/fake_deneb.py,sha256=HstlV-PSbyCttY1uEyWr-YgsMNkv9Ntf6zffav837_4,3216
 iqm/qiskit_iqm/fake_backends/fake_garnet.py,sha256=GI0xafTCj1Um09qVuccO6GPOGBm6ygul_O40Wu220Ys,5555
 iqm/qiskit_iqm/fake_backends/iqm_fake_backend.py,sha256=IfVKxlPlAVCHTgli2scRP1gkVCXIiSuL6-QjjsZp83Q,16808
-iqm_client-33.0.0.dist-info/AUTHORS.rst,sha256=qsxeK5A3-B_xK3hNbhFHEIkoHNpo7sdzYyRTs7Bdtm8,795
-iqm_client-33.0.0.dist-info/LICENSE.txt,sha256=2DXrmQtVVUV9Fc9RBFJidMiTEaQlG2oAtlC9PMrEwTk,11333
-iqm_client-33.0.0.dist-info/METADATA,sha256=7caTuL76eOR8Gh87dPMW9WpRecywAmFiss3E6T8Pe9Q,17290
-iqm_client-33.0.0.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
-iqm_client-33.0.0.dist-info/entry_points.txt,sha256=Kk2qfRwk8vbIJ7qCAvmaUogfRRn6t92_hBFhe6kqAE4,1317
-iqm_client-33.0.0.dist-info/top_level.txt,sha256=NB4XRfyDS6_wG9gMsyX-9LTU7kWnTQxNvkbzIxGv3-c,4
-iqm_client-33.0.0.dist-info/RECORD,,
+iqm_client-33.0.2.dist-info/AUTHORS.rst,sha256=qsxeK5A3-B_xK3hNbhFHEIkoHNpo7sdzYyRTs7Bdtm8,795
+iqm_client-33.0.2.dist-info/LICENSE.txt,sha256=2DXrmQtVVUV9Fc9RBFJidMiTEaQlG2oAtlC9PMrEwTk,11333
+iqm_client-33.0.2.dist-info/METADATA,sha256=HTAgR7k_oF95p7vDuoIYkcW4hvfSXPiSU2wYhuCt7Q8,17435
+iqm_client-33.0.2.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
+iqm_client-33.0.2.dist-info/entry_points.txt,sha256=Kk2qfRwk8vbIJ7qCAvmaUogfRRn6t92_hBFhe6kqAE4,1317
+iqm_client-33.0.2.dist-info/top_level.txt,sha256=NB4XRfyDS6_wG9gMsyX-9LTU7kWnTQxNvkbzIxGv3-c,4
+iqm_client-33.0.2.dist-info/RECORD,,

iqm/iqm_server_client/errors.py

@@ -1,6 +0,0 @@
-class ClientAuthenticationError(RuntimeError):
-    """Something went wrong with user authentication."""
-
-
-class ClientConfigurationError(RuntimeError):
-    """Wrong configuration provided."""