iqm-client 28.0.0__tar.gz → 29.1.0__tar.gz

{iqm_client-28.0.0 → iqm_client-29.1.0}/CHANGELOG.rst

@@ -2,6 +2,40 @@
 Changelog
 =========
 
+Version 29.1.0 (2025-06-30)
+===========================
+
+Bug fixes
+---------
+
+- Add job id to APITimeoutError
+
+Version 29.0.0 (2025-06-13)
+===========================
+
+Features
+--------
+
+- Major :class:`IQMClient` refactoring. Many methods now use :class:`StationControlClient` internally to retrieve the data,
+  instead of using direct HTTP requests to REST API. This work is going to continue in the future, and the end goal
+  is to remove all HTTP logic from :class:`IQMClient` and handle HTTP requests/responses only in :class:`StationControlClient`.
+  :issue:`SW-1084`
+
+Breaking Changes
+----------------
+
+- Remove :class:`APIVariant` from :class:`IQMClient`, it will support only one version at any given time from now on.
+  Upgrade/downgrade software if you want to use different versions of :class:`IQMClient`. :issue:`SW-1084`
+- You may have to pass a different `url` to :class:`IQMClient` than before:
+  - If you previously used :class:`APIVariant.V1`, you typically need to change `/cocos` to `/station` in the URL.
+  - If you previously used :class:`APIVariant.V2`, you typically need to add `/station` to the URL.
+  - If you previously used :class:`APIVariant.RESONANCE_COCOS_V1`, no changes are needed to the URL.
+- Support for ``timeout_secs`` parameter has been dropped from some methods (:meth:`get_static_quantum_architecture`,
+  :meth:`get_quality_metric_set`, :meth:`get_calibration_set`, :meth:`get_dynamic_quantum_architecture`, :meth:`get_feedback_groups`).
+  :class:`IQMClient` uses :class:`StationControlClient` to retrieve the data now instead of HTTP requests directly, and we have no
+  plans to support different request timeout for each endpoint separately in :class:`StationControlClient`. Instead, all
+  endpoints uses the same timeout which is currently set to default 120 seconds.
+
 Version 28.0.0 (2025-06-12)
 ===========================
 

{iqm_client-28.0.0 → iqm_client-29.1.0}/INTEGRATION_GUIDE.rst

@@ -22,7 +22,7 @@ requires only the URL of the IQM quantum computer.
 
     from iqm.iqm_client import IQMClient
 
-    server_url = "https://IQM_SERVER_URL"
+    server_url = "https://STATION_CONTROL_URL"
 
     iqm_client = IQMClient(server_url)
 

