Table of Contents

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.

BaseExperiment.run

BaseExperiment.run(backend=None, analysis='default', timeout=None, **run_options)[source]

Run an experiment and perform analysis.

Parameters:

  • backend (Optional[Backend]) – Optional, the backend to run the experiment on. This will override any currently set backends for the single execution.

  • analysis (Optional[BaseAnalysis]) – Optional, a custom analysis instance to use for performing analysis. If None analysis will not be run. If "default" the experiments analysis() instance will be used if it contains one.

  • timeout (Optional[float]) – Time to wait for experiment jobs to finish running before cancelling.

  • run_options – backend runtime options used for circuit execution.

Return type:

ExperimentData

Returns:

The experiment data object.

Raises:

QiskitError – If experiment is run with an incompatible existing ExperimentData container.