boulder-opal-scale-up-sdk 1.0.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

{boulder_opal_scale_up_sdk-1.0.0.dist-info → boulder_opal_scale_up_sdk-1.0.2.dist-info}/METADATA

@@ -1,24 +1,23 @@
 Metadata-Version: 2.3
 Name: boulder-opal-scale-up-sdk
-Version: 1.0.0
+Version: 1.0.2
 Summary: Q-CTRL Boulder Opal Scale Up Python SDK
-License: Apache-2.0
+License: https://q-ctrl.com/terms
 Keywords: black opal,boulder opal,fire opal,nisq,open controls,q control,q ctrl,q-control,q-ctrl,qcontrol,qctrl,quantum,quantum algorithms,quantum circuits,quantum coding,quantum coding software,quantum computing,quantum control,quantum control software,quantum control theory,quantum engineering,quantum error correction,quantum firmware,quantum fundamentals,quantum sensing,qubit,qudit
 Author: Q-CTRL
 Author-email: support@q-ctrl.com
 Maintainer: Q-CTRL
 Maintainer-email: support@q-ctrl.com
-Requires-Python: >=3.10,<3.13
+Requires-Python: >=3.11,<3.13
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: Apache Software License
+Classifier: License :: Other/Proprietary License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Internet :: WWW/HTTP
@@ -26,13 +25,24 @@ Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Scientific/Engineering :: Visualization
 Classifier: Topic :: Software Development :: Embedded Systems
 Classifier: Topic :: System :: Distributed Computing
-Requires-Dist: async-timeout (>=4.0.3,<5.0.0) ; python_version < "3.11"
+Provides-Extra: quantum-machines
 Requires-Dist: attrs (>=25.1.0,<26.0.0)
 Requires-Dist: googleapis-common-protos (>=1.69.2,<2.0.0)
-Requires-Dist: qctrl-client (>=10.1.0,<11.0.0)
+Requires-Dist: numpy (>=1.26.4,<2.0.0)
+Requires-Dist: pydantic (>=2.10.4,<3.0.0)
+Requires-Dist: pydantic-settings (>=2.7.0,<3.0.0)
+Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
+Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
+Requires-Dist: qm-qua (==1.2.1) ; extra == "quantum-machines"
 Project-URL: Facebook, https://www.facebook.com/qctrl
 Project-URL: GitHub, https://github.com/qctrl
 Project-URL: Homepage, https://q-ctrl.com
 Project-URL: LinkedIn, https://www.linkedin.com/company/q-ctrl/
 Project-URL: X, https://x.com/qctrlHQ
 Project-URL: YouTube, https://www.youtube.com/qctrl
+Description-Content-Type: text/markdown
+
+# Boulder Opal Scale Up SDK
+
+The Boulder Opal Scale Up SDK package is a Python SDK for Q-CTRL Boulder Opal Scale Up. Scale Up provides a tailored solution to characterize and calibrate quantum hardware.
+

boulder_opal_scale_up_sdk-1.0.2.dist-info/RECORD

