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

ExperimentData.job_status()[source]

Return the experiment job execution status.

Possible return values for qiskit.providers.jobstatus.JobStatus are

  • ERROR - if any job incurred an error

  • CANCELLED - if any job is cancelled.

  • RUNNING - if any job is still running.

  • QUEUED - if any job is queued.

  • VALIDATING - if any job is being validated.

  • INITIALIZING - if any job is being initialized.

  • DONE - if all jobs are finished.

Note

If an experiment has status ERROR or CANCELLED 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:

JobStatus

Returns:

The job execution status.