iqm-station-control-client 9.4.0__py3-none-any.whl → 9.5.0__py3-none-any.whl

iqm/station_control/interface/models/jobs.py

@@ -46,51 +46,78 @@ class JobError(PydanticBase):
 
 
 class JobData(PydanticBase):
-    """Job response data model"""
+    """Status, artifacts and metadata of a job."""
 
     job_id: UUID
+    """Unique ID of the job."""
     job_status: JobExecutorStatus
+    """Current job status."""
     job_result: JobResult
+    """Progress information for the job."""  # FIXME why is it called JobResult? can it be None?
+    # job_result: The output of a progressing or a successful job. This includes progress indicators.
     job_error: JobError | None
+    """Error message(s) for a failed job."""
     position: int | None
+    """If the job is not completed, its position in the current queue.
+    1 means this task will be executed next. In other cases the value is 0."""
 
 
 @functools.total_ordering
 class JobExecutorStatus(Enum):
-    """Enumeration of different states a job can be in. The ordering of these statuses is important,
-    and execution logic relies on it. Thus, if a new status is added, ensure that it is slotted
+    """Different states a job can be in.
+
+    The ordering of these statuses is important, and execution logic relies on it.
+    Thus, if a new status is added, ensure that it is slotted
     in at the appropriate place. See the :meth:`__lt__` implementation for further details.
     """
 
     # Received by the server
     RECEIVED = "received"
+    """The job has been received by the server."""
 
     # Validating the job
     VALIDATION_STARTED = "validation_started"
+    """The job is being validated."""
     VALIDATION_ENDED = "validation_ended"
+    """The job passed validation."""
 
     # Running PulLA
     FETCH_CALIBRATION_STARTED = "fetch_calibration_started"
+    """Calibration data for the job is being fetched."""
     FETCH_CALIBRATION_ENDED = "fetch_calibration_ended"
+    """Calibration data for the job has been fetched."""
     COMPILATION_STARTED = "compilation_started"
+    """The job is being compiled."""
     COMPILATION_ENDED = "compilation_ended"
+    """The job has been succesfully compiled."""
 
     # Executing sweep
     SAVE_SWEEP_METADATA_STARTED = "save_sweep_metadata_started"
+    """Metadata about the sweep is being stored to database."""
     SAVE_SWEEP_METADATA_ENDED = "save_sweep_metadata_ended"
+    """Metadata about the sweep has been stored to database."""
     PENDING_EXECUTION = "pending_execution"
+    """The job is ready for execution and is waiting for its turn in the queue."""
     EXECUTION_STARTED = "execution_started"
+    """The job has started executing on the instruments."""
     EXECUTION_ENDED = "execution_ended"
+    """The job has finished execution on the instruments."""
     POST_PROCESSING_PENDING = "post_processing_pending"
+    """The job has finished execution and is awaiting further processing."""
     POST_PROCESSING_STARTED = "post_processing_started"
+    """Execution artifacts are being constructed and persisted."""
     POST_PROCESSING_ENDED = "post_processing_ended"
+    """Execution artifacts have been constructed and persisted."""
+
     READY = "ready"
+    """The job has completed."""
 
     # Job failed, can happen at any stage
     FAILED = "failed"
+    """The job has failed. Error message(s) may be available."""
 
-    # Job aborted
     ABORTED = "aborted"
+    """The job has been aborted."""
 
     def __str__(self):
         return self.name.lower()
@@ -109,7 +136,7 @@ class JobExecutorStatus(Enum):
         return self.name == other.name
 
     def __lt__(self, other):
-        """Enable comparison according to definition order.
+        """Comparison according to definition order.
 
         :meta public:
 

iqm/station_control/interface/models/observation.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.
-"""Observation related station control interface models."""
+"""Observation related Station Control interface models."""
 
 from datetime import datetime
 from typing import Any
@@ -35,7 +35,7 @@ class ObservationBase(PydanticBase):
     uncertainty: Uncertainty | None = None
     """Uncertainty of the observation value. ``None`` means unknown."""
     invalid: bool = False
-    """Flag indicating if the object is invalid. Automated systems must not use invalid objects."""
+    """Flag indicating if the observation is invalid. Automated systems must not use invalid observations."""
 
 
 class ObservationDefinition(ObservationBase):
@@ -92,4 +92,4 @@ class ObservationUpdate(PydanticBase):
     observation_id: int
     """Unique identifier of the observation."""
     invalid: bool
-    """Flag indicating if the object is invalid. Automated systems must not use invalid objects."""
+    """Flag indicating if the observation is invalid. Automated systems must not use invalid observations."""

iqm/station_control/interface/models/observation_set.py

@@ -33,7 +33,7 @@ class ObservationSetBase(PydanticBase):
     describes_id: uuid.UUID | None = Field(default=None)
     """Unique identifier of the observation set this observation set describes."""
     invalid: bool = Field(default=False)
-    """Flag indicating if the object is invalid. Automated systems must not use invalid objects."""
+    """Flag indicating if the set is invalid. Automated systems must not use invalid sets."""
 
 
 class ObservationSetDefinition(ObservationSetBase):
@@ -71,10 +71,10 @@ class ObservationSetUpdate(PydanticBase):
     """Database IDs of the observations belonging to the observation set.
 
     This will only add new observations to the observation set, deleting existing ones is not possible.
