boulder-opal-scale-up-sdk 1.0.5__py3-none-any.whl → 1.0.6__py3-none-any.whl

boulderopalscaleupsdk/protobuf/v1/job_pb2_grpc.py

@@ -0,0 +1,138 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+
+from boulderopalscaleupsdk.protobuf.v1 import job_pb2 as boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2
+
+
+class JobManagerServiceStub(object):
+    """Job manager service.
+    """
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.List = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.JobManagerService/List',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.ListRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.ListResponse.FromString,
+                )
+        self.Get = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.JobManagerService/Get',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.GetRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.GetResponse.FromString,
+                )
+        self.GetSummary = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.JobManagerService/GetSummary',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.GetSummaryRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.GetSummaryResponse.FromString,
+                )
+
+
+class JobManagerServiceServicer(object):
+    """Job manager service.
+    """
+
+    def List(self, request, context):
+        """Fetch all the jobs that have been run on the device.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def Get(self, request, context):
+        """Fetch the results of a specific job executed on the device previously.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def GetSummary(self, request, context):
+        """Fetch the results view of a previously executed job.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_JobManagerServiceServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'List': grpc.unary_unary_rpc_method_handler(
+                    servicer.List,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.ListRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.ListResponse.SerializeToString,
+            ),
+            'Get': grpc.unary_unary_rpc_method_handler(
+                    servicer.Get,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.GetRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.GetResponse.SerializeToString,
+            ),
+            'GetSummary': grpc.unary_unary_rpc_method_handler(
+                    servicer.GetSummary,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.GetSummaryRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.GetSummaryResponse.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'boulderopalscaleupsdk.protobuf.v1.JobManagerService', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+
+
+ # This class is part of an EXPERIMENTAL API.
+class JobManagerService(object):
+    """Job manager service.
+    """
+
+    @staticmethod
+    def List(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/boulderopalscaleupsdk.protobuf.v1.JobManagerService/List',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.ListRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.ListResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def Get(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/boulderopalscaleupsdk.protobuf.v1.JobManagerService/Get',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.GetRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.GetResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def GetSummary(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/boulderopalscaleupsdk.protobuf.v1.JobManagerService/GetSummary',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.GetSummaryRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_job__pb2.GetSummaryResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

boulderopalscaleupsdk/third_party/quantum_machines/__init__.py

@@ -34,7 +34,7 @@ from unittest.mock import patch
 
 from packaging.version import Version
 
-if os.environ.get("QCTRL_SU_DISABLE_QM_LOGGING", "False") == "True":
+if os.getenv("QCTRL_SU_DISABLE_QM_LOGGING", "False") == "True":
     # Disable QM logging and telemetry
     os.environ["QM_DISABLE_STREAMOUTPUT"] = "true"  # Used in 1.1.0
     _qm_logger = logging.getLogger("qm")

boulderopalscaleupsdk/third_party/quantum_machines/config.py

@@ -84,13 +84,12 @@ For information about PyPA's version specifiers:
 
 # ruff: noqa: UP007, N815, E741
 from collections.abc import MutableMapping
-from typing import Annotated, Any, Literal, Self, TypeVar, Union
+from typing import Annotated, Literal, NamedTuple, Self, TypeVar, Union
 
 from packaging.specifiers import SpecifierSet
 from packaging.version import Version
 from pydantic import (
     BaseModel,
-    BeforeValidator,
     Discriminator,
     Field,
     PrivateAttr,
@@ -125,8 +124,18 @@ class Constants(BaseSettings):
 CONST = Constants()
 
 
-StandardPort = tuple[str, int, int]
-PortReferenceType = Union[tuple[str, int], StandardPort]
+class NativeOPXPortType(NamedTuple):
+    controller_id: str
+    port_id: int
+
+
+class NativeOPX1000PortType(NamedTuple):
+    controller_id: str
+    fem_id: int
+    port_id: int
+
+
+QMPortTypes = NativeOPXPortType | NativeOPX1000PortType
 
 
 class AnalogOutputFilterConfigType(BaseModel):
@@ -134,24 +143,19 @@ class AnalogOutputFilterConfigType(BaseModel):
     feedback: list[float] = []
 
 
-def ensure_int(value: Any) -> Any:
-    match value:
-        case int():
-            return value
-        case str():
-            return int(value)
-        case _:
-            raise ValueError("Field must be convertible to int.")
-
-
-IntLike = Annotated[int, BeforeValidator(ensure_int)]
+class AnalogOutputFilterConfigType123(BaseModel):
+    feedforward: list[float] = []
+    feedback: list[float] = []
+    exponential: list[tuple[float, int]] = []
+    exponential_dc_gain: float | None = None
+    high_pass: float | None = None
 
 
 class AnalogOutputPortConfigType(BaseModel):
     offset: Number | None = None
     filter: AnalogOutputFilterConfigType | None = None
     delay: int | None = None
-    crosstalk: Mapping[IntLike, Number] = {}
+    crosstalk: Mapping[int, Number] = {}
     shareable: bool | None = None
 
 
@@ -175,13 +179,12 @@ class DigitalInputPortConfigType(BaseModel):
     threshold: Number | None = None
 
 
-class AnalogOutputPortConfigTypeOctoDac(BaseModel):
+class LfAnalogOutputPortConfigType(BaseModel):
     offset: Number | None = None
-    filter: AnalogOutputFilterConfigType | None = None
+    filter: AnalogOutputFilterConfigType | AnalogOutputFilterConfigType123 | None = None
     delay: int | None = None
     crosstalk: Mapping[int, Number] = {}
     shareable: bool | None = None
-    connectivity: tuple[str, str] | None = None
     sampling_rate: float | None = None
     upsampling_mode: Literal["mw", "pulse"] | None = None
     output_mode: Literal["direct", "amplified"] | None = None
@@ -189,10 +192,10 @@ class AnalogOutputPortConfigTypeOctoDac(BaseModel):
 
 class LfFemConfigType(BaseModel):
     type: Literal["LF"] | None = None
-    analog_outputs: Mapping[int | str, AnalogOutputPortConfigTypeOctoDac] = {}
-    analog_inputs: Mapping[int | str, AnalogInputPortConfigType] = {}
-    digital_outputs: Mapping[int | str, DigitalOutputPortConfigType] = {}
-    digital_inputs: Mapping[int | str, DigitalInputPortConfigType] = {}
+    analog_outputs: Mapping[int, LfAnalogOutputPortConfigType] = {}
+    analog_inputs: Mapping[int, AnalogInputPortConfigType] = {}
+    digital_outputs: Mapping[int, DigitalOutputPortConfigType] = {}
+    digital_inputs: Mapping[int, DigitalInputPortConfigType] = {}
 
 
 Band = Literal[1, 2, 3]
@@ -216,16 +219,16 @@ class MwFemAnalogOutputPortConfigType(BaseModel):
     band: Band | None = None
     delay: int | None = None
     shareable: bool | None = None
-    upconverters: Mapping[IntLike, MwUpconverterConfigType] = {}
+    upconverters: Mapping[int, MwUpconverterConfigType] | None = None
     upconverter_frequency: float | None = None
 
 
 class MwFemConfigType(BaseModel):
     type: Literal["MW"] | None = None
-    analog_outputs: Mapping[int | str, MwFemAnalogOutputPortConfigType] = {}
-    analog_inputs: Mapping[int | str, MwFemAnalogInputPortConfigType] = {}
-    digital_outputs: Mapping[int | str, DigitalOutputPortConfigType] = {}
-    digital_inputs: Mapping[int | str, DigitalInputPortConfigType] = {}
+    analog_outputs: Mapping[int, MwFemAnalogOutputPortConfigType] = {}
+    analog_inputs: Mapping[int, MwFemAnalogInputPortConfigType] = {}
+    digital_outputs: Mapping[int, DigitalOutputPortConfigType] = {}
+    digital_inputs: Mapping[int, DigitalInputPortConfigType] = {}
 
 
 class ControllerConfigType(BaseModel):
@@ -247,8 +250,8 @@ class OctaveRFOutputConfigType(BaseModel):
     ] = "always_off"
     gain: int | float = Field(default=0, ge=-20, le=20, multiple_of=0.5)
     input_attenuators: Literal["ON", "OFF"] = "OFF"
-    I_connection: PortReferenceType | None = None
-    Q_connection: PortReferenceType | None = None
+    I_connection: NativeOPXPortType | None = None
+    Q_connection: NativeOPXPortType | None = None
 
 
 _RF_SOURCES = Literal[
@@ -270,7 +273,7 @@ class OctaveRFInputConfigType(BaseModel):
 
 
 class OctaveSingleIfOutputConfigType(BaseModel):
-    port: PortReferenceType | None = None
+    port: NativeOPXPortType | None = None
     name: str | None = None
 
 
@@ -279,7 +282,7 @@ class OctaveIfOutputsConfigType(BaseModel):
     IF_out2: OctaveSingleIfOutputConfigType | None = None
 
 
-FEM_IDX = Literal[1, 2, 3, 4, 5, 6, 7, 8, "1", "2", "3", "4", "5", "6", "7", "8"]
+FEM_IDX = Annotated[int, Field(ge=1, le=8)]
 
 
 class OPX1000ControllerConfigType(BaseModel):
@@ -296,13 +299,13 @@ LoopbackType = tuple[
 class OctaveConfig(BaseModel):
     """Octave configuration for qm-qua 1.1.7."""
 
-    RF_outputs: Mapping[IntLike, OctaveRFOutputConfigType] = {}
+    RF_outputs: Mapping[int, OctaveRFOutputConfigType] = {}
     """
     RF Outputs in Octave's up-converter chain.
     OPX/AnalogOutput -> Octave/IFInput -> Octave/RFOutput -> Fridge.
     """
 
-    RF_inputs: Mapping[IntLike, OctaveRFInputConfigType] = {}
+    RF_inputs: Mapping[int, OctaveRFInputConfigType] = {}
     """RF Inputs in Octave's down-converter chain. See IF_Outputs."""
 
     IF_outputs: OctaveIfOutputsConfigType | None = None
