iqm-client 31.7.0__py3-none-any.whl → 32.0.0__py3-none-any.whl

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/iqm_client/models.py

@@ -390,6 +390,9 @@ class StaticQuantumArchitecture(BaseModel):
     including the names of its computational components and the connections between them.
     """
 
+    # Optional *for now* (backwards compatible)
+    dut_label: str | None = None
+    """Identifies the QPU."""
     qubits: list[str] = Field(...)
     """Names of the physical qubits on the QPU, sorted."""
     computational_resonators: list[str] = Field(...)

iqm/qiskit_iqm/examples/bell_measure.py

@@ -11,8 +11,9 @@
 # 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 an IQM quantum
-computer. See the Qiskit on IQM user guide for instructions:
+"""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
 """
 
@@ -22,34 +23,58 @@ from iqm.qiskit_iqm.iqm_provider import IQMProvider
 from qiskit import QuantumCircuit, transpile
 
 
-def bell_measure(server_url: str) -> dict[str, int]:
-    """Run a circuit that prepares and measures a Bell state.
+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 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.
 
     """
-    backend = IQMProvider(server_url).get_backend()
+    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=token).get_backend()
     if backend.num_qubits < 2:
         raise ValueError("We need two qubits for the Bell state.")
-    circuit = QuantumCircuit(2)
-    circuit.h(0)
-    circuit.cx(0, 1)
-    circuit.measure_all()
 
-    new_circuit = transpile(circuit, backend)
-    return backend.run(new_circuit, shots=1000).result().get_counts()
+    # 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 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, n_qubits):
+        qc.cx(0, qb)
+    qc.barrier()
+    qc.measure_all()
+
+    # Transpile the circuit
+    qc_transpiled = transpile(qc, backend)
+    print(qc_transpiled.draw(output="text"))
+
+    # Run the circuit
+    job = backend.run(qc_transpiled, shots=shots)
+    return job.result().get_counts()
 
 
 if __name__ == "__main__":
     argparser = argparse.ArgumentParser()
     argparser.add_argument(
-        "--url",
-        help="IQM server URL",
-        # For example https://cocos.resonance.meetiqm.com/garnet
-        default="https://<IQM SERVER>",
+        "--url", required=True, help='IQM server URL, for example "https://cocos.resonance.meetiqm.com/garnet"'
     )
-    print(bell_measure(argparser.parse_args().url))
+    argparser.add_argument(
+        "--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
+    )
+
+    args = argparser.parse_args()
+    counts = bell_measure(args.url, args.token)
+    print(counts)

iqm/qiskit_iqm/fake_backends/fake_adonis.py

@@ -20,6 +20,7 @@ from iqm.qiskit_iqm.fake_backends.iqm_fake_backend import IQMErrorProfile, IQMFa
 def IQMFakeAdonis() -> IQMFakeBackend:
     """Return IQMFakeBackend instance representing IQM's Adonis architecture."""
     architecture = StaticQuantumArchitecture(
+        dut_label="M138_W0_A22_Z99",
         qubits=["QB1", "QB2", "QB3", "QB4", "QB5"],
         computational_resonators=[],
         connectivity=[("QB1", "QB3"), ("QB2", "QB3"), ("QB3", "QB4"), ("QB3", "QB5")],

iqm/qiskit_iqm/fake_backends/fake_aphrodite.py

@@ -20,6 +20,7 @@ from iqm.qiskit_iqm.fake_backends.iqm_fake_backend import IQMErrorProfile, IQMFa
 def IQMFakeAphrodite() -> IQMFakeBackend:
     """Return IQMFakeBackend instance representing IQM's Aphrodite architecture."""
     architecture = StaticQuantumArchitecture(
+        dut_label="M213_W0_H03_Z99",
         qubits=[f"QB{i}" for i in range(1, 55)],
         computational_resonators=[],
         connectivity=[

iqm/qiskit_iqm/fake_backends/fake_apollo.py

@@ -20,6 +20,7 @@ from iqm.qiskit_iqm.fake_backends.iqm_fake_backend import IQMErrorProfile, IQMFa
 def IQMFakeApollo() -> IQMFakeBackend:
     """Return IQMFakeBackend instance representing IQM's Apollo architecture."""
     architecture = StaticQuantumArchitecture(
+        dut_label="M153_W0_P06_Z99",
         qubits=[f"QB{i}" for i in range(1, 21)],
         computational_resonators=[],
         connectivity=[

iqm/qiskit_iqm/fake_backends/fake_deneb.py

@@ -20,6 +20,7 @@ from iqm.qiskit_iqm.fake_backends.iqm_fake_backend import IQMErrorProfile, IQMFa
 def IQMFakeDeneb() -> IQMFakeBackend:
     """Return IQMFakeBackend instance representing IQM's Deneb architecture."""
     architecture = StaticQuantumArchitecture(
+        dut_label="M139_W0_N60_Z99",
         qubits=["QB1", "QB2", "QB3", "QB4", "QB5", "QB6"],
         computational_resonators=["CR1"],
         connectivity=[

{iqm_client-31.7.0.dist-info → iqm_client-32.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-client
-Version: 31.7.0
+Version: 32.0.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.dist-info → iqm_client-32.0.0.dist-info}/RECORD

@@ -19,19 +19,14 @@ iqm/cirq_iqm/examples/demo_iqm_execution.py,sha256=I9hh1DfveBky-ngJlLmuxucIzlGtR
 iqm/cirq_iqm/examples/usage.ipynb,sha256=Kyfyu_MwqzTavHVNjgrWJo1tZPeJwTw7ExcU0MFYNRk,34208
 iqm/iqm_client/__init__.py,sha256=D-8W54EcQIxk_1JZo_86GYlR1YitHhPIiFwwLJ2IfGE,1411
 iqm/iqm_client/api.py,sha256=_c6OVuv2dyzBF7J2XlK_qxisTSPyOiI4gYokZPsuaJY,3083
-iqm/iqm_client/authentication.py,sha256=4V-rYUZKFMvMOVsroiKB61voHKX_6t7S847NDCdNbQE,7582
+iqm/iqm_client/authentication.py,sha256=VtndzZ-nxuaU7q2G8bXYctGThcTuFZW0PqMNE9k4OCA,7447
 iqm/iqm_client/errors.py,sha256=ty2P-sg80zlAoL3_kC3PlprgDUv4PI-KFhmmxaaapS0,1429
 iqm/iqm_client/iqm_client.py,sha256=oX_wu7aIJCdwc-DZy8iF43n4t7mphtp7ha5Ec38kOkM,41160
-iqm/iqm_client/models.py,sha256=hvnJYLOiycaXluWQgsip9CAnyb5l8i4xFYHt2qqUg7A,41831
+iqm/iqm_client/models.py,sha256=0i0jYI8G_mJlNGCbH9W89OBS3JeqbcD2n_kUcM1AqIs,41942
 iqm/iqm_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 iqm/iqm_client/transpile.py,sha256=2hDxQK8F4eMgpJC06XMIA8YbguFnRVNMlE1iKQNiTZk,37268
 iqm/iqm_client/util.py,sha256=obzh1g6PNEXOj7k3gUkiylNUhyqutbWlxlEpfyyU_fk,1505
 iqm/iqm_client/validation.py,sha256=GAe5GQAEXyplbmS_ioIRLR4fhCYKSranB0vE06qMfe8,12192
-iqm/iqm_client/cli/__init__.py,sha256=zzLDDz5rc3lJke3OKU8zxR5zQyQoM9oI2bLJ2YKk_zQ,692
-iqm/iqm_client/cli/auth.py,sha256=kESEK9-vpEhrjba3Lb6Wqx24yGfbjxUASeCArnVRYrw,6364
-iqm/iqm_client/cli/cli.py,sha256=vdhRJPKbqKRL0D_Z0uc3V73jQKKftAKE5Hx44oOCBwA,28689
-iqm/iqm_client/cli/models.py,sha256=Hu-t6c_07Cth3AuQBo0CDTcWVQg1xbJCpy_94V0o64U,1199
-iqm/iqm_client/cli/token_manager.py,sha256=125uRj8kBzKlWAhQWNf-8n-aDG6fQridVd95qCktzD4,6867
 iqm/qiskit_iqm/__init__.py,sha256=Mv9V_r8ZcmGC8Ke5S8-7yLOx02vjZ1qiVx8mtbOpwnY,1420
 iqm/qiskit_iqm/iqm_backend.py,sha256=HddizT6yHHq-MOG_U48n6ftE9AqmzaqbXYayEC1ljso,5548
 iqm/qiskit_iqm/iqm_circuit.py,sha256=jaPo3zc5FC0vAIumh5d56fr44fDaJXXwcquBzQEy1Yg,1400
@@ -47,20 +42,19 @@ iqm/qiskit_iqm/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 iqm/qiskit_iqm/qiskit_to_iqm.py,sha256=3Sm1gLELFLCLf6QiATZSiPzLzkjvzUakhU2N6KoBXC8,14948
 iqm/qiskit_iqm/transpiler_plugins.py,sha256=iuReGL42fCe5aOoH-KMUsb6t7Ok9qmIIj2S4yotJJ-U,8749
 iqm/qiskit_iqm/examples/__init__.py,sha256=M4ElQHCo-WxtVXK39bF3QiFT3IGXPtZ1khqexHiTBEc,20
-iqm/qiskit_iqm/examples/bell_measure.py,sha256=9ZuaAZybnEL9KhVom5P-mClQscyEF6k2dn6wV1QJaBQ,1925
-iqm/qiskit_iqm/examples/resonance_example.py,sha256=1byRYxoFRtQcOpWtTzGfCYVyOlwtJvdpFrGo_kMR8ng,2954
+iqm/qiskit_iqm/examples/bell_measure.py,sha256=vlayliApHU70a2zTnN_gs6iKSSdaB4Jip-iQHJNYN5M,3064
 iqm/qiskit_iqm/examples/transpile_example.py,sha256=cQmXXx3lqvmhgWYFK_U5HmHzMOKQqXUXPYfQhkyHH14,2135
 iqm/qiskit_iqm/fake_backends/__init__.py,sha256=fkw2UHT-3aJbAKvR1WYUN7_4N5Gdwpx9bm6vlWj1tm0,874
-iqm/qiskit_iqm/fake_backends/fake_adonis.py,sha256=g5QQ158vd49_SxzteDip97XMD3d50SJymx_rU7g7lzk,2188
-iqm/qiskit_iqm/fake_backends/fake_aphrodite.py,sha256=3oWZwPmtcsYkYpqVr36-C5K7KtyQGk84RCvZpaL_kLg,15473
-iqm/qiskit_iqm/fake_backends/fake_apollo.py,sha256=eT2vd3kQBi1rrvxCpePymBCfFK84dpwNpqGV_BkltwQ,6563
-iqm/qiskit_iqm/fake_backends/fake_deneb.py,sha256=RzQXmLXmBARDiMKVxk5Aw9fVbc6IYlW0A5jibk9iYD0,3156
+iqm/qiskit_iqm/fake_backends/fake_adonis.py,sha256=vdWaVB6Hsa-SYgMWuYBtRQH5x5Y1qVHvdomWT2bh5QQ,2225
+iqm/qiskit_iqm/fake_backends/fake_aphrodite.py,sha256=78KL0sONOtYKsWjPFGdc-uIxRUguncBbRQ9CP6bD_FQ,15510
+iqm/qiskit_iqm/fake_backends/fake_apollo.py,sha256=6YSaKtUc6zZ4m3iAREbmxL4tRs_DW0ulmZy2Sq7sPUc,6600
+iqm/qiskit_iqm/fake_backends/fake_deneb.py,sha256=_xpo_NJdu9t4ER8p5be-xTRmApkFY6kQw1UEGUPizk0,3193
 iqm/qiskit_iqm/fake_backends/fake_garnet.py,sha256=GI0xafTCj1Um09qVuccO6GPOGBm6ygul_O40Wu220Ys,5555
 iqm/qiskit_iqm/fake_backends/iqm_fake_backend.py,sha256=wJtfsxjPYbDKmzaz5R4AuaXvvPHa21WyPtRgNctL9eY,16785
-iqm_client-31.7.0.dist-info/AUTHORS.rst,sha256=qsxeK5A3-B_xK3hNbhFHEIkoHNpo7sdzYyRTs7Bdtm8,795
-iqm_client-31.7.0.dist-info/LICENSE.txt,sha256=2DXrmQtVVUV9Fc9RBFJidMiTEaQlG2oAtlC9PMrEwTk,11333
-iqm_client-31.7.0.dist-info/METADATA,sha256=fXhE5CAodK27QHf-tWtszTun9iSYKMcQUnkA1K0sCCo,17887
-iqm_client-31.7.0.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
-iqm_client-31.7.0.dist-info/entry_points.txt,sha256=Kk2qfRwk8vbIJ7qCAvmaUogfRRn6t92_hBFhe6kqAE4,1317
-iqm_client-31.7.0.dist-info/top_level.txt,sha256=NB4XRfyDS6_wG9gMsyX-9LTU7kWnTQxNvkbzIxGv3-c,4
-iqm_client-31.7.0.dist-info/RECORD,,
+iqm_client-32.0.0.dist-info/AUTHORS.rst,sha256=qsxeK5A3-B_xK3hNbhFHEIkoHNpo7sdzYyRTs7Bdtm8,795
+iqm_client-32.0.0.dist-info/LICENSE.txt,sha256=2DXrmQtVVUV9Fc9RBFJidMiTEaQlG2oAtlC9PMrEwTk,11333
+iqm_client-32.0.0.dist-info/METADATA,sha256=TNcHTh2I8F7zKgtU-Lh1QfNWpmUH1WwhO1SY0pJCyDo,17887
+iqm_client-32.0.0.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
+iqm_client-32.0.0.dist-info/entry_points.txt,sha256=Kk2qfRwk8vbIJ7qCAvmaUogfRRn6t92_hBFhe6kqAE4,1317
+iqm_client-32.0.0.dist-info/top_level.txt,sha256=NB4XRfyDS6_wG9gMsyX-9LTU7kWnTQxNvkbzIxGv3-c,4
+iqm_client-32.0.0.dist-info/RECORD,,

iqm/iqm_client/cli/__init__.py

@@ -1,14 +0,0 @@
-# Copyright 2021-2023 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.
-"""Command-line interface (CLI) for managing user authentication when using IQM quantum computers."""

iqm/iqm_client/cli/auth.py

@@ -1,168 +0,0 @@
-# Copyright 2021-2023 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.
-"""Authorization and session management for IQM Client CLI."""
-
-from base64 import b64decode
-from enum import Enum
-import json
-import time
-
-from pydantic import BaseModel, Field
-import requests
-
-REFRESH_MARGIN_SECONDS = 15
-AUTH_REQUESTS_TIMEOUT = 20
-
-
-class ClientAuthenticationError(RuntimeError):
-    """Something went wrong with user authentication."""
-
-
-class ClientAccountSetupError(RuntimeError):
-    """User's account has not been fully set up yet."""
-
-
-class GrantType(str, Enum):
-    """Type of token request."""
-
-    PASSWORD = "password"
-    REFRESH = "refresh_token"
-
-
-class AuthRequest(BaseModel):
-    """Request sent to authentication server for access token and refresh token, or for terminating the session.
-
-    * Token request with grant type ``'password'`` starts a new session in the authentication server.
-      It uses fields ``client_id``, ``grant_type``, ``username`` and ``password``.
-    * Token request with grant type ``'refresh_token'`` is used for maintaining an existing session.
-      It uses field ``client_id``, ``grant_type``, ``refresh_token``.
-    * Logout request uses only fields ``client_id`` and ``refresh_token``.
-    """
-
-    client_id: str = Field(...)
-    "name of the client for all request types"
-    grant_type: GrantType | None = Field(None)
-    "type of token request, in ``{'password', 'refresh_token'}``"
-    username: str | None = Field(None)
-    "username for grant type ``'password'``"
-    password: str | None = Field(None)
-    "password for grant type ``'password'``"
-    refresh_token: str | None = Field(None)
-    "refresh token for grant type ``'refresh_token'`` and logout request"
-
-
-def slash_join(a: str, b: str) -> str:
-    """Join two URL segments together, ensuring a single slash between them."""
-    return a.rstrip("/") + "/" + b.lstrip("/")
-
-
-def login_request(url: str, realm: str, client_id: str, username: str, password: str) -> dict[str, str]:
-    """Sends login request to the authentication server.
-
-    Raises:
-        ClientAuthenticationError: obtaining the tokens failed
-
-    Returns:
-        Tokens dictionary
-
-    """
-    data = AuthRequest(
-        client_id=client_id, grant_type=GrantType.PASSWORD, username=username, password=password, refresh_token=None
-    )
-
-    request_url = slash_join(url, f"realms/{realm}/protocol/openid-connect/token")
-    result = requests.post(request_url, data=data.model_dump(exclude_none=True), timeout=AUTH_REQUESTS_TIMEOUT)
-    if result.status_code == 404:
-        raise ClientAuthenticationError(f"token endpoint is not available at {url}")
-    if result.status_code == 400 and result.json().get("error_description", "") == "Account is not fully set up":
-        raise ClientAccountSetupError("Account is not fully set up")
-    if result.status_code != 200:
-        raise ClientAuthenticationError("invalid username and/or password")
-    tokens = result.json()
-    tokens = {key: tokens.get(key, "") for key in ["access_token", "refresh_token"]}
-    return tokens
-
-
-def refresh_request(url: str, realm: str, client_id: str, refresh_token: str) -> dict[str, str] | None:
-    """Sends refresh request to the authentication server.
-
-    Raises:
-        Timeout: no response from auth server within the timeout period
-        ConnectionError: connecting the auth server failed on all retries
-        ClientAuthenticationError: updating the tokens failed
-
-    Returns:
-        Tokens dictionary, or None if refresh_token is expired.
-
-    """
-    if not token_is_valid(refresh_token):
-        raise ClientAuthenticationError("Refresh token has expired")
-
-    # Update tokens using existing refresh_token
-    data = AuthRequest(
-        client_id=client_id, grant_type=GrantType.REFRESH, username=None, password=None, refresh_token=refresh_token
-    )
-
-    request_url = slash_join(url, f"realms/{realm}/protocol/openid-connect/token")
-    result = requests.post(request_url, data=data.model_dump(exclude_none=True), timeout=AUTH_REQUESTS_TIMEOUT)
-    if result.status_code != 200:
-        raise ClientAuthenticationError(f"Failed to update tokens, {result.text}")
-    tokens = result.json()
-    if not tokens or "access_token" not in tokens or "refresh_token" not in tokens:
-        raise ClientAuthenticationError("Failed to get new tokens")
-    tokens = {key: tokens.get(key, "") for key in ["access_token", "refresh_token"]}
-    return tokens
-
-
-def logout_request(url: str, realm: str, client_id: str, refresh_token: str) -> bool:
-    """Sends logout request to the authentication server.
-
-    Raises:
-        ClientAuthenticationError: updating the tokens failed
-
-    Returns:
-        True if logout was successful
-
-    """
-    data = AuthRequest(client_id=client_id, grant_type=None, username=None, password=None, refresh_token=refresh_token)
-    request_url = slash_join(url, f"realms/{realm}/protocol/openid-connect/logout")
-    result = requests.post(request_url, data=data.model_dump(exclude_none=True), timeout=AUTH_REQUESTS_TIMEOUT)
-
-    if result.status_code != 204:
-        raise ClientAuthenticationError(f"Failed to logout, {result.text}")
-    return True
-
-
-def time_left_seconds(token: str) -> int:
-    """Check how much time is left until the token expires.
-
-    Returns:
-        Time left on token in seconds.
-
-    """
-    _, body, _ = token.split(".", 2)
-    # Add padding to adjust body length to a multiple of 4 chars as required by base64 decoding
-    body += "=" * (-len(body) % 4)
-    exp_time = int(json.loads(b64decode(body)).get("exp", "0"))
-    return max(0, exp_time - int(time.time()))
-
-
-def token_is_valid(refresh_token: str) -> bool:
-    """Check if token is not about to expire.
-
-    Returns:
-        True if token is still valid, False otherwise.
-
-    """
-    return time_left_seconds(refresh_token) > REFRESH_MARGIN_SECONDS