-    Setting this to `None` or omitting it will leave existing observation_ids as is with no changes.
+    Setting this to ``None`` or omitting it will leave existing :attr:`observation_ids` as is with no changes.
     """
     invalid: bool
-    """Flag indicating if the object is invalid. Automated systems must not use invalid objects."""
+    """Flag indicating if the set is invalid. Automated systems must not use invalid sets."""
 
 
 class ObservationSetWithObservations(ObservationSetData):

{iqm_station_control_client-9.4.0.dist-info → iqm_station_control_client-9.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-station-control-client
-Version: 9.4.0
+Version: 9.5.0
 Summary: Python client for communicating with Station Control Service
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License: Apache License

{iqm_station_control_client-9.4.0.dist-info → iqm_station_control_client-9.5.0.dist-info}/RECORD

@@ -40,17 +40,17 @@ iqm/station_control/interface/station_control.py,sha256=Uh9bDEZjc9M5KOYsGjPMYVhn
 iqm/station_control/interface/models/__init__.py,sha256=Kg-XRLuU7G4Zjtu8LhYD-v3zkCYHzLFaNvC_nukezlQ,1968
 iqm/station_control/interface/models/dut.py,sha256=Hc_0XllXeIPGWhHsY7PC_jMpi7swpqo3jQQEQVnF3AM,1216
 iqm/station_control/interface/models/dynamic_quantum_architecture.py,sha256=3YlI9e1XxdbkBzlOdxmzYTccJ8AJRnRSIp-JoBf8Yyw,4698
-iqm/station_control/interface/models/jobs.py,sha256=4CVVGMsUOm_UO4w7UH-Shq7cbZe_5MkhGDpoBwHoHkc,5105
+iqm/station_control/interface/models/jobs.py,sha256=-e_mW66vD3FMqQAPFuSwwn9YSTuqIrw-ZqEzlDBFoAc,6547
 iqm/station_control/interface/models/monitor.py,sha256=ItlgxtBup1hHg64uKeMKiFE7MaRRqSYdVRttsFD_XeU,1352
-iqm/station_control/interface/models/observation.py,sha256=FwhlI2xXZ_2-PA-LcDvscHuTbfdTWhw67zSNa9Buuvg,3261
-iqm/station_control/interface/models/observation_set.py,sha256=ZNgc-5Yn2o3hmXpjb-3yWGVTz9HNpovu5hhSvDvg5b4,3582
+iqm/station_control/interface/models/observation.py,sha256=IblYdzJN88BNlyxUVR_dIx7BgD_GHGLhHUwy89Fib-I,3281
+iqm/station_control/interface/models/observation_set.py,sha256=EPNv-V_LIHRfJw3PS3kpTECcWqLcDiDFwxf5kuxLFXI,3580
 iqm/station_control/interface/models/run.py,sha256=uEuAMryG-AjAIBTchftw94GpoSBE5SQK2qmlZZ4tq5k,4097
 iqm/station_control/interface/models/sequence.py,sha256=boWlMfP3woVgVObW3OaNbxsUV_qHYP1DA-oIBWj6XIo,2723
 iqm/station_control/interface/models/static_quantum_architecture.py,sha256=gsfJKlYsfZVEK3dqEKXkBSIHiY14DGwNbhPJdNHMtNM,1435
 iqm/station_control/interface/models/sweep.py,sha256=HFoFIrKhlYmHIBfGltY2O9_J28OvkkZILRbDHuqR0wc,2509
 iqm/station_control/interface/models/type_aliases.py,sha256=gEYJ8zOpV1m0NVyYUbAL43psp9Lxw_0t68mYlI65Sds,1262
-iqm_station_control_client-9.4.0.dist-info/LICENSE.txt,sha256=R6Q7eUrLyoCQgWYorQ8WJmVmWKYU3dxA3jYUp0wwQAw,11332
-iqm_station_control_client-9.4.0.dist-info/METADATA,sha256=M4FFW1-VlPczAy4Y_ya3f59SQGxQ4zPkR2yVJX8Rnhg,14010
-iqm_station_control_client-9.4.0.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
-iqm_station_control_client-9.4.0.dist-info/top_level.txt,sha256=NB4XRfyDS6_wG9gMsyX-9LTU7kWnTQxNvkbzIxGv3-c,4
-iqm_station_control_client-9.4.0.dist-info/RECORD,,
+iqm_station_control_client-9.5.0.dist-info/LICENSE.txt,sha256=R6Q7eUrLyoCQgWYorQ8WJmVmWKYU3dxA3jYUp0wwQAw,11332
+iqm_station_control_client-9.5.0.dist-info/METADATA,sha256=kQPo_DNjdBnZCaAYr4mxXduU2M04_fFKvu1LSoRRy1I,14010
+iqm_station_control_client-9.5.0.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
+iqm_station_control_client-9.5.0.dist-info/top_level.txt,sha256=NB4XRfyDS6_wG9gMsyX-9LTU7kWnTQxNvkbzIxGv3-c,4
+iqm_station_control_client-9.5.0.dist-info/RECORD,,