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

boulderopalscaleupsdk/plotting/dtypes.py

@@ -0,0 +1,221 @@
+# 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.
+
+import base64
+from typing import Annotated, Any, Literal
+
+import numpy as np
+from pydantic import (
+    BaseModel,
+    BeforeValidator,
+    ConfigDict,
+    PlainSerializer,
+    ValidationError,
+    model_validator,
+)
+from pydantic.dataclasses import dataclass
+
+
+def _array_validator(value: Any) -> np.ndarray:
+    if isinstance(value, dict):
+        array = np.frombuffer(base64.b64decode(value["data"]), dtype=value["dtype"]).reshape(
+            value["shape"],
+        )
+    else:
+        array = np.asarray(value, order="C")
+
+    if array.dtype == np.dtypes.ObjectDType:
+        raise ValidationError("Invalid array.")
+
+    return array
+
+
+def _array_serializer(array: np.ndarray) -> dict[str, Any]:
+    return {
+        "data": base64.b64encode(array),
+        "dtype": str(array.dtype),
+        "shape": array.shape,
+    }
+
+
+_SerializableArray = Annotated[
+    np.ndarray,
+    BeforeValidator(_array_validator),
+    PlainSerializer(_array_serializer),
+]
+
+
+@dataclass(config=ConfigDict(arbitrary_types_allowed=True))
+class PlotData1D:
+    """
+    A class to represent 1D plot data with optional error bars.
+
+    Attributes
+    ----------
+    x : np.ndarray
+        The x-coordinates of the data points.
+    y : np.ndarray
+        The y-coordinates of the data points.
+    x_error : np.ndarray or None, optional
+        The errors in the x-coordinates. Defaults to None.
+    y_error : np.ndarray or None, optional
+        The errors in the y-coordinates. Defaults to None.
+    label : str or None, optional
+        The label for the data to display in the legend. Defaults to None.
+    """
+
+    x: _SerializableArray
+    y: _SerializableArray
+    x_error: _SerializableArray | None = None
+    y_error: _SerializableArray | None = None
+    label: str | None = None
+
+    def __post_init__(self):
+        if self.x.ndim != 1:
+            raise ValueError("x must be 1D.")
+        if self.y.ndim != 1:
+            raise ValueError("y must be 1D.")
+        if len(self.x) != len(self.y):
+            raise ValueError("The length of x and y must match.")
+
+        if self.x_error is not None and self.x_error.shape != self.x.shape:
+            raise ValueError("The shapes of x and x_error must match.")
+        if self.y_error is not None and self.y_error.shape != self.y.shape:
+            raise ValueError("The shapes of y and y_error must match.")
+
+
+@dataclass(config=ConfigDict(arbitrary_types_allowed=True))
+class PlotData2D:
+    """
+    A class to represent 2D plot data.
+
+    Attributes
+    ----------
+    x : np.ndarray
+        The x-coordinates of the data points.
+    y : np.ndarray
+        The y-coordinates of the data points.
+    z : np.ndarray
+        The z-values corresponding to each (x, y) pair.
+    label : str or None, optional
+        The label for the data to display in the legend. Defaults to None.
+    """
+
+    x: _SerializableArray
+    y: _SerializableArray
+    z: _SerializableArray
+    label: str | None = None
+
+    def __post_init__(self):
+        if self.x.ndim != 1:
+            raise ValueError("x must be 1D.")
+        if self.y.ndim != 1:
+            raise ValueError("y must be 1D.")
+        if self.z.ndim != 2:
+            raise ValueError("z must be 2D.")
+        if self.z.shape != (len(self.x), len(self.y)):
+            raise ValueError("The shape of z must be (len(x), len(y)).")
+
+
+@dataclass
+class Marker:
+    x: float
+    y: float
+    label: str
+    color: str
+    symbol: Literal["star"]
+
+
+@dataclass
+class VLine:
+    value: float
+    line_dash: Literal["dash"]
+    color: str | None = None
+
+
+class Plot(BaseModel):
+    """
+    Data to plot the results of an experiment.
+
+    Parameters
+    ----------
+    heatmap : PlotData2D or None, optional
+        The 2D experimental data.
+        If provided, it's plotted as a heatmap.
+    heatmap_text : bool, optional
+        If True, the heatmap displays the values as text.
+        Defaults to False.
+    points : PlotData1D or None, optional
+        The 1D experimental data.
+        If provided, it's plotted as a scatter plot.
+    best_fit : PlotData1D or None, optional
+        The best fit on the experimental data.
+        If provided, it's plotted as a line plot.
+    reference_fit : PlotData1D or None, optional
+        A reference fit on the experimental data.
+        If provided, it's plotted as a line plot.
+    markers : list[Markers] or None, optional
+        Markers to add to the plot.
+    vlines : list[VLine] or None, optional
+        Vertical lines to add to the plot.
+    title : str or None, optional
+        The title of the plot.
+    xticks : list[float] or None, optional
+        The values at which x-ticks are placed.
+        Must be specified alongside xticklabels. Defaults to None.
+    xticklabels : list[str] or None, optional
+        The labels for the x-ticks.
+        Must be specified alongside xticks. Defaults to None.
+    yticks : list[float] or None, optional
+        The values at which y-ticks are placed.
+        Must be specified alongside yticklabels. Defaults to None.
+    yticklabels : list[str] or None, optional
+        The labels for the y-ticks.
+        Must be specified alongside xticks. Defaults to None.
+    x_label : str, optional
+        The label for the x-axis. Defaults to "X-axis".
+    y_label : str, optional
+        The label for the y-axis. Defaults to "Y-axis".
+    reverse_yaxis : bool, optional
+        If True, the y-axis is reversed. Defaults to False.
+    fit_report : str or None, optional
+        An optional report for the fit.
+    """
+
+    heatmap: PlotData2D | None = None
+    heatmap_text: bool = False
+    points: PlotData1D | None = None
+    best_fit: PlotData1D | None = None
+    reference_fit: PlotData1D | None = None
+    markers: list[Marker] | None = None
+    vlines: list[VLine] | None = None
+    title: str | None = None
+    xticks: list[float] | None = None
+    xticklabels: list[str] | None = None
+    yticks: list[float] | None = None
+    yticklabels: list[str] | None = None
+    x_label: str = "X-axis"
+    y_label: str = "Y-axis"
+    reverse_yaxis: bool | None = False
+    fit_report: str | None = None
+
+    @model_validator(mode="after")
+    def validate_ticks(self) -> "Plot":
+        # Check ticks and ticklabels consistency.
+        if not ((self.xticks is not None) ^ (self.xticklabels is None)):
+            raise ValueError("Both xticks and xticklabels must be provided together.")
+
+        if not ((self.yticks is not None) ^ (self.yticklabels is None)):
+            raise ValueError("Both yticks and yticklabels must be provided together.")
+
+        return self

