Skip to content

Reference

This is the API reference documentation. To browse it use the navigation on the left.

Summary

The package provides various modules to either run pre-defined experiment workflows, define custom workflows or any other experiment building blocks.

Using pre-built experiment workflows

  • laboneq_applications.qpu_types

Definitions for the units of quantum-computing experiment quantum platforms, such as TunableTransmonQubit, TunableTransmonOperations, QuantumPlatform and QPU to be used in experiment workflows.

  • laboneq_applications.experiments

Ready-made experiment workflows ready to run with LabOne Q integration. This includes experiments such as Amplitude Rabi (amplitude_rabi) or Ramsey (ramsey) and many more.

  • laboneq_applications.analysis

Analysis workflows, tasks and tools for the analysis routines of various experiments, such as calibration_traces_rotation, fitting_helpers, plotting_helpers.

  • laboneq.workflow.logbook

Logbooks for recording the execution of experiment workflows. Objects such as LogbookStore to create logbooks, FolderStore for saving the experiment data and LoggingStore for logging the execution of an experiment.

Creating experiment workflows

  • laboneq.workflow

A module that exposes building blocks for creating experiment workflows, such as @task and @workflow decorators, which turn Python functions into task and workflow objects respectively, or WorkflowOptions and TaskOptions used to parametrize the control of a workflow.

  • laboneq.workflow.tasks and laboneq_applications.tasks

A module containing common tasks that may be used within experiment workflows such as compile_experiment, run_experiment and update_qubits.

  • laboneq.dsl

A namespace that exposes commonly used objects and extensions for building an LabOne Q Experiment, such as the decorator @qubit_experiment, alongside common quantum operations such as play(), measure(), etc.

  • laboneq_applications.contrib

Experiment and analysis workflows as well as QuantumElement types and quantum operations added by us or contributed by our customers. This content is primarily here for reference, and its correct functionality is not guaranteed.