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.

ExperimentData.status

ExperimentData.status()

Return the experiment status.

Possible return values for ExperimentStatus are

• EMPTY - experiment data is empty

• INITIALIZING - experiment jobs are being initialized

• QUEUED - experiment jobs are queued

• RUNNING - experiment jobs is actively running

• CANCELLED - experiment jobs or analysis has been cancelled

• POST_PROCESSING - experiment analysis is actively running

• DONE - experiment jobs and analysis have successfully run

• ERROR - experiment jobs or analysis incurred an error

Note

If an experiment has status ERROR there may still be pending or running jobs. In these cases it may be beneficial to call cancel_jobs() to terminate these remaining jobs.

Return type:

ExperimentStatus

Returns:

The experiment status.