boulderopalscaleupsdk/protobuf/v1/agent_pb2.py

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: boulderopalscaleupsdk/protobuf/v1/agent.proto
+# Protobuf Python Version: 5.26.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2
+from google.protobuf import empty_pb2 as google_dot_protobuf_dot_empty__pb2
+from google.protobuf import struct_pb2 as google_dot_protobuf_dot_struct__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n-boulderopalscaleupsdk/protobuf/v1/agent.proto\x12!boulderopalscaleupsdk.protobuf.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a\x1cgoogle/protobuf/struct.proto\"H\n\x14RunQuaProgramRequest\x12\x18\n\x07program\x18\x01 \x01(\tR\x07program\x12\x16\n\x06\x63onfig\x18\x02 \x01(\tR\x06\x63onfig\"K\n\x15RunQuaProgramResponse\x12\x32\n\x08raw_data\x18\x01 \x01(\x0b\x32\x17.google.protobuf.StructR\x07rawData\"_\n)RunQuantumMachinesMixerCalibrationRequest\x12\x1a\n\x08\x65lements\x18\x01 \x03(\tR\x08\x65lements\x12\x16\n\x06\x63onfig\x18\x02 \x01(\tR\x06\x63onfig\"k\n*RunQuantumMachinesMixerCalibrationResponse\x12\x18\n\x07success\x18\x01 \x01(\x08R\x07success\x12\x19\n\x05\x65rror\x18\x02 \x01(\tH\x00R\x05\x65rror\x88\x01\x01\x42\x08\n\x06_error\"G\n\x15\x44isplayResultsRequest\x12\x18\n\x07message\x18\x01 \x01(\tR\x07message\x12\x14\n\x05plots\x18\x02 \x03(\tR\x05plots\"F\n\x16\x44isplayResultsResponse\x12,\n\x05\x65mpty\x18\x01 \x01(\x0b\x32\x16.google.protobuf.EmptyR\x05\x65mpty2\xdd\x04\n\x0c\x41gentService\x12\xa8\x01\n\rRunQuaProgram\x12\x37.boulderopalscaleupsdk.protobuf.v1.RunQuaProgramRequest\x1a\x38.boulderopalscaleupsdk.protobuf.v1.RunQuaProgramResponse\"$\x82\xd3\xe4\x93\x02\x1e\"\x19/v1/agent/run_qua_program:\x01*\x12\xf3\x01\n\"RunQuantumMachinesMixerCalibration\x12L.boulderopalscaleupsdk.protobuf.v1.RunQuantumMachinesMixerCalibrationRequest\x1aM.boulderopalscaleupsdk.protobuf.v1.RunQuantumMachinesMixerCalibrationResponse\"0\x82\xd3\xe4\x93\x02*\"%/v1/agent/run_qua_calibration_program:\x01*\x12\xab\x01\n\x0e\x44isplayResults\x12\x38.boulderopalscaleupsdk.protobuf.v1.DisplayResultsRequest\x1a\x39.boulderopalscaleupsdk.protobuf.v1.DisplayResultsResponse\"$\x82\xd3\xe4\x93\x02\x1e\"\x19/v1/agent/display_results:\x01*B\xa9\x02\n%com.boulderopalscaleupsdk.protobuf.v1B\nAgentProtoP\x01ZNgithub.com/qctrl/boulder-opal-scale-up/proto/boulderopalscaleupsdk/protobuf/v1\xa2\x02\x03\x42PX\xaa\x02!Boulderopalscaleupsdk.Protobuf.V1\xca\x02!Boulderopalscaleupsdk\\Protobuf\\V1\xe2\x02-Boulderopalscaleupsdk\\Protobuf\\V1\\GPBMetadata\xea\x02#Boulderopalscaleupsdk::Protobuf::V1b\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'boulderopalscaleupsdk.protobuf.v1.agent_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  _globals['DESCRIPTOR']._loaded_options = None
+  _globals['DESCRIPTOR']._serialized_options = b'\n%com.boulderopalscaleupsdk.protobuf.v1B\nAgentProtoP\001ZNgithub.com/qctrl/boulder-opal-scale-up/proto/boulderopalscaleupsdk/protobuf/v1\242\002\003BPX\252\002!Boulderopalscaleupsdk.Protobuf.V1\312\002!Boulderopalscaleupsdk\\Protobuf\\V1\342\002-Boulderopalscaleupsdk\\Protobuf\\V1\\GPBMetadata\352\002#Boulderopalscaleupsdk::Protobuf::V1'
+  _globals['_AGENTSERVICE'].methods_by_name['RunQuaProgram']._loaded_options = None
+  _globals['_AGENTSERVICE'].methods_by_name['RunQuaProgram']._serialized_options = b'\202\323\344\223\002\036\"\031/v1/agent/run_qua_program:\001*'
+  _globals['_AGENTSERVICE'].methods_by_name['RunQuantumMachinesMixerCalibration']._loaded_options = None
+  _globals['_AGENTSERVICE'].methods_by_name['RunQuantumMachinesMixerCalibration']._serialized_options = b'\202\323\344\223\002*\"%/v1/agent/run_qua_calibration_program:\001*'
+  _globals['_AGENTSERVICE'].methods_by_name['DisplayResults']._loaded_options = None
+  _globals['_AGENTSERVICE'].methods_by_name['DisplayResults']._serialized_options = b'\202\323\344\223\002\036\"\031/v1/agent/display_results:\001*'
+  _globals['_RUNQUAPROGRAMREQUEST']._serialized_start=173
+  _globals['_RUNQUAPROGRAMREQUEST']._serialized_end=245
+  _globals['_RUNQUAPROGRAMRESPONSE']._serialized_start=247
+  _globals['_RUNQUAPROGRAMRESPONSE']._serialized_end=322
+  _globals['_RUNQUANTUMMACHINESMIXERCALIBRATIONREQUEST']._serialized_start=324
+  _globals['_RUNQUANTUMMACHINESMIXERCALIBRATIONREQUEST']._serialized_end=419
+  _globals['_RUNQUANTUMMACHINESMIXERCALIBRATIONRESPONSE']._serialized_start=421
+  _globals['_RUNQUANTUMMACHINESMIXERCALIBRATIONRESPONSE']._serialized_end=528
+  _globals['_DISPLAYRESULTSREQUEST']._serialized_start=530
+  _globals['_DISPLAYRESULTSREQUEST']._serialized_end=601
+  _globals['_DISPLAYRESULTSRESPONSE']._serialized_start=603
+  _globals['_DISPLAYRESULTSRESPONSE']._serialized_end=673
+  _globals['_AGENTSERVICE']._serialized_start=676
+  _globals['_AGENTSERVICE']._serialized_end=1281
+# @@protoc_insertion_point(module_scope)

