iqm-client 28.0.0__py3-none-any.whl → 29.0.0__py3-none-any.whl

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

@@ -15,149 +15,54 @@
 
 from enum import Enum, auto
 from posixpath import join
-import warnings
 
 
 class APIEndpoint(Enum):
     """Supported API endpoints."""
 
-    CONFIGURATION = auto()
-    SUBMIT_JOB = auto()
-    GET_JOB_REQUEST_PARAMETERS = auto()
     GET_JOB_RESULT = auto()
-    GET_JOB_STATUS = auto()
+    GET_JOB_REQUEST_PARAMETERS = auto()
     GET_JOB_CALIBRATION_SET_ID = auto()
     GET_JOB_CIRCUITS_BATCH = auto()
-    GET_JOB_TIMELINE = auto()
     GET_JOB_ERROR_LOG = auto()
+    SUBMIT_JOB = auto()
     GET_JOB_COUNTS = auto()
+    GET_JOB_STATUS = auto()
+    GET_JOB_TIMELINE = auto()
     ABORT_JOB = auto()
-    DELETE_JOB = auto()
-    HEALTH = auto()
-    ABOUT = auto()
-    CLIENT_LIBRARIES = auto()
-
-    # Calibration and Calibration Service endpoints
-    CALIBRATION_SERVICE_CONFIGURATION = auto()
-    QUANTUM_ARCHITECTURE = auto()
-    STATIC_QUANTUM_ARCHITECTURE = auto()
-    CHANNEL_PROPERTIES = auto()
-    QUALITY_METRICS_LATEST = auto()
-    QUALITY_METRICS = auto()
-    QUALITY_METRICS_MONITORING = auto()
-    CALIBRATED_GATES = auto()
-    START_CALIBRATION_JOB = auto()
-    ABORT_CALIBRATION_JOB = auto()
-    CALIBRATION_SERVICE_JOBS = auto()
-    CALIBRATION = auto()
-
-
-class APIVariant(Enum):
-    """Supported API versions and variants."""
-
-    V1 = "V1"  # QCCSW Cocos-based circuits execution
-    V2 = "V2"  # Station-Control-based circuits execution
-    RESONANCE_COCOS_V1 = "RESONANCE_COCOS_V1"  # IQM Resonance Cocos API
 
 
 class APIConfig:
     """Provides supported API endpoints for a given API variant."""
 
-    def __init__(self, variant: APIVariant, iqm_server_url: str):
+    def __init__(self, station_control_url: str):
         """Args:
-        variant: API variant.
-        iqm_server_url: URL of the IQM server,
-                        e.g. https://test.qc.iqm.fi/cocos or https://cocos.resonance.meetiqm.com/garnet for .V1
-                        or https://test.qc.iqm.fi for .V2
+        station_control_url: URL of the IQM server,
+            e.g. https://test.qc.iqm.fi/station or https://cocos.resonance.meetiqm.com/garnet
 
         """
-        self.variant = variant
-
-        # V1 API is deprecated and will be removed in a future release.
-        # V2 API is supported by the QCCSW starting with version 3.3.0.
-        if self.variant == APIVariant.V1:
-            warnings.warn(
-                "The V1 API is deprecated and will be removed in a future release. Please use the V2 API instead.",
-                DeprecationWarning,
-            )
-
-        self.iqm_server_url = iqm_server_url
+        self.station_control_url = station_control_url
         self.urls = self._get_api_urls()
 
-    def _get_api_urls(self) -> dict[APIEndpoint, str]:
+    @staticmethod
+    def _get_api_urls() -> dict[APIEndpoint, str]:
         """Returns:
         Relative URLs for each supported API endpoints.
 
         """
