Note

This is the documentation for the current state of the development branch of Qiskit Experiments. The documentation or APIs here can change prior to being released.

Database Service (qiskit_experiments.database_service)

This subpackage provides database-specific utility functions and exceptions which are used with the ExperimentData and AnalysisResult classes.

Device Components

DeviceComponent()	Abstract class representing a device component.
Qubit(index)	Class representing a qubit device component.
Resonator(index)	Class representing a resonator device component.
UnknownComponent(component)	Class representing an unknown device component.
to_component(string)	Convert the input string to a DeviceComponent instance.

Dataclasses

DbExperimentData([experiment_id, parent_id, ...])	Dataclass for experiments in the database.
DbAnalysisResultData([result_id, ...])	Dataclass for experiment analysis results in the database.

Constants

ResultQuality(*values)

Possible values for analysis result quality.

Services

LocalExperimentService([db_dir])

Provides local experiment database services.

Exceptions

ExperimentDataError(*message)	Base class for errors raised by experiment service data.
ExperimentDataSaveFailed(*message)	Errors raised when an experiment save fails.
ExperimentEntryExists(*message)	Errors raised when an experiment entry already exists.
ExperimentEntryNotFound(*message)	Errors raised when an experiment entry cannot be found.