daa_sim: Add support of Qiskit 2.0 (#59)

Author: ohtanim

daa_sim/README.md

@@ -27,7 +27,6 @@ Following Direct Access APIs are provided by the current version of this API sim
   * `GET /v1/backends/{backend-name}`
   * `GET /v1/backends/{backend-name}/configuration`
   * `GET /v1/backends/{backend-name}/properties`
-  * `GET /v1/backends/{backend-name}/defaults`
 * Jobs
   * `POST /v1/jobs`
   * `GET /v1/jobs`
@@ -65,13 +64,13 @@ pip install .
 ```bash
 % pip show direct-access
 Name: direct-access
-Version: 0.1.0
+Version: 0.7.0
 Summary: Direct Access API Simulator
 Home-page: https://quantum.ibm.com/
 Author: IBM Quantum
 Author-email: [email protected]
 License: Apache 2.0
-Location: /Users/ohtanim/py311_daa_sim_1006_0/lib/python3.11/site-packages
+Location: /Users/ohtanim/py311venv_daa_sim/lib/python3.11/site-packages
 Requires: boto3, fastapi, numpy, pyjwt, PyYAML, qiskit, qiskit-aer, qiskit-ibm-runtime, qiskit-qasm3-import, sympy, urllib3, uvicorn
 Required-by: 
 ```
@@ -159,10 +158,6 @@ You will have two different API documents available if you run this API simulato
 - `status` in the returned backends is always `online`
 - Optional fields (`message`, `version`) are not included in the response.
 
-### Get backend pulse defaults (GET /v1/backends/{backend_name}/defaults)
-
-- Returns an empty JSON if `backend_name` is specified as `aer`.
-
 ### Get jobs (GET /v1/jobs)
 
 - The value of `reason_message` and `reason_solution` fields may differ from the values in the Direct Access API production deployment.

daa_sim/direct_access_client/daa_sim/api.py

@@ -282,7 +282,7 @@ class Version(BaseModel):
 )
 def get_version() -> Version:
     """Get the current version of the service"""
-    return Version(version=SERVICE_VERSION).dict()
+    return Version(version=SERVICE_VERSION).model_dump()
 
 
 def _create_fastapi(fastapi_app: FastAPI):

daa_sim/direct_access_client/daa_sim/consts.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# (C) Copyright 2024 IBM. All Rights Reserved.
+# (C) Copyright 2024, 2025 IBM. All Rights Reserved.
 #
 # This code is licensed under the Apache License, Version 2.0. You may
 # obtain a copy of this license in the LICENSE.txt file in the root directory
