laboneq.core
¶
laboneq.core.types.compiled_experiment
¶
CompiledExperiment()
dataclass
¶
Data structure to store the output of the compiler.
Attributes:
| Name | Type | Description |
|---|---|---|
device_setup |
DeviceSetup
|
The device setup the experiment was compiled for. |
experiment |
Experiment
|
The (uncompiled) experiment. |
experiment_dict |
deprecated
|
Deprecated. A representation of the source experiment, using
primitive Python datatypes only (dicts, lists, etc).
Use |
scheduled_experiment |
internal
|
Internal. The internal representation of the compiled experiment. Available for debugging but subject to change in any LabOne Q release. |
Changed in version 2.54.0
The following deprecated methods for saving and loading were removed:
- load
- save
Use the load and save functions from the laboneq.simple module instead.
Changed in version 2.56.0
The .device_setup and .experiment attributes were no longer deprecated.
Deprecated in version 2.51.0
The .device_setup and .experiment attributes were
deprecated in version 2.51.0 and will be removed in a
future release. Manage and track the device setup and experiment
separately if they are needed.
Note that the .device_setup and .experiment were no longer
deprecated in version 2.56.0.˝
Deprecated in version 2.14.0
The .experiment_dict attribute was deprecated in
version 2.14.0. Use .experiment instead.
Changed in version 2.14.0
The .scheduled_experiment attribute was documented to
be internal and subject to change.
estimated_runtime
property
¶
An estimation of the total runtime of the experiment in seconds.
DISCLAIMER: This estimation does not include any overhead from network, IO, or python runtime.
result_properties
property
¶
Properties of results for each handle.
set_coprocessor_payload(coprocessor_label, payload)
¶
Override the payload for a coprocessor, post-compile.
The experiment-body Coprocessor.set_payload(...) declares the
initial payload; this method overrides it post-compilation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
coprocessor_label
|
str
|
The coprocessor label (as declared in the experiment body). |
required |
payload
|
bytes
|
The new payload. Opaque to LabOne Q. |
required |
laboneq.core.exceptions.laboneq_exception
¶
LabOneQException
¶
Bases: Exception
Base class for exceptions raised by LabOne Q.
Where appropriate, LabOne Q also raises built-in Python exceptions such as ValueError, TypeError and RuntimeError.