{iqm_client-28.0.0/src/iqm_client.egg-info → iqm_client-29.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-client
-Version: 28.0.0
+Version: 29.1.0
 Summary: Client library for accessing an IQM quantum computer
 Author-email: IQM Finland Oy <developers@meetiqm.com>
 License:                                  Apache License
@@ -216,19 +216,27 @@ Requires-Python: <3.13,>=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 License-File: AUTHORS.rst
+Requires-Dist: iqm-station-control-client<10,>=9
+Requires-Dist: iqm-exa-common<27,>=26
 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
 Provides-Extra: cirq
+Requires-Dist: iqm-station-control-client<10,>=9; extra == "cirq"
+Requires-Dist: iqm-exa-common<27,>=26; extra == "cirq"
 Requires-Dist: cirq-core[contrib]~=1.2; extra == "cirq"
 Requires-Dist: ply==3.11; extra == "cirq"
 Provides-Extra: cli
+Requires-Dist: iqm-station-control-client<10,>=9; extra == "cli"
+Requires-Dist: iqm-exa-common<27,>=26; extra == "cli"
 Requires-Dist: click<9,>=8.1.6; extra == "cli"
 Requires-Dist: jsonschema>=4.6.0; extra == "cli"
 Requires-Dist: psutil>=5.9.2; extra == "cli"
 Requires-Dist: python-daemon>=2.3.0; extra == "cli"
 Provides-Extra: qiskit
+Requires-Dist: iqm-station-control-client<10,>=9; extra == "qiskit"
+Requires-Dist: iqm-exa-common<27,>=26; extra == "qiskit"
 Requires-Dist: qiskit<1.3,>=1.0; extra == "qiskit"
 Requires-Dist: qiskit-aer<0.16,>=0.13.1; extra == "qiskit"
 

{iqm_client-28.0.0 → iqm_client-29.1.0}/docs/user_guide_qiskit.rst

@@ -177,14 +177,6 @@ circuit(s) are sampled:
    `Inspecting circuits before submitting them for execution`_ for inspecting the actual run request sent for
    execution.
 
-.. note::
-
-   IQM Client is transitioning from server-side API ``V1`` to a new ``V2``.
-   You may see a deprecation warning in the terminal. You can ignore it; when ``V2`` becomes the default, 
-   Qiskit-on-IQM will transparently start using it. Alternatively, you can set an environment variable
-   ``IQM_CLIENT_API_VARIANT`` to value ``V2`` and change the backend URL (normally, this means removing
-   the ``/cocos`` part from the url). The choice of the API version does not affect the use of Qiskit-on-IQM.
-
 You can optionally provide IQMBackend specific options as additional keyword arguments to
 :meth:`.IQMBackend.run`, documented at :meth:`.IQMBackend.create_run_request`.
 For example, you can enable heralding measurements using ``circuit_compilation_options`` as follows:

iqm_client-29.1.0/requirements/base.txt

@@ -0,0 +1,6 @@
+iqm-station-control-client>=9,<10
+iqm-exa-common>=26,<27
+numpy >= 1.26.4, < 3.0
+packaging == 24.1
+pydantic >= 2.9.2, <3.0
+requests == 2.32.3

iqm_client-29.1.0/requirements/cirq.txt

@@ -0,0 +1,4 @@
+iqm-station-control-client>=9,<10
+iqm-exa-common>=26,<27
+cirq-core[contrib] ~= 1.2
+ply == 3.11

iqm_client-29.1.0/requirements/cli.txt

@@ -0,0 +1,6 @@
+iqm-station-control-client>=9,<10
+iqm-exa-common>=26,<27
+click >= 8.1.6, < 9
+jsonschema >= 4.6.0
+psutil >= 5.9.2
+python-daemon >= 2.3.0

iqm_client-29.1.0/requirements/qiskit.txt

@@ -0,0 +1,4 @@
+iqm-station-control-client>=9,<10
+iqm-exa-common>=26,<27
+qiskit >= 1.0, < 1.3
+qiskit-aer >= 0.13.1, < 0.16

{iqm_client-28.0.0 → iqm_client-29.1.0}/src/iqm/cirq_iqm/examples/demo_iqm_execution.py

@@ -13,13 +13,13 @@
 # limitations under the License.
 """Demonstrates executing a quantum circuit on an IQM quantum computer.
 
-Set the IQM_SERVER_URL environment variable before running this script.
+Set the STATION_CONTROL_URL environment variable before running this script.
 Also, if the server you are running against requires authentication you will also have to set
 IQM_AUTH_SERVER, and either IQM_TOKENS_FILE or both of IQM_AUTH_USERNAME and IQM_AUTH_PASSWORD.
 
 E.g.
 
-    export IQM_SERVER_URL="https://example.com/cocos"
+    export STATION_CONTROL_URL="https://example.com/station"
     export IQM_AUTH_SERVER="https://example.com/auth"
     export IQM_TOKENS_FILE="/path/to/my/tokens.json"
 """
@@ -45,7 +45,7 @@ def demo_run_circuit() -> None:
     print("Original circuit:\n")
     print(circuit)
 
-    sampler = IQMSampler(os.environ["IQM_SERVER_URL"])
+    sampler = IQMSampler(os.environ["STATION_CONTROL_URL"])
 
     circuit_routed, _, _ = sampler.device.route_circuit(circuit)
     circuit_decomposed = sampler.device.decompose_circuit(circuit_routed)

iqm_client-29.1.0/src/iqm/iqm_client/api.py

@@ -0,0 +1,90 @@
+# Copyright 2024 IQM client developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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 module contains definitions of IQM Server API endpoints."""
+
+from enum import Enum, auto
+from posixpath import join
+
+
+class APIEndpoint(Enum):
+    """Supported API endpoints."""
+
+    GET_JOB_RESULT = auto()
+    GET_JOB_REQUEST_PARAMETERS = auto()
+    GET_JOB_CALIBRATION_SET_ID = auto()
+    GET_JOB_CIRCUITS_BATCH = auto()
+    GET_JOB_ERROR_LOG = auto()
+    SUBMIT_JOB = auto()
+    GET_JOB_COUNTS = auto()
+    GET_JOB_STATUS = auto()
+    GET_JOB_TIMELINE = auto()
+    ABORT_JOB = auto()
+
+
+class APIConfig:
+    """Provides supported API endpoints for a given API variant."""
+
+    def __init__(self, station_control_url: str):
+        """Args:
+        station_control_url: URL of the IQM server,
+            e.g. https://test.qc.iqm.fi/station or https://cocos.resonance.meetiqm.com/garnet
+
+        """
+        self.station_control_url = station_control_url
+        self.urls = self._get_api_urls()
+
+    @staticmethod
+    def _get_api_urls() -> dict[APIEndpoint, str]:
+        """Returns:
+        Relative URLs for each supported API endpoints.
+
+        """
+        return {
+            # TODO SW-1434: Use StationControlClient methods for communication instead of REST endpoints
+            APIEndpoint.GET_JOB_RESULT: "jobs/%s/measurements",
+            APIEndpoint.GET_JOB_REQUEST_PARAMETERS: "jobs/%s/request_parameters",
+            APIEndpoint.GET_JOB_CALIBRATION_SET_ID: "jobs/%s/calibration_set_id",
+            APIEndpoint.GET_JOB_CIRCUITS_BATCH: "jobs/%s/circuits_batch",
+            APIEndpoint.GET_JOB_ERROR_LOG: "jobs/%s/error_log",
+            APIEndpoint.SUBMIT_JOB: "circuits",
+            APIEndpoint.GET_JOB_COUNTS: "circuits/%s/counts",
+            APIEndpoint.GET_JOB_STATUS: "jobs/%s/status",
+            APIEndpoint.GET_JOB_TIMELINE: "jobs/%s/timeline",
+            APIEndpoint.ABORT_JOB: "jobs/%s/abort",
+        }
+
+    def is_supported(self, endpoint: APIEndpoint) -> bool:
+        """Args:
+            endpoint: API endpoint.
+
+        Returns:
+            True if the endpoint is supported, False otherwise.
+
+        """
+        return endpoint in self.urls
+
+    def url(self, endpoint: APIEndpoint, *args) -> str:
+        """Args:
+            endpoint: API endpoint.
+            args: Arguments to be passed to the URL.
+
+        Returns:
+            URL for the given endpoint.
+
+        Raises:
+            ValueError: If the endpoint is not supported.
+
+        """
+        url = self.urls.get(endpoint)
+        return join(self.station_control_url, url % args)

{iqm_client-28.0.0 → iqm_client-29.1.0}/src/iqm/iqm_client/authentication.py

@@ -300,7 +300,7 @@ class TokenClient(TokenProviderInterface):
         if access_token is None:
             # Failed to get valid access token using username and password, raise an error
             raise ClientAuthenticationError("Getting access token from auth server failed")
-        return str(access_token)  # acces token can not be None here
+        return str(access_token)  # access token can not be None here
 
     def close(self) -> None:
         """Close authentication session"""