@@ -0,0 +1,60 @@
+boulderopalscaleupsdk/__init__.py,sha256=nD3YDqPiE52mmuUrIlDUrYSyljpMsDJvc5HsubBUSs4,592
+boulderopalscaleupsdk/agent/__init__.py,sha256=aFkAtHJDOdXA126JklxYz0ix1k4lCcLLS9DQp8zUKMk,1092
+boulderopalscaleupsdk/agent/worker.py,sha256=XlbjvAjQgKMpRbbI04jzVY9NzqW5nO_D5wFq7fJC-qM,7937
+boulderopalscaleupsdk/common/__init__.py,sha256=vLaJ1FP36xV5eX6VD7nShqxVBm3UzsBMIK1pmSiTIag,550
+boulderopalscaleupsdk/common/dtypes.py,sha256=1Lf-kulA0vxFMCW1E5nfHifoCTOtq76fDwQTSco_qCQ,9601
+boulderopalscaleupsdk/common/typeclasses.py,sha256=FZHyTcuCQH5niqFPZmIyoO2zN6mA661h8kyvDcYFryg,3033
+boulderopalscaleupsdk/device/__init__.py,sha256=Bbo9KYQqNZloj2H9sl2PdfFvYMDS78q1Mu0Q0q5Ze5o,727
+boulderopalscaleupsdk/device/common.py,sha256=ZLXpmORKQYntX7DeKZ8pd49Ju1jzidR2q2EeN3TNwTI,1909
+boulderopalscaleupsdk/device/config_loader.py,sha256=RxCD77Z52lVaMYcimdyxoz9V3hb1Q5ta4xk1eU7wwxM,3367
+boulderopalscaleupsdk/device/controller/__init__.py,sha256=ePkrCbX1ORm05fS0BEQ8cx7DPxGGN6IkUoNH6eQL1DM,1136
+boulderopalscaleupsdk/device/controller/base.py,sha256=xuT4VzRulknxppiQpzYYn_TwuRNfV9wHMqjN2okA8Lw,793
+boulderopalscaleupsdk/device/controller/qblox.py,sha256=c-wG9jAZHy6hCTO7ynKvwJbW1MPNJJh9ryfedthuuz8,22543
+boulderopalscaleupsdk/device/controller/quantum_machines.py,sha256=m0_zO7Cn-Ea1-ewG7qgjEnt4GXtQMvBv_oz-dnOmI9k,5320
+boulderopalscaleupsdk/device/controller/resolver.py,sha256=hW5U58dmJf_IGmD4EK_bbn0XU-N9autFBFHmqbRnY2Y,3812
+boulderopalscaleupsdk/device/defcal.py,sha256=CL9T-oy94st20NyQZWW8mHJU4Nlx2DKZ-o5x1mf6L8c,1912
+boulderopalscaleupsdk/device/device.py,sha256=e3jW6dTFmGAxniPLTSTRVQs5HUkSUvrqolOlv2xJKUw,1243
+boulderopalscaleupsdk/device/processor/__init__.py,sha256=O9d4tMcii3OOGez845qXp06D_AxYMoHr-7ICEStlNro,1038
+boulderopalscaleupsdk/device/processor/common.py,sha256=kRR5nufc8PoTDLxXbSeuprlCgBDrPHSdPom_go9fDOs,9136
+boulderopalscaleupsdk/device/processor/superconducting_processor.py,sha256=c6Au_j5db611xOJF0zy6bpOanhm-7QYAMWerfKMwjzQ,12269
+boulderopalscaleupsdk/experiments/__init__.py,sha256=kskcl-oMR8tRMo8_liSqmty82mtbl3WzB-IY5g88ng4,1628
+boulderopalscaleupsdk/experiments/chi01_scan.py,sha256=qPFa6R1IJmctRId8K-DPejX5P0LXqXUmC-NO6-xmCQU,1862
+boulderopalscaleupsdk/experiments/common.py,sha256=sT06O3I71iEY5AmXGRZfx-V6RQlBEq5B7hCRxnG64tM,2482
+boulderopalscaleupsdk/experiments/power_rabi.py,sha256=_keqv3tW10d-1vnUPTsky9FvLnjFcKF3pcnYfOyNvaI,2059
+boulderopalscaleupsdk/experiments/ramsey.py,sha256=R3pptmkqwHYhhlAyRbYBaSscuiB3RffodC23kKuqwFY,2050
+boulderopalscaleupsdk/experiments/readout_classifier_calibration.py,sha256=mUgKgKiXTv4owykR6nYj-DYZvplR5Xr9Akj36b7WGA4,732
+boulderopalscaleupsdk/experiments/resonator_spectroscopy.py,sha256=EmmLbDq0d-67F1D6biLlUd1-UYP4uiICSkrIeez2T1I,2191
+boulderopalscaleupsdk/experiments/resonator_spectroscopy_by_bias.py,sha256=ypb3ZX-OCzQGy3vSlpRct5MGZmvMMZk7pi8dD9EU5VU,2765
+boulderopalscaleupsdk/experiments/resonator_spectroscopy_by_power.py,sha256=N1ibW6ZWSrsRs6-es0bBGkRSc-1WeqU4pwpKRSpZBhE,2225
+boulderopalscaleupsdk/experiments/transmon_anharmonicity.py,sha256=5nb_wTHJ_rhNGAR7THAL2YNvBZKPFJmMwjamPKgP8ko,2706
+boulderopalscaleupsdk/experiments/transmon_spectroscopy.py,sha256=Ib1OdJwCE7m0Q3N_l0Mx8uKBO6GjjM56BDroLDVCBRI,2324
+boulderopalscaleupsdk/grpc_interceptors/__init__.py,sha256=PkdOlllLbRWycofvGCCxDY60Ydp_U0QM5l4u3Fsnno4,616
+boulderopalscaleupsdk/grpc_interceptors/auth.py,sha256=PSe_b9ckqhcb3xf1Y4jpn1TjfEWfokkarqfUHIz6HIs,4165
+boulderopalscaleupsdk/plotting/__init__.py,sha256=pkdCky3YHqc3PLRy_h9puJKAO4AqSJGebb26x7XayR4,959
+boulderopalscaleupsdk/plotting/dtypes.py,sha256=PlVzGpoZfrqVULPJfpRQq3JmgjUgVH7ZPdPkIys_AnE,4737
+boulderopalscaleupsdk/protobuf/v1/agent_pb2.py,sha256=yExXTLC3g_TnHJWkfYsF_kctsftxONyZOBtOFDTTuec,5364
+boulderopalscaleupsdk/protobuf/v1/agent_pb2.pyi,sha256=YJdOKaOtI2PGk7ct_LuC8_6NeKsLCXMriVEt4-0TWYM,2536
+boulderopalscaleupsdk/protobuf/v1/agent_pb2_grpc.py,sha256=UH8u9ZmvMjteAYKtTmA-IWSGZmhCQLHdg0_OuKCaYew,6875
+boulderopalscaleupsdk/protobuf/v1/device_pb2.py,sha256=lu-FLsrwT_xnG0411zN2lE1yvtpIiMF22M8hvCpP4Zk,11429
+boulderopalscaleupsdk/protobuf/v1/device_pb2.pyi,sha256=NCrnlIXEsTKZaXjgEdy1cXxgOu4Xli0qbUm4_mOXqf8,6527
+boulderopalscaleupsdk/protobuf/v1/device_pb2_grpc.py,sha256=0CtrO8gKkcfHn7flQLFAySyOVpdDgzct_EaMMF73rUY,19445
+boulderopalscaleupsdk/protobuf/v1/task_pb2.py,sha256=7NWFFBEPij8B9dvexRia3B_T9-oOCDwayASCglvBtO4,7086
+boulderopalscaleupsdk/protobuf/v1/task_pb2.pyi,sha256=QWciGKFD1AcaAhqgym0ZwNtIlNT85HhOTBdivEC6QJE,5952
+boulderopalscaleupsdk/protobuf/v1/task_pb2_grpc.py,sha256=yP2FZ148RmSYFHivatCXuM13oRBDA5wBwmvhZQNBTXQ,5826
+boulderopalscaleupsdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+boulderopalscaleupsdk/routines/__init__.py,sha256=jSrTzE_d-4z-wA8NK9akzVtUJJ_CG026qs8orMuWKfk,143
+boulderopalscaleupsdk/routines/common.py,sha256=Lav4eH4GJyRJXBZwmhA3b34UTgck5x4URex3SBSctwM,224
+boulderopalscaleupsdk/routines/resonator_mapping.py,sha256=A7Z5jGicezYMxvC4yeRrLu-MbYHfMaZ6h2AuMwBPrBo,475
+boulderopalscaleupsdk/stubs/__init__.py,sha256=vLaJ1FP36xV5eX6VD7nShqxVBm3UzsBMIK1pmSiTIag,550
+boulderopalscaleupsdk/stubs/dtypes.py,sha256=VH2QqmmaSegv03KEaZBqB-REHhvk5h3GPfQgCJTAYQE,1361
+boulderopalscaleupsdk/stubs/maps.py,sha256=fgEwVyaJ1i5io_NCAABJb7Cyyl_zgdjb8xot75ujw8U,575
+boulderopalscaleupsdk/third_party/__init__.py,sha256=b9T2IVfz9bMenSsLQuaf4A14ySinjNnSGx68hLsFHZE,596
+boulderopalscaleupsdk/third_party/quantum_machines/__init__.py,sha256=ORD6crMw6gtoIp8dmusdwSiU4pje739fOacOfHXSOls,2541
+boulderopalscaleupsdk/third_party/quantum_machines/config.py,sha256=tQsWx_nSXSFT4fRuMzuvliplyRsB9Sy70kHqsKuTA-A,20756
+boulderopalscaleupsdk/third_party/quantum_machines/constants.py,sha256=5PpAi6MZ53yEinBHerY2ssi30BR37JnLBWL21irpZ8Y,870
+boulderopalscaleupsdk/utils/__init__.py,sha256=vLaJ1FP36xV5eX6VD7nShqxVBm3UzsBMIK1pmSiTIag,550
+boulderopalscaleupsdk/utils/serial_utils.py,sha256=SzvY-WFD0b8IGSh6PTv7F9y1W2IPPYmj8pY3AsX-xlM,2062
+boulder_opal_scale_up_sdk-1.0.2.dist-info/LICENSE,sha256=wqX4S5Brcwkwo750l9grSspwm0cyMsZtZEa1Vx3_WiE,36587
+boulder_opal_scale_up_sdk-1.0.2.dist-info/METADATA,sha256=SPWPGe2xUsza1tnuUBCgVzXHcBrJCxCVbz0Zrr5HlII,2419
+boulder_opal_scale_up_sdk-1.0.2.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+boulder_opal_scale_up_sdk-1.0.2.dist-info/RECORD,,