@@ -367,7 +370,7 @@ class OctaveConfig121(OctaveConfig):
 class DigitalInputConfigType(BaseModel):
     delay: int | None = None
     buffer: int | None = None
-    port: PortReferenceType | None = None
+    port: QMPortTypes | None = None
 
 
 class IntegrationWeightConfigType(BaseModel):
@@ -413,16 +416,16 @@ class PulseConfigType(BaseModel):
 
 
 class SingleInputConfigType(BaseModel):
-    port: PortReferenceType | None = None
+    port: QMPortTypes | None = None
 
 
 class MwInputConfigType(BaseModel):
-    port: PortReferenceType | None = None
-    upconverter: int | None = None
+    port: NativeOPX1000PortType | None = None
+    upconverter: int = Field(default=1, description="The index of the upconverter to use.")
 
 
 class MwOutputConfigType(BaseModel):
-    port: PortReferenceType | None = None
+    port: NativeOPX1000PortType | None = None
 
 
 class HoldOffsetConfigType(BaseModel):
@@ -436,14 +439,14 @@ class StickyConfigType(BaseModel):
 
 
 class MixInputConfigType(BaseModel):
-    I: PortReferenceType | None = None
-    Q: PortReferenceType | None = None
+    I: QMPortTypes | None = None
+    Q: QMPortTypes | None = None
     mixer: str | None = None
     lo_frequency: float | None = None
 
 
 class InputCollectionConfigType(BaseModel):
