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.
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 26.10.0

The scheduled_experiment constructor argument was removed. Obtain a CompiledExperiment by compiling an experiment.

Removed in version 26.10.0

The .experiment_dict attribute, deprecated since version 2.14.0, was removed. Use .experiment instead.

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.˝

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.

scheduled_experiment cached property

The internal representation of the compiled experiment.

Available for debugging but subject to change in any LabOne Q release.

set_coprocessor_payload(coprocessor_label, payload)

Attach a payload to a coprocessor, post-compile.

Takes precedence over the payload declared in the experiment body with Coprocessor.set_payload(...).

Parameters:

Name	Type	Description	Default
coprocessor_label	str	The coprocessor label, as declared in the experiment body.	required
payload	bytes	Opaque to LabOne Q.	required

Raises:

Type	Description
TypeError	If payload is not bytes.
LabOneQException	If the label is not a coprocessor of this compiled experiment.

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.