@@ -16,7 +16,7 @@
 """
 
 # Direct Access API service version, consistent with the latest deployment
-SERVICE_VERSION = "1.0.0"
+SERVICE_VERSION = "0.7.0"
 
 # Default max execution lanes
 # This default value can be overridden by $.max_execution_lanes in the config.yaml

daa_sim/direct_access_client/daa_sim/daa_service.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# (C) Copyright 2024 IBM. All Rights Reserved.
+# (C) Copyright 2024, 2025 IBM. All Rights Reserved.
 #
 # This code is licensed under the Apache License, Version 2.0. You may
 # obtain a copy of this license in the LICENSE.txt file in the root directory
@@ -29,6 +29,7 @@
 import multiprocessing as mp
 import threading
 import importlib
+from collections import OrderedDict
 
 import numpy as np
 import urllib3
@@ -40,9 +41,6 @@
     BitArray,
     DataBin,
 )
-from qiskit.transpiler.target import target_to_backend_properties
-
-from qiskit_aer import AerSimulator
 from qiskit_aer.primitives import SamplerV2, EstimatorV2
 
 from qiskit_ibm_runtime import RuntimeEncoder, RuntimeDecoder
@@ -164,15 +162,14 @@ class DAAService:
 
     DEFAULT_SAMPLER_SHOTS: int = 1000
 
-    DEFAULT_BACKEND = "aer"
-
-    DEFAULT_AVALIABLE_BACKENDS = {
-        DEFAULT_BACKEND: AerSimulator,
-        FakeBrisbane.backend_name: FakeBrisbane,  # 127Q
-        FakeCairoV2.backend_name: FakeCairoV2,  # 27Q
-        FakeLagosV2.backend_name: FakeLagosV2,  # 7Q
-        FakeTorino.backend_name: FakeTorino,  # 133Q
-    }
+    DEFAULT_AVALIABLE_BACKENDS = OrderedDict(
+        [
+            (FakeBrisbane.backend_name, FakeBrisbane),  # 127Q
+            (FakeCairoV2.backend_name, FakeCairoV2),  # 27Q
+            (FakeLagosV2.backend_name, FakeLagosV2),  # 7Q
+            (FakeTorino.backend_name, FakeTorino),  # 133Q
+        ]
+    )
 
     def __init__(
         self,
@@ -206,7 +203,7 @@ def __init__(
         if backends is None:
             self._available_backends = DAAService.DEFAULT_AVALIABLE_BACKENDS
         else:
-            self._available_backends = {}
+            self._available_backends = OrderedDict()
             for backend in backends:
                 try:
                     backend_name, clazz = self.load_backend(
@@ -245,6 +242,13 @@ def __init__(
         else:
             self._status_lock = threading.RLock()
 
+    @property
+    def default_backend_name(self):
+        """Returns the name of the first backend in self._available_backends as default.
+        This is used by pytest testcases only.
+        """
+        return list(self._available_backends.keys())[0]
+
     def _assert_if_inactive(self):
         """throw execption if service is closed"""
         if not self._active:
@@ -442,9 +446,7 @@ def get_backend_properties(self, backend_name: str) -> Dict:
             }
 
         # if backend != aer
-        props = target_to_backend_properties(
-            self._get_backend(backend_name).target
-        ).to_dict()
+        props = self._get_backend(backend_name).properties().to_dict()
         config_dict = self.get_backend_configuration(backend_name)
         for fill_key in ["backend_name", "backend_version"]:
             if props.get(fill_key) in {None, ""}:
@@ -454,17 +456,6 @@ def get_backend_properties(self, backend_name: str) -> Dict:
         props["last_update_date"] = props["qubits"][0][0]["date"]
         return props
 
-    def get_backend_pulse_defaults(self, backend_name: str) -> Dict:
-        backend = self._get_backend(backend_name)  # check backend name is correct
-        if (
-            hasattr(backend, "defs_filename")
-            and backend.defs_filename is not None
-            and hasattr(backend, "_load_json")
-        ):
-            return backend._load_json(backend.defs_filename)
-        # return an empty JSON if not available
-        return {}
-
     def _get_storage(self, storage_type: str) -> SharedStorage:
         if storage_type in self._storage_options:
             return self._storage_options[storage_type]
@@ -700,7 +691,7 @@ def execute_samplerV2(self, job: Dict[str, str]) -> None:
 
             storage = job["storage"]
             backend_name = (
-                job["backend"] if "backend" in job else DAAService.DEFAULT_BACKEND
+                job["backend"] if "backend" in job else self.default_backend_name
             )
             backend = self._get_backend(backend_name)
 
@@ -772,10 +763,7 @@ def execute_samplerV2(self, job: Dict[str, str]) -> None:
                         )
                     )
 
-            if backend_name == DAAService.DEFAULT_BACKEND:
-                sampler = SamplerV2(options=options)
-            else:
-                sampler = SamplerV2.from_backend(backend, options=options)
+            sampler = SamplerV2.from_backend(backend, options=options)
 
             result = sampler.run(pubs, shots=shots).result()
             usage_nanoseconds = 0
@@ -826,7 +814,7 @@ def execute_estimatorV2(self, job: Dict[str, str]) -> None:
 
             storage = job["storage"]
             backend_name = (
-                job["backend"] if "backend" in job else DAAService.DEFAULT_BACKEND
+                job["backend"] if "backend" in job else self.default_backend_name
             )
             backend = self._get_backend(backend_name)
 
@@ -880,10 +868,7 @@ def execute_estimatorV2(self, job: Dict[str, str]) -> None:
                 if isinstance(input_publike[0], str):
                     input_publike[0] = qasm3.loads(input_publike[0])
 
-            if backend_name == DAAService.DEFAULT_BACKEND:
-                estimator = EstimatorV2(options=options)
-            else:
-                estimator = EstimatorV2.from_backend(backend, options=options)
+            estimator = EstimatorV2.from_backend(backend, options=options)
 
             if "precision" in estimator_input:
                 result = estimator.run(

daa_sim/direct_access_client/daa_sim/v1/backend.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# (C) Copyright 2024 IBM. All Rights Reserved.
+# (C) Copyright 2024, 2025 IBM. All Rights Reserved.
 #
 # This code is licensed under the Apache License, Version 2.0. You may
 # obtain a copy of this license in the LICENSE.txt file in the root directory
@@ -14,7 +14,7 @@
 
 """Backend API Mock"""
 import logging.config
-from typing import Union, Annotated
+from typing import Annotated
 from fastapi import APIRouter, Request, Depends
 from fastapi.security import HTTPAuthorizationCredentials
 from direct_access_client.daa_sim.auth import (
@@ -28,8 +28,6 @@
     BackendResponse,
     ErrorResponse,
     BackendConfigurationResponse,
-    PulseDefaultsResponse,
-    EmptyPulseDefaultsResponse,
     BackendPropertiesResponse,
 )
 
@@ -188,41 +186,3 @@ def get_backend_properties(
     verify_token(request, access_token, internal_shared_key)
     service = request.app.daa_service
     return service.get_backend_properties(backend_name)
-
-
-@router.get(
-    "/v1/backends/{backend_name}/defaults",
-    summary="Get backend pulse defaults",
-    description="Returns pulse defaults of a backend.",
-    responses={
-        200: {"model": PulseDefaultsResponse},
-        401: {"model": ErrorResponse},
-        404: {"model": ErrorResponse},
-    },
-    response_model_exclude_none=True,
-    tags=["Backends"],
-)
-def get_backend_pulse_defaults(
-    request: Request,
-    backend_name: str,
-    access_token: Annotated[
-        HTTPAuthorizationCredentials, Depends(access_token_security)
-    ],
-    internal_shared_key: Annotated[
-        HTTPAuthorizationCredentials, Depends(internal_shared_key_security)
-    ],
-) -> Union[PulseDefaultsResponse, EmptyPulseDefaultsResponse]:
-    """Returns pulse defaults of a backend.
-
-    Args:
-        request(Request): Incoming HTTP request
-        backend_name(str): backend name
-        access_token(HTTPAuthorizationCredentials): access token credentials
-        internal_shared_key(HTTPAuthorizationCredentials): internal shared key credentials
-
-    Returns:
-        PulseDefaultsResponse: API response
-    """
-    verify_token(request, access_token, internal_shared_key)
-    service = request.app.daa_service
-    return service.get_backend_pulse_defaults(backend_name)