boulderopalscaleupsdk/protobuf/v1/agent_pb2.pyi

@@ -0,0 +1,53 @@
+from google.api import annotations_pb2 as _annotations_pb2
+from google.protobuf import empty_pb2 as _empty_pb2
+from google.protobuf import struct_pb2 as _struct_pb2
+from google.protobuf.internal import containers as _containers
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class RunQuaProgramRequest(_message.Message):
+    __slots__ = ("program", "config")
+    PROGRAM_FIELD_NUMBER: _ClassVar[int]
+    CONFIG_FIELD_NUMBER: _ClassVar[int]
+    program: str
+    config: str
+    def __init__(self, program: _Optional[str] = ..., config: _Optional[str] = ...) -> None: ...
+
+class RunQuaProgramResponse(_message.Message):
+    __slots__ = ("raw_data",)
+    RAW_DATA_FIELD_NUMBER: _ClassVar[int]
+    raw_data: _struct_pb2.Struct
+    def __init__(self, raw_data: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ...) -> None: ...
+
+class RunQuantumMachinesMixerCalibrationRequest(_message.Message):
+    __slots__ = ("elements", "config")
+    ELEMENTS_FIELD_NUMBER: _ClassVar[int]
+    CONFIG_FIELD_NUMBER: _ClassVar[int]
+    elements: _containers.RepeatedScalarFieldContainer[str]
+    config: str
+    def __init__(self, elements: _Optional[_Iterable[str]] = ..., config: _Optional[str] = ...) -> None: ...
+
+class RunQuantumMachinesMixerCalibrationResponse(_message.Message):
+    __slots__ = ("success", "error")
+    SUCCESS_FIELD_NUMBER: _ClassVar[int]
+    ERROR_FIELD_NUMBER: _ClassVar[int]
+    success: bool
+    error: str
+    def __init__(self, success: bool = ..., error: _Optional[str] = ...) -> None: ...
+
+class DisplayResultsRequest(_message.Message):
+    __slots__ = ("message", "plots")
+    MESSAGE_FIELD_NUMBER: _ClassVar[int]
+    PLOTS_FIELD_NUMBER: _ClassVar[int]
+    message: str
+    plots: _containers.RepeatedScalarFieldContainer[str]
+    def __init__(self, message: _Optional[str] = ..., plots: _Optional[_Iterable[str]] = ...) -> None: ...
+
+class DisplayResultsResponse(_message.Message):
+    __slots__ = ("empty",)
+    EMPTY_FIELD_NUMBER: _ClassVar[int]
+    empty: _empty_pb2.Empty
+    def __init__(self, empty: _Optional[_Union[_empty_pb2.Empty, _Mapping]] = ...) -> None: ...