-        if self.variant == APIVariant.RESONANCE_COCOS_V1:
-            return {
-                APIEndpoint.SUBMIT_JOB: "jobs",
-                APIEndpoint.GET_JOB_RESULT: "jobs/%s",
-                APIEndpoint.GET_JOB_STATUS: "jobs/%s/status",
-                APIEndpoint.GET_JOB_COUNTS: "jobs/%s/counts",
-                APIEndpoint.ABORT_JOB: "jobs/%s/abort",
-                APIEndpoint.QUANTUM_ARCHITECTURE: "quantum-architecture",
-                APIEndpoint.STATIC_QUANTUM_ARCHITECTURE: "api/v1/quantum-architecture",
-                APIEndpoint.CALIBRATED_GATES: "api/v1/calibration/%s/gates",
-                APIEndpoint.CLIENT_LIBRARIES: "info/client-libraries",
-            }
-        if self.variant == APIVariant.V1:
-            return {
-                APIEndpoint.CONFIGURATION: "configuration",
-                APIEndpoint.QUALITY_METRICS_LATEST: "calibration/metrics/latest",
-                APIEndpoint.QUALITY_METRICS: "calibration/metrics/%s",
-                APIEndpoint.SUBMIT_JOB: "jobs",
-                APIEndpoint.GET_JOB_RESULT: "jobs/%s",
-                APIEndpoint.GET_JOB_STATUS: "jobs/%s/status",
-                APIEndpoint.GET_JOB_COUNTS: "jobs/%s/counts",
-                APIEndpoint.ABORT_JOB: "jobs/%s/abort",
-                APIEndpoint.ABORT_CALIBRATION_JOB: "jobs/%s/abort",
-                APIEndpoint.DELETE_JOB: "jobs/%s",
-                APIEndpoint.QUANTUM_ARCHITECTURE: "quantum-architecture",
-                APIEndpoint.STATIC_QUANTUM_ARCHITECTURE: "api/v1/quantum-architecture",
-                APIEndpoint.CALIBRATED_GATES: "api/v1/calibration/%s/gates",
-                APIEndpoint.QUALITY_METRICS_MONITORING: "api/v1/monitor/calibration/metrics",
-                APIEndpoint.HEALTH: "health",
-                APIEndpoint.ABOUT: "about",
-                APIEndpoint.CLIENT_LIBRARIES: "info/client-libraries",
-                APIEndpoint.START_CALIBRATION_JOB: "calibration/run",
-                APIEndpoint.CALIBRATION_SERVICE_CONFIGURATION: "calibration/configuration",
-                APIEndpoint.CALIBRATION_SERVICE_JOBS: "calibration/jobs",
-                APIEndpoint.CALIBRATION: "api/v1/calibration/%s",
-                APIEndpoint.GET_JOB_ERROR_LOG: "jobs/%s/error_log",
-            }
-        if self.variant == APIVariant.V2:
-            return {
-                # TODO SW-1387: Use station/v1 API
-                APIEndpoint.GET_JOB_REQUEST_PARAMETERS: "station/jobs/%s/request_parameters",
-                APIEndpoint.CONFIGURATION: "cocos/configuration",
-                APIEndpoint.QUALITY_METRICS_LATEST: "cocos/calibration/metrics/latest",
-                APIEndpoint.QUALITY_METRICS: "cocos/calibration/metrics/%s",
-                APIEndpoint.SUBMIT_JOB: "station/circuits",
-                APIEndpoint.GET_JOB_RESULT: "station/jobs/%s/measurements",
-                APIEndpoint.GET_JOB_STATUS: "station/jobs/%s/status",
-                APIEndpoint.GET_JOB_CALIBRATION_SET_ID: "station/jobs/%s/calibration_set_id",
-                APIEndpoint.GET_JOB_CIRCUITS_BATCH: "station/jobs/%s/circuits_batch",
-                APIEndpoint.GET_JOB_TIMELINE: "station/jobs/%s/timeline",
-                APIEndpoint.GET_JOB_ERROR_LOG: "station/jobs/%s/error_log",
-                APIEndpoint.GET_JOB_COUNTS: "station/circuits/%s/counts",
-                APIEndpoint.ABORT_JOB: "station/jobs/%s/abort",
-                APIEndpoint.ABORT_CALIBRATION_JOB: "cocos/jobs/%s/abort",
-                APIEndpoint.DELETE_JOB: "station/jobs/%s",
-                APIEndpoint.QUANTUM_ARCHITECTURE: "cocos/quantum-architecture",
-                APIEndpoint.STATIC_QUANTUM_ARCHITECTURE: "cocos/api/v1/quantum-architecture",
-                APIEndpoint.CHANNEL_PROPERTIES: "station/channel-properties",
-                APIEndpoint.CALIBRATED_GATES: "cocos/api/v1/calibration/%s/gates",
-                APIEndpoint.QUALITY_METRICS_MONITORING: "cocos/api/v1/monitor/calibration/metrics",
-                APIEndpoint.HEALTH: "cocos/health",
-                APIEndpoint.ABOUT: "cocos/about",
-                APIEndpoint.CLIENT_LIBRARIES: "info/client-libraries",
-                APIEndpoint.START_CALIBRATION_JOB: "cocos/calibration/run",
-                APIEndpoint.CALIBRATION_SERVICE_CONFIGURATION: "cocos/calibration/configuration",
-                APIEndpoint.CALIBRATION_SERVICE_JOBS: "cocos/calibration/jobs",
-                APIEndpoint.CALIBRATION: "cocos/api/v1/calibration/%s",
-            }
-        raise ValueError(f"Unsupported API variant: {self.variant}")
+        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:
@@ -182,6 +87,4 @@ class APIConfig:
 
         """
         url = self.urls.get(endpoint)
-        if url is None:
-            raise ValueError(f"Unsupported API endpoint: {endpoint}")
-        return join(self.iqm_server_url, url % args)
+        return join(self.station_control_url, url % args)

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"""