iqm-station-control-client 8.1.0__py3-none-any.whl → 9.1.0__py3-none-any.whl

iqm/station_control/client/station_control.py

@@ -11,7 +11,7 @@
 # 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.
-"""Station control client implementation."""
+"""Client implementation for station control service REST API."""
 
 from __future__ import annotations
 
@@ -21,6 +21,7 @@ from importlib.metadata import version
 import json
 import logging
 import os
+import platform
 from time import sleep
 from typing import Any, TypeVar
 import uuid
@@ -32,8 +33,7 @@ from pydantic import BaseModel
 import requests
 
 from exa.common.data.setting_node import SettingNode
-from exa.common.data.value import ObservationValue
-from exa.common.errors.server_errors import (
+from exa.common.errors.station_control_errors import (
     InternalServerError,
     NotFoundError,
     StationControlError,
@@ -62,12 +62,14 @@ from iqm.station_control.client.serializers import (
 from iqm.station_control.client.serializers.channel_property_serializer import unpack_channel_properties
 from iqm.station_control.client.serializers.setting_node_serializer import deserialize_setting_node
 from iqm.station_control.client.serializers.sweep_serializers import deserialize_sweep_data
-from iqm.station_control.client.utils import calset_from_observations
 from iqm.station_control.interface.list_with_meta import ListWithMeta
 from iqm.station_control.interface.models import (
     DutData,
     DutFieldData,
+    DynamicQuantumArchitecture,
     GetObservationsMode,
+    JobData,
+    JobExecutorStatus,
     ObservationData,
     ObservationDefinition,
     ObservationLite,
@@ -75,6 +77,7 @@ from iqm.station_control.interface.models import (
     ObservationSetDefinition,
     ObservationSetUpdate,
     ObservationUpdate,
+    QualityMetrics,
     RunData,
     RunDefinition,
     RunLite,
@@ -83,150 +86,210 @@ from iqm.station_control.interface.models import (
     SequenceResultData,
     SequenceResultDefinition,
     SoftwareVersionSet,
+    StaticQuantumArchitecture,
     Statuses,
     SweepData,
     SweepDefinition,
     SweepResults,
 )
-from iqm.station_control.interface.models.jobs import JobData, JobExecutorStatus
+from iqm.station_control.interface.models.type_aliases import StrUUID
 from iqm.station_control.interface.pydantic_base import PydanticBase
+from iqm.station_control.interface.station_control import StationControlInterface
 
 logger = logging.getLogger(__name__)
-T = TypeVar("T")
+TypePydanticBase = TypeVar("TypePydanticBase", bound=PydanticBase)
 
 
-class StationControlClient:
-    """Station control client implementation.
-
-    Current implementation uses HTTP calls to the remote station control service,
-    that is controlling the station control instance.
+class _StationControlClientBase(StationControlInterface):
+    """Shared functionality for StationControlClient and IqmServerClient.
 
     Args:
-        root_url: Remote station control service URL.
-        get_token_callback: A callback function that returns a token (str) which will be passed in Authorization header
-            in all requests.
-
-    Station control client implements generic query methods for certain objects,
-    like :meth:`query_observations`, :meth:`query_observation_sets`, and :meth:`query_sequence_metadatas`.
-    These methods accept only keyword arguments as parameters, which are based on the syntax ``field__lookup=value``.
-    Note double-underscore in the name, to separate field names like ``dut_field`` from lookup types like ``in``.
-    The syntax is based on Django implementation, documented
-    `here <https://docs.djangoproject.com/en/5.0/ref/models/querysets/#field-lookups>`__ and
-    `here <https://docs.djangoproject.com/en/5.0/ref/contrib/postgres/fields/#querying-arrayfield>`__.
-
-    As a convenience, when no lookup type is provided (like in ``dut_label="foo"``),
-    the lookup type is assumed to be exact (``dut_label__exact="foo"``). Other supported lookup types are:
-
-        - range: Range test (inclusive).
-            For example, ``created_timestamp__range=(datetime(2023, 10, 12), datetime(2024, 10, 14))``
-        - in: In a given iterable; often a list, tuple, or queryset.
-            For example, ``dut_field__in=["QB1.frequency", "gates.measure.constant.QB2.frequency"]``
-        - icontains: Case-insensitive containment test.
-            For example, ``origin_uri__icontains="local"``
-        - overlap: Returns objects where the data shares any results with the values passed.
-            For example, ``tags__overlap=["calibration=good", "2023-12-04"]``
-        - contains: The returned objects will be those where the values passed are a subset of the data.
-            For example, ``tags__contains=["calibration=good", "2023-12-04"]``
-        - isnull: Takes either True or False, which correspond to SQL queries of IS NULL and IS NOT NULL, respectively.
-            For example, ``end_timestamp__isnull=False``
-
-    In addition to model fields (like "dut_label", "dut_field", "created_timestamp", "invalid", etc.),
-    all of our generic query methods accept also following shared query parameters:
-
-        - latest: str. Return only the latest item for this field, based on "created_timestamp".
-            For example, ``latest="invalid"`` would return only one result (latest "created_timestamp")
-            for each different "invalid" value in the database. Thus, maximum three results would be returned,
-            one for each invalid value of `True`, `False`, and `None`.
-        - order_by: str. Prefix with "-" for descending order, for example "-created_timestamp".
-        - limit: int: Default 20. If 0 (or negative number) is given, then pagination is not used, i.e. limit=infinity.
-        - offset: int. Default 0.
-
-    Our generic query methods are not fully generalized yet, thus not all fields and lookup types are supported.
-    Check query methods own documentation for details about currently supported query parameters.
-
-    Generic query methods will return a list of objects, but with additional (optional) "meta" attribute,
-    which contains metadata, like pagination details. The client can ignore this data,
-    or use it to implement pagination logic for example to fetch all results available.
+        root_url: Remote server URL.
+        get_token_callback: A callback function that returns a token
+            which will be passed in Authorization header in all requests.
+        client_signature: String that is added to the User-Agent header of requests
+            sent to the server.
+        enable_opentelemetry: Iff True, enable Jaeger/OpenTelemetry tracing.
 
     """
 
-    def __init__(self, root_url: str, get_token_callback: Callable[[], str] | None = None):
+    def __init__(
+        self,
+        root_url: str,
+        *,
+        get_token_callback: Callable[[], str] | None = None,
+        client_signature: str | None = None,
+        enable_opentelemetry: bool = False,
+    ):
         self.root_url = root_url
-        self._enable_opentelemetry = os.environ.get("JAEGER_OPENTELEMETRY_COLLECTOR_ENDPOINT", None) is not None
         self._get_token_callback = get_token_callback
-        # TODO SW-1387: Remove this when using v1 API, not needed
-        self._check_api_versions()
-        qcm_url = os.environ.get("CHIP_DESIGN_RECORD_FALLBACK_URL", None)
-        self._qcm_data_client = QCMDataClient(qcm_url) if qcm_url else None
+        self._signature = self._create_signature(client_signature)
+        self._enable_opentelemetry = enable_opentelemetry
+
+    @classmethod
+    def _create_signature(cls, client_signature: str | None) -> str:
+        signature = f"{platform.platform(terse=True)}"
+        signature += f", python {platform.python_version()}"
+        dist_pkg_name = "iqm-station-control-client"
+        signature += f", {cls.__name__} {dist_pkg_name} {version(dist_pkg_name)}"
+        if client_signature:
+            signature += f", {client_signature}"
+        return signature
 
-    @property
-    def version(self) -> str:
-        """Return the version of the station control API this client is using."""
-        return "v1"
-
-    @staticmethod
-    def init(root_url: str, get_token_callback: Callable[[], str] | None = None, **kwargs) -> StationControlClient:
-        """Initialize a new station control client instance connected to the given remote.
+    def _send_request(
+        self,
+        http_method: Callable[..., requests.Response],
+        url_path: str,
+        *,
+        headers: dict[str, str] | None = None,
+        params: dict[str, Any] | None = None,
+        json_str: str | None = None,
+        octets: bytes | None = None,
+        timeout: int = 120,
+    ) -> requests.Response:
+        """Send an HTTP request.
 
-        Client implementation is selected automatically based on the remote station: if the remote station
-        is running the IQM Server software stack, then the IQM Server client implementation (with a limited
-        feature set) is chosen. If the remote station is running the SC software stack, then the Station
-        Control client implementation (with the full feature set) is chosen.
+        Parameters ``json_str`` and ``octets`` are mutually exclusive.
+        The first non-None argument (in this order) will be used to construct the body of the request.
 
         Args:
-            root_url: Remote station control service URL. For IQM Server remotes, this is the "Quantum Computer URL"
-                value from the web dashboard.
-            get_token_callback: A callback function that returns a token (str) which will be passed in Authorization
-                header in all requests.
+            http_method: HTTP method to use for the request, any of requests.[post|get|put|head|delete|patch|options].
+            url_path: URL for the request.
+            headers: Additional HTTP headers for the request. Some may be overridden.
+            params: HTTP query parameters to store in the query string of the request URL.
+            json_str: JSON string to store in the body, may contain arbitrary Unicode characters.
+            octets: Pre-serialized binary data to store in the body.
+
+        Returns:
+            Response to the request.
+
+        Raises:
+            StationControlError: Request was not successful.
 
         """
-        try:
-            headers = {"Authorization": f"Bearer {get_token_callback()}"} if get_token_callback else {}
-            response = requests.get(f"{root_url}/about", headers=headers)
-            response.raise_for_status()
-            about = response.json()
-            if isinstance(about, dict) and about.get("iqm_server") is True:
-                # If about information has iqm_server flag, it means that we're communicating
-                # with IQM server instead of direct Station Control service, hence we need to
-                # use the specialized client
+        # Will raise an error if respectively an error response code is returned.
+        # http_method should be any of requests.[post|get|put|head|delete|patch|options]
+
+        request_kwargs = self._build_request_kwargs(
+            headers=headers or {}, params=params or {}, json_str=json_str, octets=octets, timeout=timeout
+        )
+        url = f"{self.root_url}/{url_path}"
+        # TODO SW-1387: Use v1 API
+        # url = f"{self.root_url}/{self.version}/{url_path}"
+        response = http_method(url, **request_kwargs)
+        if not response.ok:
+            try:
+                response_json = response.json()
+                error_message = response_json["detail"]
+            except json.JSONDecodeError:
+                error_message = response.text
+
+            try:
+                error_class = map_from_status_code_to_error(response.status_code)
+            except KeyError:
+                raise RuntimeError(f"Unexpected response status code {response.status_code}: {error_message}")
 
-                # Must be imported here in order to avoid circular dependencies
-                from iqm.station_control.client.iqm_server.iqm_server_client import IqmServerClient
+            raise error_class(error_message)
+        return response
 
-                return IqmServerClient(root_url, get_token_callback, **kwargs)
-            # Using direct station control by default
-            return StationControlClient(root_url, get_token_callback)
+    def _build_request_kwargs(
+        self,
+        *,
+        headers: dict[str, str],
+        params: dict[str, Any],
+        json_str: str | None = None,
+        octets: bytes | None = None,
+        timeout: int,
+    ) -> dict[str, Any]:
+        """Prepare the keyword arguments for an HTTP request."""
+        # add default headers
+        headers["User-Agent"] = self._signature
+
+        # json_str and octets are mutually exclusive
+        data: bytes | None = None
+        if json_str is not None:
+            # Must be able to handle JSON strings with arbitrary unicode characters, so we use an explicit
+            # encoding into bytes, and set the headers so the recipient can decode the request body correctly.
+            data = json_str.encode("utf-8")
+            headers["Content-Type"] = "application/json; charset=UTF-8"
+        elif octets is not None:
+            data = octets
+            headers["Content-Type"] = "application/octet-stream"
 
-        except Exception as e:
-            raise StationControlError("Failed to connect to the remote server") from e
+        if self._enable_opentelemetry:
+            parent_span_context = trace.set_span_in_context(trace.get_current_span())
+            propagate.inject(carrier=headers, context=parent_span_context)
+
+        # If token callback exists, use it to retrieve the token and add it to the headers
+        if self._get_token_callback:
+            headers["Authorization"] = self._get_token_callback()
+
+        kwargs = {
+            "headers": headers,
+            "params": params,
+            "data": data,
+            "timeout": timeout,
+        }
+        return _remove_empty_values(kwargs)
+
+
+class StationControlClient(_StationControlClientBase):
+    """Client implementation for station control service REST API.
+
+    Args:
+        root_url: Remote station control service URL.
+        get_token_callback: A callback function that returns a token (str)
+            which will be passed in Authorization header in all requests.
+        client_signature: String that is added to the User-Agent header of requests
+            sent to the server.
+
+    """
+
+    def __init__(
+        self, root_url: str, *, get_token_callback: Callable[[], str] | None = None, client_signature: str | None = None
+    ):
+        super().__init__(
+            root_url,
+            get_token_callback=get_token_callback,
+            client_signature=client_signature,
+            enable_opentelemetry=os.environ.get("JAEGER_OPENTELEMETRY_COLLECTOR_ENDPOINT", None) is not None,
+        )
+        # TODO SW-1387: Remove this when using v1 API, not needed
+        self._check_api_versions()
+        qcm_data_url = os.environ.get("CHIP_DESIGN_RECORD_FALLBACK_URL", None)
+        self._qcm_data_client = QCMDataClient(qcm_data_url) if qcm_data_url else None
+
+    @property
+    def version(self) -> str:
+        """Return the version of the station control API this client is using."""
+        return "v1"
 
     @cache
     def get_about(self) -> dict:
-        """Return information about the station control."""
         response = self._send_request(requests.get, "about")
         return response.json()
 
+    def get_health(self) -> dict:
+        response = self._send_request(requests.get, "health")
+        return response.json()
+
     @cache
     def get_configuration(self) -> dict:
-        """Return the configuration of the station control."""
         response = self._send_request(requests.get, "configuration")
         return response.json()
 
     @cache
     def get_exa_configuration(self) -> str:
-        """Return the recommended EXA configuration from the server."""
         response = self._send_request(requests.get, "exa/configuration")
         return response.content.decode("utf-8")
 
     def get_or_create_software_version_set(self, software_version_set: SoftwareVersionSet) -> int:
-        """Get software version set ID from the database, or create if it doesn't exist."""
         # FIXME: We don't have information if the object was created or fetched. Thus, server always responds 200 (OK).
         json_str = json.dumps(software_version_set)
         response = self._send_request(requests.post, "software-version-sets", json_str=json_str)
         return int(response.content)
 
     def get_settings(self) -> SettingNode:
-        """Return a tree representation of the default settings as defined in the configuration file."""
         return self._get_cached_settings().model_copy()
 
     @cache
@@ -236,7 +299,6 @@ class StationControlClient:
 
     @cache
     def get_chip_design_record(self, dut_label: str) -> dict:
-        """Get a raw chip design record matching the given chip label."""
         try:
             response = self._send_request(requests.get, f"chip-design-records/{dut_label}")
         except StationControlError as err:
@@ -247,17 +309,8 @@ class StationControlClient:
 
     @cache
     def get_channel_properties(self) -> dict[str, ChannelProperties]:
-        """Get channel properties from the station.
-
-        Channel properties contain information regarding hardware limitations e.g. sampling rate, granularity
-        and supported instructions.
-
-        Returns:
-            Mapping from channel name to AWGProperties or ReadoutProperties
-
-        """
         headers = {"accept": "application/octet-stream"}
-        response = self._send_request(requests.get, "channel-properties/", headers=headers)
+        response = self._send_request(requests.get, "channel-properties", headers=headers)
         decoded_dict = unpack_channel_properties(response.content)
         return decoded_dict
 
@@ -265,49 +318,17 @@ class StationControlClient:
         self,
         sweep_definition: SweepDefinition,
     ) -> dict:
-        """Execute an N-dimensional sweep of selected variables and save sweep and results.
-
-        The raw data for each spot in the sweep is saved as numpy arrays,
-        and the complete data for the whole sweep is saved as an x-array dataset
-        which has the `sweep_definition.sweeps` as coordinates and
-        data of `sweep_definition.return_parameters` data as DataArrays.
-
-        The values of `sweep_definition.playlist` will be uploaded to the controllers given by the keys of
-        `sweep_definition.playlist`.
-
-        Args:
-            sweep_definition: The content of the sweep to be created.
-
-        Returns:
-            Dict containing the job ID  and sweep ID, and corresponding hrefs, of a successful sweep execution
-            in monolithic mode or successful submission to the job queue in remote mode.
-
-        Raises:
-            ExaError if submitting a sweep failed.
-
-        """
         data = serialize_sweep_job_request(sweep_definition, queue_name="sweeps")
         return self._send_request(requests.post, "sweeps", octets=data).json()
 
-    def get_sweep(self, sweep_id: uuid.UUID) -> SweepData:
-        """Get N-dimensional sweep data from the database."""
+    def get_sweep(self, sweep_id: StrUUID) -> SweepData:
         response = self._send_request(requests.get, f"sweeps/{sweep_id}")
         return deserialize_sweep_data(response.json())
 
-    def abort_job(self, job_id: uuid.UUID) -> None:
-        """Either remove a job from the queue, or abort it gracefully if it's already executing.
-
-        The status of the job will be set to ``JobStatus.ABORTED``.
-        If the job is not found or is already finished nothing happens.
-        """
-        self._send_request(requests.post, f"jobs/{job_id}/abort")
-
-    def delete_sweep(self, sweep_id: uuid.UUID) -> None:
-        """Delete sweep in the database."""
+    def delete_sweep(self, sweep_id: StrUUID) -> None:
         self._send_request(requests.delete, f"sweeps/{sweep_id}")
 
-    def get_sweep_results(self, sweep_id: uuid.UUID) -> SweepResults:
-        """Get N-dimensional sweep results from the database."""
+    def get_sweep_results(self, sweep_id: StrUUID) -> SweepResults:
         response = self._send_request(requests.get, f"sweeps/{sweep_id}/results")
         return deserialize_sweep_results(response.content)
 
@@ -317,7 +338,6 @@ class StationControlClient:
         update_progress_callback: Callable[[Statuses], None] | None = None,
         wait_job_completion: bool = True,
     ) -> bool:
-        """Execute an N-dimensional sweep of selected variables and save run, sweep and results."""
         data = serialize_run_job_request(run_definition, queue_name="sweeps")
 
         response = self._send_request(requests.post, "runs", octets=data)
@@ -325,61 +345,21 @@ class StationControlClient:
             return self._wait_job_completion(response.json()["job_id"], update_progress_callback)
         return False
 
-    def get_run(self, run_id: uuid.UUID) -> RunData:
-        """Get run data from the database."""
+    def get_run(self, run_id: StrUUID) -> RunData:
         response = self._send_request(requests.get, f"runs/{run_id}")
         return deserialize_run_data(response.json())
 
     def query_runs(self, **kwargs) -> ListWithMeta[RunLite]:
-        """Query runs from the database.
-
-        Runs are queried by the given query parameters. Currently supported query parameters:
-            - run_id: uuid.UUID
-            - run_id__in: list[uuid.UUID]
-            - sweep_id: uuid.UUID
-            - sweep_id__in: list[uuid.UUID]
-            - username: str
-            - username__in: list[str]
-            - username__contains: str
-            - username__icontains: str
-            - experiment_label: str
-            - experiment_label__in: list[str]
-            - experiment_label__contains: str
-            - experiment_label__icontains: str
-            - experiment_name: str
-            - experiment_name__in: list[str]
-            - experiment_name__contains: str
-            - experiment_name__icontains: str
-            - software_version_set_id: int
-            - software_version_set_id__in: list[int]
-            - begin_timestamp__range: tuple[datetime, datetime]
-            - end_timestamp__range: tuple[datetime, datetime]
-            - end_timestamp__isnull: bool
-
-        Returns:
-            Queried runs with some query related metadata.
-
-        """
         params = self._clean_query_parameters(RunData, **kwargs)
         response = self._send_request(requests.get, "runs", params=params)
-        return self._create_list_with_meta(response, RunLiteList)
+        return self._deserialize_response(response, RunLiteList, list_with_meta=True)
 
     def create_observations(
         self, observation_definitions: Sequence[ObservationDefinition]
     ) -> ListWithMeta[ObservationData]:
-        """Create observations in the database.
-
-        Args:
-            observation_definitions: A sequence of observation definitions,
-                each containing the content of the observation which will be created.
-
-        Returns:
-            Created observations, each including also the database created fields like ID and timestamps.
-
-        """
         json_str = self._serialize_model(ObservationDefinitionList(observation_definitions))
         response = self._send_request(requests.post, "observations", json_str=json_str)
-        return self._create_list_with_meta(response, ObservationDataList)
+        return self._deserialize_response(response, ObservationDataList, list_with_meta=True)
 
     def get_observations(
         self,
@@ -389,40 +369,10 @@ class StationControlClient:
         dut_field: str | None = None,
         tags: list[str] | None = None,
         invalid: bool | None = False,
-        run_ids: list[uuid.UUID] | None = None,
-        sequence_ids: list[uuid.UUID] | None = None,
+        run_ids: list[StrUUID] | None = None,
+        sequence_ids: list[StrUUID] | None = None,
         limit: int | None = None,
     ) -> list[ObservationData]:
-        """Get observations from the database.
-
-        Observations are queried by the given query parameters.
-
-        Args:
-            mode: The "mode" used to query the observations. Possible values "all_latest", "tags_and", or "tags_or".
-
-                  - "all_latest":Query all the latest observations for the given ``dut_label``.
-                    No other query parameters are accepted.
-                  - "tags_and": Query observations. Query all the observations that have all the given ``tags``.
-                    By default, only valid observations are included.
-                    All other query parameters can be used to narrow down the query,
-                    expect "run_ids" and "sequence_ids".
-                  - "tags_or": Query all the latest observations that have at least one of the given ``tags``.
-                    Additionally, ``dut_label`` must be given. No other query parameters are used.
-                  - "sequence": Query observations originating from a list of run and/or sequence IDs.
-                    No other query parameters are accepted.
-            dut_label: DUT label of the device the observations pertain to.
-            dut_field: Name of the property the observation is about.
-            tags: Human-readable tags of the observation.
-            invalid: Flag indicating if the object is invalid. Automated systems must not use invalid objects.
-                If ``None``, both valid and invalid objects are included.
-            run_ids: The run IDs for which to query the observations.
-            sequence_ids: The sequence IDs for which to query the observations.
-            limit: Indicates the maximum number of items to return.
-
-        Returns:
-            Observations, each including also the database created fields like ID and timestamps.
-
-        """
         kwargs = {
             "mode": mode,
             "dut_label": dut_label,
@@ -435,249 +385,115 @@ class StationControlClient:
         }
         params = self._clean_query_parameters(ObservationData, **kwargs)
         response = self._send_request(requests.get, "observations", params=params)
-        return ObservationDataList.model_validate(response.json())
+        return self._deserialize_response(response, ObservationDataList)
 
     def query_observations(self, **kwargs) -> ListWithMeta[ObservationData]:
-        """Query observations from the database.
-
-        Observations are queried by the given query parameters. Currently supported query parameters:
-            - observation_id: int
-            - observation_id__in: list[int]
-            - dut_label: str
-            - dut_field: str
-            - dut_field__in: list[str]
-            - tags__overlap: list[str]
-            - tags__contains: list[str]
-            - invalid: bool
-            - source__run_id__in: list[uuid.UUID]
-            - source__sequence_id__in: list[uuid.UUID]
-            - source__type: str
-            - uncertainty__isnull: bool
-            - created_timestamp__range: tuple[datetime, datetime]
-            - observation_set_ids__overlap: list[uuid.UUID]
-            - observation_set_ids__contains: list[uuid.UUID]
-
-        Returns:
-            Queried observations with some query related metadata.
-
-        """
         params = self._clean_query_parameters(ObservationData, **kwargs)
         response = self._send_request(requests.get, "observations", params=params)
-        return self._create_list_with_meta(response, ObservationDataList)
+        return self._deserialize_response(response, ObservationDataList, list_with_meta=True)
 
     def update_observations(self, observation_updates: Sequence[ObservationUpdate]) -> list[ObservationData]:
-        """Update observations in the database.
-
-        Args:
-            observation_updates: A sequence of observation updates,
-                each containing the content of the observation which will be updated.
-
-        Returns:
-            Updated observations, each including also the database created fields like ID and timestamps.
-
-        """
         json_str = self._serialize_model(ObservationUpdateList(observation_updates))
         response = self._send_request(requests.patch, "observations", json_str=json_str)
-        return ObservationDataList.model_validate(response.json())
+        return self._deserialize_response(response, ObservationDataList)
 
     def query_observation_sets(self, **kwargs) -> ListWithMeta[ObservationSetData]:
-        """Query observation sets from the database.
-
-        Observation sets are queried by the given query parameters. Currently supported query parameters:
-            - observation_set_id: UUID
-            - observation_set_id__in: list[UUID]
-            - observation_set_type: Literal["calibration-set", "generic-set", "quality-metric-set"]
-            - observation_ids__overlap: list[int]
-            - observation_ids__contains: list[int]
-            - describes_id: UUID
-            - describes_id__in: list[UUID]
-            - invalid: bool
-            - created_timestamp__range: tuple[datetime, datetime]
-            - end_timestamp__isnull: bool
-            - dut_label: str
-            - dut_label__in: list[str]
-
-        Returns:
-            Queried observation sets with some query related metadata
-
-        """
         params = self._clean_query_parameters(ObservationSetData, **kwargs)
         response = self._send_request(requests.get, "observation-sets", params=params)
-        return self._create_list_with_meta(response, ObservationSetDataList)
+        return self._deserialize_response(response, ObservationSetDataList, list_with_meta=True)
 
     def create_observation_set(self, observation_set_definition: ObservationSetDefinition) -> ObservationSetData:
-        """Create an observation set in the database.
-
-        Args:
-            observation_set_definition: The content of the observation set to be created.
-
-        Returns:
-            The content of the observation set.
-
-        Raises:
-            ExaError: If creation failed.
-
-        """
         json_str = self._serialize_model(observation_set_definition)
         response = self._send_request(requests.post, "observation-sets", json_str=json_str)
-        return ObservationSetData.model_validate(response.json())
-
-    def get_observation_set(self, observation_set_id: uuid.UUID) -> ObservationSetData:
-        """Get an observation set from the database.
-
-        Args:
-            observation_set_id: Observation set to retrieve.
-
-        Returns:
-            The content of the observation set.
-
-        Raises:
-            ExaError: If retrieval failed.
+        return self._deserialize_response(response, ObservationSetData)
 
-        """
+    def get_observation_set(self, observation_set_id: StrUUID) -> ObservationSetData:
         response = self._send_request(requests.get, f"observation-sets/{observation_set_id}")
-        return ObservationSetData.model_validate(response.json())
+        return self._deserialize_response(response, ObservationSetData)
 
     def update_observation_set(self, observation_set_update: ObservationSetUpdate) -> ObservationSetData:
-        """Update an observation set in the database.
-
-        Args:
-            observation_set_update: The content of the observation set to be updated.
-
-        Returns:
-            The content of the observation set.
-
-        Raises:
-            ExaError: If updating failed.
-
-        """
         json_str = self._serialize_model(observation_set_update)
         response = self._send_request(requests.patch, "observation-sets", json_str=json_str)
-        return ObservationSetData.model_validate(response.json())
-
-    def finalize_observation_set(self, observation_set_id: uuid.UUID) -> None:
-        """Finalize an observation set in the database.
-
-        A finalized set is nearly immutable, allowing to change only ``invalid`` flag after finalization.
-
-        Args:
-            observation_set_id: Observation set to finalize.
-
-        Raises:
-            ExaError: If finalization failed.
+        return self._deserialize_response(response, ObservationSetData)
 
-        """
+    def finalize_observation_set(self, observation_set_id: StrUUID) -> None:
         self._send_request(requests.post, f"observation-sets/{observation_set_id}/finalize")
 
-    def get_observation_set_observations(self, observation_set_id: uuid.UUID) -> list[ObservationLite]:
-        """Get the constituent observations of an observation set from the database.
-
-        Args:
-            observation_set_id: UUID of the observation set to retrieve.
-
-        Returns:
-            Observations belonging to the given observation set.
-
-        """
+    def get_observation_set_observations(self, observation_set_id: StrUUID) -> list[ObservationLite]:
         response = self._send_request(requests.get, f"observation-sets/{observation_set_id}/observations")
-        return ObservationLiteList.model_validate(response.json())
-
-    def get_calibration_set_values(self, calibration_set_id: uuid.UUID) -> dict[str, ObservationValue]:
-        """Get saved calibration set observations by UUID
-
-        Args:
-            calibration_set_id: UUID of the calibration set to retrieve.
+        return self._deserialize_response(response, ObservationLiteList)
 
-        Returns:
-            Dictionary of observations belonging to the given calibration set.
+    def get_default_calibration_set(self) -> ObservationSetData:
+        response = self._send_request(requests.get, "calibration-sets/default")
+        return self._deserialize_response(response, ObservationSetData)
 
-        """
-        observation_set = self.get_observation_set(calibration_set_id)
-        if observation_set.observation_set_type != "calibration-set":
-            raise ValueError("Observation set type is not 'calibration-set'")
-        observations = self.get_observation_set_observations(calibration_set_id)
-        return calset_from_observations(observations)
+    def get_default_calibration_set_observations(self) -> list[ObservationLite]:
+        response = self._send_request(requests.get, "calibration-sets/default/observations")
+        return self._deserialize_response(response, ObservationLiteList)
 
-    def get_latest_calibration_set_id(self, dut_label: str) -> uuid.UUID:
-        """Get UUID of the latest saved calibration set for the given dut_label.
+    def get_default_dynamic_quantum_architecture(self) -> DynamicQuantumArchitecture:
+        response = self._send_request(requests.get, "calibration-sets/default/dynamic-quantum-architecture")
+        return self._deserialize_response(response, DynamicQuantumArchitecture)
 
-        Args:
-            dut_label: Target DUT label
+    @cache
+    def get_dynamic_quantum_architecture(self, calibration_set_id: StrUUID) -> DynamicQuantumArchitecture:
+        response = self._send_request(
+            requests.get, f"calibration-sets/{calibration_set_id}/dynamic-quantum-architecture"
+        )
+        return self._deserialize_response(response, DynamicQuantumArchitecture)
 
-        Returns:
-            UUID of the latest saved calibration set.
+    def get_default_calibration_set_quality_metrics(self) -> QualityMetrics:
+        response = self._send_request(requests.get, "calibration-sets/default/metrics")
+        return self._deserialize_response(response, QualityMetrics)
 
-        """
-        observation_sets = self.query_observation_sets(
-            observation_set_type="calibration-set",
-            dut_label=dut_label,
-            invalid=False,
-            end_timestamp__isnull=False,  # Finalized
-            order_by="-end_timestamp",  # This requires SC version > 35.15
-            limit=1,
-        )
-        return observation_sets[0].observation_set_id
+    def get_calibration_set_quality_metrics(self, calibration_set_id: StrUUID) -> QualityMetrics:
+        response = self._send_request(requests.get, f"calibration-sets/{calibration_set_id}/metrics")
+        return self._deserialize_response(response, QualityMetrics)
 
     def get_duts(self) -> list[DutData]:
-        """Get DUTs of the station control."""
         response = self._send_request(requests.get, "duts")
-        return DutList.model_validate(response.json())
+        return self._deserialize_response(response, DutList)
 
     def get_dut_fields(self, dut_label: str) -> list[DutFieldData]:
-        """Get DUT fields for the specified DUT label from the database."""
         params = {"dut_label": dut_label}
         response = self._send_request(requests.get, "dut-fields", params=params)
-        return DutFieldDataList.model_validate(response.json())
+        return self._deserialize_response(response, DutFieldDataList)
 
     def query_sequence_metadatas(self, **kwargs) -> ListWithMeta[SequenceMetadataData]:
-        """Query sequence metadatas from the database.
-
-        Sequence metadatas are queried by the given query parameters. Currently supported query parameters:
-            - origin_id: str
-            - origin_id__in: list[str]
-            - origin_uri: str
-            - origin_uri__icontains: str
-            - created_timestamp__range: tuple[datetime, datetime]
-
-        Returns:
-            Sequence metadatas with some query related metadata.
-
-        """
         params = self._clean_query_parameters(SequenceMetadataData, **kwargs)
         response = self._send_request(requests.get, "sequence-metadatas", params=params)
-        return self._create_list_with_meta(response, SequenceMetadataDataList)
+        return self._deserialize_response(response, SequenceMetadataDataList, list_with_meta=True)
 
     def create_sequence_metadata(
         self, sequence_metadata_definition: SequenceMetadataDefinition
     ) -> SequenceMetadataData:
-        """Create sequence metadata in the database."""
         json_str = self._serialize_model(sequence_metadata_definition)
         response = self._send_request(requests.post, "sequence-metadatas", json_str=json_str)
-        return SequenceMetadataData.model_validate(response.json())
+        return self._deserialize_response(response, SequenceMetadataData)
 
     def save_sequence_result(self, sequence_result_definition: SequenceResultDefinition) -> SequenceResultData:
-        """Save sequence result in the database.
-
-        This method creates the object if it doesn't exist and completely replaces the "data" and "final" if it does.
-        Timestamps are assigned by the database. "modified_timestamp" is not set on initial creation,
-        but it's updated on each subsequent call.
-        """
         # FIXME: We don't have information if the object was created or updated. Thus, server always responds 200 (OK).
         json_str = self._serialize_model(sequence_result_definition)
         response = self._send_request(
             requests.put, f"sequence-results/{sequence_result_definition.sequence_id}", json_str=json_str
         )
-        return SequenceResultData.model_validate(response.json())
+        return self._deserialize_response(response, SequenceResultData)
 
-    def get_sequence_result(self, sequence_id: uuid.UUID) -> SequenceResultData:
-        """Get sequence result from the database."""
+    def get_sequence_result(self, sequence_id: StrUUID) -> SequenceResultData:
         response = self._send_request(requests.get, f"sequence-results/{sequence_id}")
-        return SequenceResultData.model_validate(response.json())
+        return self._deserialize_response(response, SequenceResultData)
+
+    @cache
+    def get_static_quantum_architecture(self, dut_label: str) -> StaticQuantumArchitecture:
+        response = self._send_request(requests.get, f"static-quantum-architectures/{dut_label}")
+        return self._deserialize_response(response, StaticQuantumArchitecture)
 
-    def get_job(self, job_id: uuid.UUID) -> JobData:
-        """Get job data."""
+    def get_job(self, job_id: StrUUID) -> JobData:
         response = self._send_request(requests.get, f"jobs/{job_id}")
-        return JobData.model_validate(response.json())
+        return self._deserialize_response(response, JobData)
+
+    def abort_job(self, job_id: StrUUID) -> None:
+        self._send_request(requests.post, f"jobs/{job_id}/abort")
 
     def _wait_job_completion(self, job_id: str, update_progress_callback: Callable[[Statuses], None] | None) -> bool:
         logger.info("Waiting for job ID: %s", job_id)
@@ -727,7 +543,7 @@ class StationControlClient:
 
     def _poll_job(self, job_id: str) -> JobData:
         response = self._send_request(requests.get, f"jobs/{job_id}")
-        job = JobData.model_validate(response.json())
+        job = self._deserialize_response(response, JobData)
         if job.job_status == JobExecutorStatus.FAILED:
             raise InternalServerError(f"Job: {job.job_id}\n{job.job_error}")
         return job
@@ -738,8 +554,6 @@ class StationControlClient:
 
         All Pydantic models should be serialized using this method, to keep the client behavior uniform.
 
-        TODO add a corresponding deserialization method.
-
         Args:
             model: Pydantic model to JSON-serialize.
 
@@ -751,79 +565,6 @@ class StationControlClient:
         # using the \uXXXX syntax, BaseModel.model_dump_json() keeps them in the produced JSON str.
         return model.model_dump_json()
 
-    def _send_request(
-        self,
-        http_method: Callable[..., requests.Response],
-        url_path: str,
-        *,
-        json_str: str | None = None,
-        octets: bytes | None = None,
-        params: dict[str, Any] | None = None,
-        headers: dict[str, str] | None = None,
-    ) -> requests.Response:
-        """Send a HTTP request.
-
-        Parameters ``json_str``, ``octets`` and ``params`` are mutually exclusive.
-        The first non-None argument (in this order) will be used to construct the body of the request.
-
-        Args:
-            http_method: HTTP method to use for the request, any of requests.[post|get|put|head|delete|patch|options].
-            url_path: URL for the request.
-            json_str: JSON string to store in the body, may contain arbitrary Unicode characters.
-            octets: Pre-serialized binary data to store in the body.
-            params: HTTP query to store in the body.
-            headers: Additional HTTP headers for the request. Some may be overridden.
-
-        Returns:
-            Response to the request.
-
-        Raises:
-            StationControlError: Request was not successful.
-
-        """
-        # Will raise an error if respectively an error response code is returned.
-        headers = headers or {}
-
-        if self._enable_opentelemetry:
-            parent_span_context = trace.set_span_in_context(trace.get_current_span())
-            propagate.inject(carrier=headers, context=parent_span_context)
-        # If token callback exists, use it to retrieve the token and add it to the headers
-        if self._get_token_callback:
-            headers["Authorization"] = self._get_token_callback()
-
-        # Build request options explicitly
-        http_request_options: dict[str, Any] = {}
-        if json_str is not None:
-            # Must be able to handle JSON strings with arbitrary unicode characters, so we use an explicit
-            # encoding into bytes, and set the headers so the recipient can decode the request body correctly.
-            http_request_options["data"] = json_str.encode("utf-8")
-            headers["Content-Type"] = "application/json; charset=UTF-8"
-        elif octets is not None:
-            http_request_options["data"] = octets
-            headers["Content-Type"] = "application/octet-stream"
-        elif params is not None:
-            http_request_options["params"] = params
-        # otherwise no body-related parameter will be passed to requests
-
-        if headers:
-            # do not pass empty headers dict
-            http_request_options["headers"] = headers
-
-        url = f"{self.root_url}/{url_path}"
-        # TODO SW-1387: Use v1 API
-        # url = f"{self.root_url}/{self.version}/{url_path}"
-        response = http_method(url, **http_request_options)
-        if not response.ok:
-            try:
-                response_json = response.json()
-                error_message = response_json["detail"]
-            except json.JSONDecodeError:
-                error_message = response.text
-
-            error_class = map_from_status_code_to_error(response.status_code)
-            raise error_class(error_message)
-        return response
-
     # TODO SW-1387: Remove this when using v1 API, not needed
     def _check_api_versions(self):
         client_api_version = self._get_client_api_version()
@@ -865,12 +606,29 @@ class StationControlClient:
             # Get only valid items by default, "invalid=None" would return also invalid ones.
             # This default has to be set on the client side, server side uses default "None".
             kwargs["invalid"] = False
-        # Remove None and {} values
-        return {key: value for key, value in kwargs.items() if value not in [None, {}]}
+        return _remove_empty_values(kwargs)
 
     @staticmethod
-    def _create_list_with_meta(response: requests.Response, list_model: type[ListModel[list[T]]]) -> ListWithMeta[T]:
-        response_with_meta = ResponseWithMeta(**response.json())
-        if response_with_meta.meta and response_with_meta.meta.errors:
-            logger.warning("Errors in station control response:\n  - %s", "\n  - ".join(response_with_meta.meta.errors))
-        return ListWithMeta(list_model.model_validate(response_with_meta.items), meta=response_with_meta.meta)
+    def _deserialize_response(
+        response: requests.Response,
+        model_class: type[TypePydanticBase] | type[ListModel[list[TypePydanticBase]]],
+        *,
+        list_with_meta: bool = False,
+    ) -> TypePydanticBase | ListWithMeta[TypePydanticBase]:
+        # Use "model_validate_json(response.text)" instead of "model_validate(response.json())".
+        # This validates the provided data as a JSON string or bytes object.
+        # If your incoming data is a JSON payload, this is generally considered faster.
+        if list_with_meta:
+            response_with_meta = ResponseWithMeta.model_validate_json(response.text)
+            if response_with_meta.meta and response_with_meta.meta.errors:
+                logger.warning(
+                    "Errors in station control response:\n  - %s", "\n  - ".join(response_with_meta.meta.errors)
+                )
+            return ListWithMeta(model_class.model_validate(response_with_meta.items), meta=response_with_meta.meta)
+        model = model_class.model_validate_json(response.text)
+        return model
+
+
+def _remove_empty_values(kwargs: dict[str, Any]) -> dict[str, Any]:
+    """Return a copy of the given dict without values that are None or {}."""
+    return {key: value for key, value in kwargs.items() if value not in [None, {}]}