-    inputs: Mapping[str, PortReferenceType] = {}
+    inputs: Mapping[str, QMPortTypes] = {}
 
 
 class OscillatorConfigType(BaseModel):
@@ -472,15 +475,15 @@ class ElementConfig(BaseModel):
     multipleInputs: InputCollectionConfigType | None = None
     time_of_flight: int | None = None
     smearing: int | None = None
-    outputs: Mapping[str, PortReferenceType] = {}
+    outputs: Mapping[str, QMPortTypes] = {}
     digitalInputs: Mapping[str, DigitalInputConfigType] | None = None
-    digitalOutputs: Mapping[str, PortReferenceType] | None = None
+    digitalOutputs: Mapping[str, QMPortTypes] | None = None
     outputPulseParameters: OutputPulseParameterConfigType | None = None
     hold_offset: HoldOffsetConfigType | None = None
     sticky: StickyConfigType | None = None
     thread: str | None = None
-    RF_inputs: Mapping[str, tuple[str, int]] | None = None
-    RF_outputs: Mapping[str, tuple[str, int]] | None = None
+    RF_inputs: Mapping[str, NativeOPXPortType] | None = None
+    RF_outputs: Mapping[str, NativeOPXPortType] | None = None
 
     @model_validator(mode="after")
     def validator_oscillators(self) -> Self:
@@ -499,7 +502,7 @@ class ElementConfig121(ElementConfig):
 
     @model_validator(mode="after")
     def validate_outputs(self) -> Self:
-        if self.RF_outputs:
+        if self.RF_outputs or self.MWOutput:
             if self.smearing is None:
                 raise ValueError("Element with output must have smearing defined.")
             if self.time_of_flight is None:
@@ -529,7 +532,7 @@ class _BaseQuaConfig(BaseModel):
     qm_version: str
     """The qm-qua package version used."""
 
-    version: str = "1"
+    version: int = 1
     """The configuration version. This is a field used in Qua's configuration API."""
 
     oscillators: Mapping[str, OscillatorConfigType] = {}

boulderopalscaleupsdk/stubs/dtypes.py

@@ -1,47 +0,0 @@
-# Copyright 2025 Q-CTRL. All rights reserved.
-#
-# Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
-# copying or use of this file, via any medium, is strictly prohibited.
-# Proprietary and confidential. You may not use this file except in compliance
-# with the License. You may obtain a copy of the License at
-#
-#    https://q-ctrl.com/terms
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS. See the
-# License for the specific language.
-
-from pathlib import Path
-from typing import Any
-
-from pydantic import TypeAdapter
-from pydantic.dataclasses import dataclass
-
-
-@dataclass
-class StubMetadata:
-    api_url: str
-    app_name: str
-    device_name: str
-    controller_type: str
-    routine_name: str
-    parameters: dict[str, Any]
-    created_at: str
-
-
-@dataclass
-class StubData:
-    raw_data: dict[str, Any]
-    metadata: StubMetadata | None = None
-
-    def to_dict(self) -> dict[str, Any]:
-        return TypeAdapter(type(self)).dump_python(self)
-
-    @classmethod
-    def from_str(cls, data: str) -> "StubData":
-        return TypeAdapter(cls).validate_json(data)
-
-    @classmethod
-    def load_from_file(cls, file_path: Path) -> "StubData":
-        with file_path.open("rb") as file:
-            return cls.from_str(file.read().decode("utf-8"))

boulderopalscaleupsdk/stubs/maps.py

@@ -1,18 +0,0 @@
-STUB_DATA_FILE_MAPPING: dict[str, list[str]] = {
-    # Experiments
-    "chi01_scan": ["QM/Tuna-5/chi01_scan.json"],
-    "coherence_t1": ["QM/Tuna-5/coherence_t1.json"],
-    "coherence_t2": ["QM/Tuna-5/coherence_t2.json"],
-    "readout_classifier_calibration": ["QM/Tuna-5/readout_classifier_calibration.json"],
-    "resonator_spectroscopy": ["QM/Tuna-5/resonator_spectroscopy.json"],
-    "resonator_spectroscopy_by_power": ["QM/Tuna-5/resonator_spectroscopy_by_power.json"],
-    "resonator_spectroscopy_by_bias": ["QM/Tuna-5/resonator_spectroscopy_by_bias.json"],
-    "ramsey": ["QM/Tuna-5/ramsey.json"],
-    "power_rabi": ["QM/Tuna-5/power_rabi.json"],
-    "transmon_anharmonicity": ["QM/Tuna-5/transmon_anharmonicity.json"],
-    "transmon_spectroscopy": ["QM/Tuna-5/transmon_spectroscopy.json"],
-    # Routines
-    "feedline_discovery": [f"QM/Tuna-5/feedline_discovery/{n}.json" for n in range(1, 7)],
-    "resonator_mapping": [f"QM/Tuna-5/resonator_mapping/{n}.json" for n in range(1, 17)],
-    "transmon_discovery": [f"QM/Tuna-5/transmon_discovery/{n}.json" for n in range(1, 8)],
-}