boulderopalscaleupsdk/agent/worker.py

@@ -27,6 +27,7 @@ from grpc import aio as grpc
 from grpc import ssl_channel_credentials
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
+from boulderopalscaleupsdk.common.dtypes import GrpcMetadata
 from boulderopalscaleupsdk.protobuf.v1 import agent_pb2, task_pb2, task_pb2_grpc
 
 LOG = logging.getLogger(__name__)
@@ -51,11 +52,11 @@ class TaskHandler(Protocol):
     @abstractmethod
     async def handle(
         self,
-        request: agent_pb2.RunQuaProgramRequest
+        request: agent_pb2.RunProgramRequest
         | agent_pb2.RunQuantumMachinesMixerCalibrationRequest
         | agent_pb2.DisplayResultsRequest,
     ) -> (
-        agent_pb2.RunQuaProgramResponse
+        agent_pb2.RunProgramResponse
         | agent_pb2.RunQuantumMachinesMixerCalibrationResponse
         | agent_pb2.DisplayResultsResponse
         | task_pb2.TaskErrorDetail
@@ -66,7 +67,7 @@ class TaskHandler(Protocol):
         task: task_pb2.Task,
     ) -> any_pb2.Any | task_pb2.TaskErrorDetail:
         request = (
-            _as_run_qua_program_request(
+            _as_run_program_request(
                 task.data,
             )
             or _as_run_qua_calibration_request(task.data)
@@ -74,7 +75,7 @@ class TaskHandler(Protocol):
         )
         match request:
             case (
-                agent_pb2.RunQuaProgramRequest()
+                agent_pb2.RunProgramRequest()
                 | agent_pb2.RunQuantumMachinesMixerCalibrationRequest()
                 | agent_pb2.DisplayResultsRequest()
             ):
@@ -92,10 +93,10 @@ def _as_any_message(message: Message) -> any_pb2.Any:
     return msg
 
 
-def _as_run_qua_program_request(
+def _as_run_program_request(
     task_result: any_pb2.Any,
-) -> agent_pb2.RunQuaProgramRequest | None:
-    request = agent_pb2.RunQuaProgramRequest()
+) -> agent_pb2.RunProgramRequest | None:
+    request = agent_pb2.RunProgramRequest()
     unpacked: bool = task_result.Unpack(request)  # type: ignore[reportUnknownMemberType]
     if not unpacked:
         return None
@@ -158,7 +159,10 @@ class Agent:
         """
         host = url.split(":")[0]
         if host in ["localhost", "127.0.0.1", "0.0.0.0", "::"]:
-            channel = grpc.insecure_channel(url)
+            channel = grpc.insecure_channel(
+                url,
+                interceptors=interceptors,
+            )
         else:
             channel = grpc.secure_channel(
                 url,
@@ -170,12 +174,13 @@ class Agent:
     async def start_session(
         self,
         app: str,
+        metadata: GrpcMetadata,
         device_name: str,
         routine: str,
         data: Struct | None,
     ) -> str:
         if not self._channel:
-            raise RuntimeError("Agent is shutdown.")
+            raise RuntimeError("Cannot start session: agent is shutdown.")
         _data = any_pb2.Any()
         if data:
             _data.Pack(data)
@@ -188,13 +193,18 @@ class Agent:
                 routine_name=routine,
                 data=_data,
             ),
+            metadata=metadata,
         )
         self._state = response.target_state
-        await self._resume(response)
+        await self._resume(response, metadata)
         await self.shutdown()
         return response.session_id
 
-    async def _resume(self, response: task_pb2.AgentTasksResponse) -> None:
+    async def _resume(
+        self,
+        response: task_pb2.AgentTasksResponse,
+        metadata: GrpcMetadata,
+    ) -> None:
         tasks = response.tasks
         while self._state not in [
             task_pb2.AGENT_STATE_SHUTDOWN_MANAGER_INITIATED,
@@ -228,6 +238,7 @@ class Agent:
                     results=task_results,
                     task_in_progress=[],
                 ),
+                metadata=metadata,
             )
 
             tasks = _resp.tasks

boulderopalscaleupsdk/common/dtypes.py

@@ -13,6 +13,7 @@
 
 from __future__ import annotations
 
+import enum
 from typing import overload
 
 __all__ = [
@@ -21,38 +22,32 @@ __all__ = [
     "TimeUnit",
 ]
 
-import sys
-from dataclasses import dataclass, field
 from datetime import datetime, timedelta
 from decimal import Decimal
-from enum import Enum
-from typing import Annotated, Any, Literal
+from typing import Annotated, Any, Literal, Self
 
 import numpy as np
 from dateutil.parser import isoparse
-from pydantic import BeforeValidator, PlainSerializer, TypeAdapter
-from pydantic.dataclasses import dataclass as pydantic_dataclass
+from pydantic import BeforeValidator, ConfigDict, Field, PlainSerializer, TypeAdapter
+from pydantic.dataclasses import dataclass
 
-if sys.version_info >= (3, 11):
-    from typing import Self
-else:
-    from typing_extensions import Self
+GrpcMetadata = list[tuple[str, str | bytes]]
 
 
 class BaseType: ...
 
 
-class FrequencyUnit(str, Enum):
+class FrequencyUnit(str, enum.Enum):
     Hz = "Hz"
 
 
-@pydantic_dataclass
+@dataclass
 class Frequency:
     value: float
     unit: FrequencyUnit  # No default to guarantee clarity of units
 
     @classmethod
-    def from_float_hz(cls, value: float) -> Frequency:
+    def from_float_hz(cls, value: float) -> Self:
         return cls(value, FrequencyUnit.Hz)
 
     def to_int_hz(self) -> int:
@@ -120,92 +115,30 @@ class Frequency:
         return self.__mul__(lhs)
 
 
-class TimeUnit(str, Enum):
+class TimeUnit(str, enum.Enum):
     S = "s"
     MS = "ms"
     US = "us"
     NS = "ns"
-    DT = "dt"
 
 
-_SI_TIME = Literal[TimeUnit.S, TimeUnit.MS, TimeUnit.US, TimeUnit.NS]
+@dataclass
+class InvalidDurationDiv:
+    message: str
+    data: Duration
 
 
-@pydantic_dataclass(order=True)
-class Duration(BaseType):
-    """
-    A wrapper of _SiDuration and _DtDuration to manage the conversion.
-    """
+@dataclass
+class InvalidDurationConversion:
+    message: str
 
-    value: int = field(compare=False)
-    unit: TimeUnit = field(compare=False)
-    dtype: Literal["duration"] = "duration"
-    _value: _SiDuration | _DtDuration = field(init=False, repr=False)
-
-    def __post_init__(self):
-        self._value = (
-            _DtDuration(self.value)
-            if self.unit == TimeUnit.DT
-            else _SiDuration(self.value, self.unit)
-        )
-
-    def is_si(self) -> bool:
-        return self.unit != TimeUnit.DT
-
-    @staticmethod
-    def from_si(d: Duration, name: str) -> Duration:
-        if d.unit == TimeUnit.DT:
-            raise TypeError(f"{name} must use SI time unit.")
-        return d
-
-    @staticmethod
-    def from_intlike(val: float, unit: TimeUnit) -> Duration:
-        if not np.double(val).is_integer():
-            raise ValueError("fail to create a Duration object. value must be an integer.")
-        return Duration(int(val), unit)
-
-    def convert(self, target: Duration | _SI_TIME) -> Duration:
-        """
-        In particular, we only allow the following conversions:
-
-        # ((1000, "ms"), "s") -> (1, "s")
-        (_SiDuration, _SI_TIME) -> _SiDuration
 
-        # ((4, "ns"), (2, "ns")) -> (2, "dt")
-        (_SiDuration, _SiDuration) -> _DtDuration
-
-        # ((2, "dt"), (2, "ns")) -> (4, "ns")
-        (_DtDuration, _SiDuration) _> _SiDuration
-        """
-        match self._value, getattr(target, "_value", target):
-            case _SiDuration(
-                _,
-                _,
-            ), TimeUnit.S | TimeUnit.MS | TimeUnit.US | TimeUnit.NS:
-                converted = self._value.convert_to_si(target)  # type: ignore[arg-type]  # pyright: ignore[reportArgumentType]
-            case _SiDuration(_, _), _SiDuration(_, _):
-                converted = self._value.convert_to_dt(target)  # type: ignore[arg-type, assignment] # pyright: ignore[reportArgumentType]
-            case _DtDuration(_, _), _SiDuration(_, _):
-                converted = self._value.convert(target)  # type: ignore[arg-type] # pyright: ignore[reportArgumentType]
-            case _:
-                raise TypeError(f"cant't convert type {self.unit} to {target}")
-        return Duration(converted.value, converted.unit)
-
-
-@dataclass(order=True)
-class _DtDuration(BaseType):
+@dataclass(config=ConfigDict(arbitrary_types_allowed=True))
+class Duration:
     value: int
-    unit: Literal[TimeUnit.DT] = TimeUnit.DT
-
-    def convert(self, target: _SiDuration) -> _SiDuration:
-        return _SiDuration(self.value * target.value, target.unit)
-
-
-@dataclass(order=True)
-class _SiDuration(BaseType):
-    value: int = field(compare=False)
-    unit: _SI_TIME = field(compare=False)
-    _np_rep: np.timedelta64 = field(init=False, repr=False)
+    unit: TimeUnit
+    dtype: Literal["duration"] = "duration"
+    _np_rep: np.timedelta64 = Field(init=False, repr=False, exclude=True)
 
     def __post_init__(self):
         err = TypeError(
@@ -223,30 +156,54 @@ class _SiDuration(BaseType):
         except ValueError as e:
             raise err from e
 
-    def convert_to_dt(self, clock: _SiDuration) -> _DtDuration:
-        try:
-            converted_si = self.convert_to_si(clock.unit)
-        except TypeError as e:
-            raise TypeError(
-                "fail to convert to dt type. Consider rescaling the clock time.",
-            ) from e
-        val = np.double(converted_si.value / clock.value)
-        # N.B, this might be too strict. Some rounding might be necessary.
-        if not val.is_integer():
-            raise TypeError(
-                "fail to convert to dt type. Consider rescaling the clock time.",
-            )
-        return _DtDuration(int(val))
-
-    def convert_to_si(self, unit: _SI_TIME) -> _SiDuration:
-        if self._np_rep is None:
-            raise TypeError("`convert` only support SI time unit.")
+    def __gt__(self, other: Duration) -> bool:
+        return bool(self._np_rep > other._np_rep)
+
+    def __ge__(self, other: Duration) -> bool:
+        return bool(self._np_rep >= other._np_rep)
+
+    def __lt__(self, other: Duration) -> bool:
+        return bool(self._np_rep < other._np_rep)
+
+    def __le__(self, other: Duration) -> bool:
+        return bool(self._np_rep <= other._np_rep)
+
+    def __eq__(self, other: object) -> bool:
+        if isinstance(other, Duration):
+            return bool(self._np_rep == other._np_rep)
+        return False
+
+    def convert(self, unit: TimeUnit) -> Duration | InvalidDurationConversion:
         val: np.float64 = self._np_rep / np.timedelta64(1, unit)
-        if not val.is_integer():
-            raise TypeError(
-                f"fail to convert to {unit} with {self.value}{self.unit}.",
-            )
-        return _SiDuration(int(val), unit)
+        if val.is_integer():
+            return Duration(int(val), unit)
+        return InvalidDurationConversion(
+            f"fail to convert to {unit} with {self.value} {self.unit}.",
+        )
+
+    def to_ns(self) -> Duration:
+        match self.convert(TimeUnit.NS):
+            case InvalidDurationConversion():
+                raise TypeError(f"Cannot convert {self} to nanoseconds.")
+            case converted:
+                return converted
+
+    def strict_div(self, other: Duration) -> Duration | InvalidDurationDiv:
+        self_ns = self.to_ns()
+        other_ns = other.to_ns()
+        val = np.double(self_ns.value / other_ns.value)
+        if np.isclose(val, 0):
+            return Duration(int(val), TimeUnit.NS)
+        return InvalidDurationDiv(
+            f"{self} is not a multiple of {other}",
+            Duration(int(val), TimeUnit.NS),
+        )
+
+    @staticmethod
+    def from_intlike(val: float, unit: TimeUnit) -> Duration:
+        if not np.double(val).is_integer():
+            raise ValueError("Failed to create a Duration object. Value must be an integer.")
+        return Duration(int(val), unit)
 
     def to_seconds(self) -> float:
         return float(self._np_rep / np.timedelta64(1, "s"))
@@ -261,7 +218,7 @@ def ensure_frequency_hz(value: Any) -> Any:
         case dict():
             return TypeAdapter(Frequency).validate_python(value)
         case _:
-            raise ValueError("Frequency needs to be numeric.")
+            raise ValueError("Frequency must be numeric.")
 
 
 FrequencyHzLike = Annotated[
@@ -280,13 +237,13 @@ def ensure_duration_ns(value: Any) -> Any:
         case dict():
             return TypeAdapter(Duration).validate_python(value)
         case _:
-            raise ValueError("Duration needs to be numeric")
+            raise ValueError("Duration must be numeric.")
 
 
 DurationNsLike = Annotated[Duration, BeforeValidator(ensure_duration_ns)]
 
 
-@pydantic_dataclass
+@dataclass
 class ISO8601Datetime:
     value: datetime
 
@@ -351,3 +308,13 @@ ISO8601DatetimeUTCLike = Annotated[
     BeforeValidator(_validate_iso_datetime),
     PlainSerializer(_serialize_datetime),
 ]
+
+
+class JobHistorySortOrder(enum.Enum):
+    CREATED_AT_DESC = 1
+    CREATED_AT_ASC = 2
+
+
+DEFAULT_JOB_HISTORY_PAGE = 1
+DEFAULT_JOB_HISTORY_PAGE_SIZE = 10
+DEFAULT_JOB_HISTORY_SORT_ORDER = JobHistorySortOrder.CREATED_AT_DESC

boulderopalscaleupsdk/device/__init__.py

@@ -13,4 +13,8 @@
 
 __all__ = ["Device", "InvalidDevice", "InvalidDeviceComponent"]
 
-from boulderopalscaleupsdk.device.device import Device, InvalidDevice, InvalidDeviceComponent
+from boulderopalscaleupsdk.device.device import (
+    Device,
+    InvalidDevice,
+    InvalidDeviceComponent,
+)

boulderopalscaleupsdk/device/config_loader.py

@@ -16,9 +16,13 @@ from pathlib import Path
 from typing import Any
 
 import yaml
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel
 
-from boulderopalscaleupsdk.device.controller.quantum_machines import QuantumMachinesControllerInfo
+from boulderopalscaleupsdk.device.controller import (
+    ControllerInfoTypeAdapter,
+    QBLOXControllerInfo,
+    QuantumMachinesControllerInfo,
+)
 from boulderopalscaleupsdk.device.processor import (
     SuperconductingProcessor,
     SuperconductingProcessorTemplate,
@@ -31,11 +35,9 @@ class ProcessorArchitecture(str, Enum):
 
 
 class DeviceInfo(BaseModel):
-    controller_info: QuantumMachinesControllerInfo  # | OtherControllerInfoTypes
+    controller_info: QBLOXControllerInfo | QuantumMachinesControllerInfo
     processor: SuperconductingProcessor  # | OtherSDKProcessorType
 
-    model_config = ConfigDict(use_enum_values=True)
-
     def to_dict(self) -> dict[str, Any]:
         return sanitize_keys(self.model_dump(by_alias=True, mode="json"))
 
@@ -49,10 +51,13 @@ class DeviceConfigLoader:
 
         layout_file = device_config_data.pop("layout_file", None)
         if layout_file is None:
-            raise ValueError("layout file is missing in the device configuration data.")
-        self._validate_file_is_filename(layout_file)
+            raise ValueError("Layout file is missing from device configuration data.")
+
+        layout_path = Path(layout_file)
+        if not layout_path.is_absolute():
+            self._validate_file_is_filename(layout_path.name)
+            layout_path = self.config_path.parent / layout_file
 
-        layout_path = self.config_path.parent / layout_file
         device_layout_data = self._load_yaml_file(layout_path)
 
         processed_device_config = {**device_config_data, **device_layout_data}
@@ -66,13 +71,13 @@ class DeviceConfigLoader:
                     device_config_dict,
                 )
                 device_info = DeviceInfo(
-                    controller_info=QuantumMachinesControllerInfo.model_validate(
+                    controller_info=ControllerInfoTypeAdapter.validate_python(
                         device_config_dict["controller_info"],
                     ),
                     processor=SuperconductingProcessor.from_template(superconducting_template),
                 )
             case other:
-                raise ValueError(f"Invalid or unsupported architecture {other}")
+                raise ValueError(f"Invalid or unsupported architecture {other}.")
         return device_info
 
     @staticmethod

boulderopalscaleupsdk/device/controller/__init__.py

@@ -12,21 +12,24 @@
 # License for the specific language.
 
 __all__ = [
-    "BaseControllerInfo",
-    "DrivePortConfig",
-    "FluxPortConfig",
-    "OctaveConfig",
-    "PortRef",
+    "ControllerType",
+    "QBLOXControllerInfo",
     "QuantumMachinesControllerInfo",
-    "ReadoutPortConfig",
 ]
 
-from .base import BaseControllerInfo
-from .quantum_machines import (
-    DrivePortConfig,
-    FluxPortConfig,
-    OctaveConfig,
-    PortRef,
-    QuantumMachinesControllerInfo,
-    ReadoutPortConfig,
+from typing import TypeVar
+
+from pydantic import TypeAdapter
+
+from .base import ControllerType
+from .qblox import QBLOXControllerInfo
+from .quantum_machines import QuantumMachinesControllerInfo
+
+ControllerInfoType = TypeVar(
+    "ControllerInfoType",
+    bound=QBLOXControllerInfo | QuantumMachinesControllerInfo,
+)
+
+ControllerInfoTypeAdapter: TypeAdapter[QBLOXControllerInfo | QuantumMachinesControllerInfo] = (
+    TypeAdapter(QBLOXControllerInfo | QuantumMachinesControllerInfo)
 )

boulderopalscaleupsdk/device/controller/base.py

@@ -11,8 +11,17 @@
 # distributed under the License is distributed on an "AS IS" BASIS. See the
 # License for the specific language.
 
-from pydantic import BaseModel
 
+import enum
 
-class BaseControllerInfo(BaseModel):
-    """Base controller info."""
+
+class ControllerType(str, enum.Enum):
+    QUANTUM_MACHINES = "quantum_machines"
+    QBLOX = "qblox"
+
+
+class Backend(str, enum.Enum):
+    QUA = "QUA"
+    QBLOX = "QBLOX"
+    OPENQASM = "OPENQASM"
+    QBLOX_Q1ASM = "QBLOX_Q1ASM"