boulderopalscaleupsdk/protobuf/v1/agent_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 agent_pb2 as boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2
+
+
+class AgentServiceStub(object):
+    """Defines the Agent service running locally.
+    """
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.RunQuaProgram = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.AgentService/RunQuaProgram',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.RunQuaProgramRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.RunQuaProgramResponse.FromString,
+                )
+        self.RunQuantumMachinesMixerCalibration = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.AgentService/RunQuantumMachinesMixerCalibration',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.RunQuantumMachinesMixerCalibrationRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.RunQuantumMachinesMixerCalibrationResponse.FromString,
+                )
+        self.DisplayResults = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.AgentService/DisplayResults',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.DisplayResultsRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.DisplayResultsResponse.FromString,
+                )
+
+
+class AgentServiceServicer(object):
+    """Defines the Agent service running locally.
+    """
+
+    def RunQuaProgram(self, request, context):
+        """Run a program on physical hardware.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def RunQuantumMachinesMixerCalibration(self, request, context):
+        """Run mixer calibration for elements on physical controller.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def DisplayResults(self, request, context):
+        """Report the results of an experiment.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_AgentServiceServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'RunQuaProgram': grpc.unary_unary_rpc_method_handler(
+                    servicer.RunQuaProgram,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.RunQuaProgramRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.RunQuaProgramResponse.SerializeToString,
+            ),
+            'RunQuantumMachinesMixerCalibration': grpc.unary_unary_rpc_method_handler(
+                    servicer.RunQuantumMachinesMixerCalibration,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.RunQuantumMachinesMixerCalibrationRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.RunQuantumMachinesMixerCalibrationResponse.SerializeToString,
+            ),
+            'DisplayResults': grpc.unary_unary_rpc_method_handler(
+                    servicer.DisplayResults,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.DisplayResultsRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.DisplayResultsResponse.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'boulderopalscaleupsdk.protobuf.v1.AgentService', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+
+
+ # This class is part of an EXPERIMENTAL API.
+class AgentService(object):
+    """Defines the Agent service running locally.
+    """
+
+    @staticmethod
+    def RunQuaProgram(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.AgentService/RunQuaProgram',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.RunQuaProgramRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.RunQuaProgramResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def RunQuantumMachinesMixerCalibration(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.AgentService/RunQuantumMachinesMixerCalibration',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.RunQuantumMachinesMixerCalibrationRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.RunQuantumMachinesMixerCalibrationResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def DisplayResults(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.AgentService/DisplayResults',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.DisplayResultsRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.DisplayResultsResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

boulderopalscaleupsdk/protobuf/v1/device_pb2.py

@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: boulderopalscaleupsdk/protobuf/v1/device.proto
+# Protobuf Python Version: 5.26.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2
+from google.protobuf import struct_pb2 as google_dot_protobuf_dot_struct__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n.boulderopalscaleupsdk/protobuf/v1/device.proto\x12!boulderopalscaleupsdk.protobuf.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x1cgoogle/protobuf/struct.proto\"-\n\x14GetJobSummaryRequest\x12\x15\n\x06job_id\x18\x01 \x01(\tR\x05jobId\"Z\n\x15GetJobSummaryResponse\x12\x41\n\x10job_summary_data\x18\x01 \x01(\x0b\x32\x17.google.protobuf.StructR\x0ejobSummaryData\"&\n\rGetJobRequest\x12\x15\n\x06job_id\x18\x01 \x01(\tR\x05jobId\"D\n\x0eGetJobResponse\x12\x32\n\x08job_data\x18\x01 \x01(\x0b\x32\x17.google.protobuf.StructR\x07jobData\"2\n\x0fListJobsRequest\x12\x1f\n\x0b\x64\x65vice_name\x18\x01 \x01(\tR\ndeviceName\"?\n\x10ListJobsResponse\x12+\n\x04jobs\x18\x01 \x03(\x0b\x32\x17.google.protobuf.StructR\x04jobs\"\x85\x01\n\rCreateRequest\x12\x19\n\x08\x61pp_name\x18\x01 \x01(\tR\x07\x61ppName\x12\x1f\n\x0b\x64\x65vice_name\x18\x02 \x01(\tR\ndeviceName\x12\x38\n\x0b\x64\x65vice_data\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructR\ndeviceData\"$\n\x0e\x43reateResponse\x12\x12\n\x04\x64one\x18\x01 \x01(\x08R\x04\x64one\"I\n\x0bLoadRequest\x12\x19\n\x08\x61pp_name\x18\x01 \x01(\tR\x07\x61ppName\x12\x1f\n\x0b\x64\x65vice_name\x18\x02 \x01(\tR\ndeviceName\"\x90\x01\n\x0cLoadResponse\x12>\n\x0eprocessor_data\x18\x02 \x01(\x0b\x32\x17.google.protobuf.StructR\rprocessorData\x12@\n\x0f\x63ontroller_data\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructR\x0e\x63ontrollerData\"\xcd\x01\n\rUpdateRequest\x12\x19\n\x08\x61pp_name\x18\x01 \x01(\tR\x07\x61ppName\x12\x1f\n\x0b\x64\x65vice_name\x18\x02 \x01(\tR\ndeviceName\x12>\n\x0eprocessor_data\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructR\rprocessorData\x12@\n\x0f\x63ontroller_data\x18\x04 \x01(\x0b\x32\x17.google.protobuf.StructR\x0e\x63ontrollerData\"\x92\x01\n\x0eUpdateResponse\x12>\n\x0eprocessor_data\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructR\rprocessorData\x12@\n\x0f\x63ontroller_data\x18\x04 \x01(\x0b\x32\x17.google.protobuf.StructR\x0e\x63ontrollerData\"K\n\rDeleteRequest\x12\x19\n\x08\x61pp_name\x18\x01 \x01(\tR\x07\x61ppName\x12\x1f\n\x0b\x64\x65vice_name\x18\x02 \x01(\tR\ndeviceName\"$\n\x0e\x44\x65leteResponse\x12\x12\n\x04\x64one\x18\x01 \x01(\x08R\x04\x64one2\x98\x08\n\x14\x44\x65viceManagerService\x12\x8b\x01\n\x06\x43reate\x12\x30.boulderopalscaleupsdk.protobuf.v1.CreateRequest\x1a\x31.boulderopalscaleupsdk.protobuf.v1.CreateResponse\"\x1c\x82\xd3\xe4\x93\x02\x16\"\x11/v1/device/create:\x01*\x12\x83\x01\n\x04Load\x12..boulderopalscaleupsdk.protobuf.v1.LoadRequest\x1a/.boulderopalscaleupsdk.protobuf.v1.LoadResponse\"\x1a\x82\xd3\xe4\x93\x02\x14\"\x0f/v1/device/load:\x01*\x12\x8b\x01\n\x06Update\x12\x30.boulderopalscaleupsdk.protobuf.v1.UpdateRequest\x1a\x31.boulderopalscaleupsdk.protobuf.v1.UpdateResponse\"\x1c\x82\xd3\xe4\x93\x02\x16\"\x11/v1/device/update:\x01*\x12\x8b\x01\n\x06\x44\x65lete\x12\x30.boulderopalscaleupsdk.protobuf.v1.DeleteRequest\x1a\x31.boulderopalscaleupsdk.protobuf.v1.DeleteResponse\"\x1c\x82\xd3\xe4\x93\x02\x16\"\x11/v1/device/delete:\x01*\x12\x94\x01\n\x08ListJobs\x12\x32.boulderopalscaleupsdk.protobuf.v1.ListJobsRequest\x1a\x33.boulderopalscaleupsdk.protobuf.v1.ListJobsResponse\"\x1f\x82\xd3\xe4\x93\x02\x19\"\x14/v1/device/list_jobs:\x01*\x12\x8c\x01\n\x06GetJob\x12\x30.boulderopalscaleupsdk.protobuf.v1.GetJobRequest\x1a\x31.boulderopalscaleupsdk.protobuf.v1.GetJobResponse\"\x1d\x82\xd3\xe4\x93\x02\x17\"\x12/v1/device/get_job:\x01*\x12\xa9\x01\n\rGetJobSummary\x12\x37.boulderopalscaleupsdk.protobuf.v1.GetJobSummaryRequest\x1a\x38.boulderopalscaleupsdk.protobuf.v1.GetJobSummaryResponse\"%\x82\xd3\xe4\x93\x02\x1f\"\x1a/v1/device/get_job_summary:\x01*B\xaa\x02\n%com.boulderopalscaleupsdk.protobuf.v1B\x0b\x44\x65viceProtoP\x01ZNgithub.com/qctrl/boulder-opal-scale-up/proto/boulderopalscaleupsdk/protobuf/v1\xa2\x02\x03\x42PX\xaa\x02!Boulderopalscaleupsdk.Protobuf.V1\xca\x02!Boulderopalscaleupsdk\\Protobuf\\V1\xe2\x02-Boulderopalscaleupsdk\\Protobuf\\V1\\GPBMetadata\xea\x02#Boulderopalscaleupsdk::Protobuf::V1b\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'boulderopalscaleupsdk.protobuf.v1.device_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  _globals['DESCRIPTOR']._loaded_options = None
+  _globals['DESCRIPTOR']._serialized_options = b'\n%com.boulderopalscaleupsdk.protobuf.v1B\013DeviceProtoP\001ZNgithub.com/qctrl/boulder-opal-scale-up/proto/boulderopalscaleupsdk/protobuf/v1\242\002\003BPX\252\002!Boulderopalscaleupsdk.Protobuf.V1\312\002!Boulderopalscaleupsdk\\Protobuf\\V1\342\002-Boulderopalscaleupsdk\\Protobuf\\V1\\GPBMetadata\352\002#Boulderopalscaleupsdk::Protobuf::V1'
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Create']._loaded_options = None
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Create']._serialized_options = b'\202\323\344\223\002\026\"\021/v1/device/create:\001*'
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Load']._loaded_options = None
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Load']._serialized_options = b'\202\323\344\223\002\024\"\017/v1/device/load:\001*'
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Update']._loaded_options = None
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Update']._serialized_options = b'\202\323\344\223\002\026\"\021/v1/device/update:\001*'
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Delete']._loaded_options = None
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Delete']._serialized_options = b'\202\323\344\223\002\026\"\021/v1/device/delete:\001*'
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['ListJobs']._loaded_options = None
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['ListJobs']._serialized_options = b'\202\323\344\223\002\031\"\024/v1/device/list_jobs:\001*'
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetJob']._loaded_options = None
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetJob']._serialized_options = b'\202\323\344\223\002\027\"\022/v1/device/get_job:\001*'
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetJobSummary']._loaded_options = None
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetJobSummary']._serialized_options = b'\202\323\344\223\002\037\"\032/v1/device/get_job_summary:\001*'
+  _globals['_GETJOBSUMMARYREQUEST']._serialized_start=145
+  _globals['_GETJOBSUMMARYREQUEST']._serialized_end=190
+  _globals['_GETJOBSUMMARYRESPONSE']._serialized_start=192
+  _globals['_GETJOBSUMMARYRESPONSE']._serialized_end=282
+  _globals['_GETJOBREQUEST']._serialized_start=284
+  _globals['_GETJOBREQUEST']._serialized_end=322
+  _globals['_GETJOBRESPONSE']._serialized_start=324
+  _globals['_GETJOBRESPONSE']._serialized_end=392
+  _globals['_LISTJOBSREQUEST']._serialized_start=394
+  _globals['_LISTJOBSREQUEST']._serialized_end=444
+  _globals['_LISTJOBSRESPONSE']._serialized_start=446
+  _globals['_LISTJOBSRESPONSE']._serialized_end=509
+  _globals['_CREATEREQUEST']._serialized_start=512
+  _globals['_CREATEREQUEST']._serialized_end=645
+  _globals['_CREATERESPONSE']._serialized_start=647
+  _globals['_CREATERESPONSE']._serialized_end=683
+  _globals['_LOADREQUEST']._serialized_start=685
+  _globals['_LOADREQUEST']._serialized_end=758
+  _globals['_LOADRESPONSE']._serialized_start=761
+  _globals['_LOADRESPONSE']._serialized_end=905
+  _globals['_UPDATEREQUEST']._serialized_start=908
+  _globals['_UPDATEREQUEST']._serialized_end=1113
+  _globals['_UPDATERESPONSE']._serialized_start=1116
+  _globals['_UPDATERESPONSE']._serialized_end=1262
+  _globals['_DELETEREQUEST']._serialized_start=1264
+  _globals['_DELETEREQUEST']._serialized_end=1339
+  _globals['_DELETERESPONSE']._serialized_start=1341
+  _globals['_DELETERESPONSE']._serialized_end=1377
+  _globals['_DEVICEMANAGERSERVICE']._serialized_start=1380
+  _globals['_DEVICEMANAGERSERVICE']._serialized_end=2428
+# @@protoc_insertion_point(module_scope)

boulderopalscaleupsdk/protobuf/v1/device_pb2.pyi

@@ -0,0 +1,110 @@
+from google.api import annotations_pb2 as _annotations_pb2
+from google.protobuf import struct_pb2 as _struct_pb2
+from google.protobuf.internal import containers as _containers
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class GetJobSummaryRequest(_message.Message):
+    __slots__ = ("job_id",)
+    JOB_ID_FIELD_NUMBER: _ClassVar[int]
+    job_id: str
+    def __init__(self, job_id: _Optional[str] = ...) -> None: ...
+
+class GetJobSummaryResponse(_message.Message):
+    __slots__ = ("job_summary_data",)
+    JOB_SUMMARY_DATA_FIELD_NUMBER: _ClassVar[int]
+    job_summary_data: _struct_pb2.Struct
+    def __init__(self, job_summary_data: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ...) -> None: ...
+
+class GetJobRequest(_message.Message):
+    __slots__ = ("job_id",)
+    JOB_ID_FIELD_NUMBER: _ClassVar[int]
+    job_id: str
+    def __init__(self, job_id: _Optional[str] = ...) -> None: ...
+
+class GetJobResponse(_message.Message):
+    __slots__ = ("job_data",)
+    JOB_DATA_FIELD_NUMBER: _ClassVar[int]
+    job_data: _struct_pb2.Struct
+    def __init__(self, job_data: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ...) -> None: ...
+
+class ListJobsRequest(_message.Message):
+    __slots__ = ("device_name",)
+    DEVICE_NAME_FIELD_NUMBER: _ClassVar[int]
+    device_name: str
+    def __init__(self, device_name: _Optional[str] = ...) -> None: ...
+
+class ListJobsResponse(_message.Message):
+    __slots__ = ("jobs",)
+    JOBS_FIELD_NUMBER: _ClassVar[int]
+    jobs: _containers.RepeatedCompositeFieldContainer[_struct_pb2.Struct]
+    def __init__(self, jobs: _Optional[_Iterable[_Union[_struct_pb2.Struct, _Mapping]]] = ...) -> None: ...
+
+class CreateRequest(_message.Message):
+    __slots__ = ("app_name", "device_name", "device_data")
+    APP_NAME_FIELD_NUMBER: _ClassVar[int]
+    DEVICE_NAME_FIELD_NUMBER: _ClassVar[int]
+    DEVICE_DATA_FIELD_NUMBER: _ClassVar[int]
+    app_name: str
+    device_name: str
+    device_data: _struct_pb2.Struct
+    def __init__(self, app_name: _Optional[str] = ..., device_name: _Optional[str] = ..., device_data: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ...) -> None: ...
+
+class CreateResponse(_message.Message):
+    __slots__ = ("done",)
+    DONE_FIELD_NUMBER: _ClassVar[int]
+    done: bool
+    def __init__(self, done: bool = ...) -> None: ...
+
+class LoadRequest(_message.Message):
+    __slots__ = ("app_name", "device_name")
+    APP_NAME_FIELD_NUMBER: _ClassVar[int]
+    DEVICE_NAME_FIELD_NUMBER: _ClassVar[int]
+    app_name: str
+    device_name: str
+    def __init__(self, app_name: _Optional[str] = ..., device_name: _Optional[str] = ...) -> None: ...
+
+class LoadResponse(_message.Message):
+    __slots__ = ("processor_data", "controller_data")
+    PROCESSOR_DATA_FIELD_NUMBER: _ClassVar[int]
+    CONTROLLER_DATA_FIELD_NUMBER: _ClassVar[int]
+    processor_data: _struct_pb2.Struct
+    controller_data: _struct_pb2.Struct
+    def __init__(self, processor_data: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ..., controller_data: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ...) -> None: ...
+
+class UpdateRequest(_message.Message):
+    __slots__ = ("app_name", "device_name", "processor_data", "controller_data")
+    APP_NAME_FIELD_NUMBER: _ClassVar[int]
+    DEVICE_NAME_FIELD_NUMBER: _ClassVar[int]
+    PROCESSOR_DATA_FIELD_NUMBER: _ClassVar[int]
+    CONTROLLER_DATA_FIELD_NUMBER: _ClassVar[int]
+    app_name: str
+    device_name: str
+    processor_data: _struct_pb2.Struct
+    controller_data: _struct_pb2.Struct
+    def __init__(self, app_name: _Optional[str] = ..., device_name: _Optional[str] = ..., processor_data: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ..., controller_data: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ...) -> None: ...
+
+class UpdateResponse(_message.Message):
+    __slots__ = ("processor_data", "controller_data")
+    PROCESSOR_DATA_FIELD_NUMBER: _ClassVar[int]
+    CONTROLLER_DATA_FIELD_NUMBER: _ClassVar[int]
+    processor_data: _struct_pb2.Struct
+    controller_data: _struct_pb2.Struct
+    def __init__(self, processor_data: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ..., controller_data: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ...) -> None: ...
+
+class DeleteRequest(_message.Message):
+    __slots__ = ("app_name", "device_name")
+    APP_NAME_FIELD_NUMBER: _ClassVar[int]
+    DEVICE_NAME_FIELD_NUMBER: _ClassVar[int]
+    app_name: str
+    device_name: str
+    def __init__(self, app_name: _Optional[str] = ..., device_name: _Optional[str] = ...) -> None: ...
+
+class DeleteResponse(_message.Message):
+    __slots__ = ("done",)
+    DONE_FIELD_NUMBER: _ClassVar[int]
+    done: bool
+    def __init__(self, done: bool = ...) -> None: ...