Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

Qiskit Tools


A helper module to get IBM backend information and submitted job status.

job_monitor, interval=None, quiet=False, output=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>, line_discipline='\r') GitHub(opens in a new tab)

Monitor the status of a Job instance.


  • job (BaseJob) – Job to monitor.
  • interval (int(opens in a new tab)) – Time interval between status queries.
  • quiet (bool(opens in a new tab)) – If True, do not print status messages.
  • output (file) – The file like object to write status messages to.
  • default (By) –
  • sys.stdout. (this is) –
  • line_discipline (string) – character emitted at start of a line of job monitor output,
  • r. (This defaults to) –


from qiskit import BasicAer, transpile
from qiskit.circuit import QuantumCircuit
from import job_monitor
sim_backend = BasicAer.get_backend("qasm_simulator")
qc = QuantumCircuit(2, 2)
qc.h(0), 1)
tqc = transpile(qc, sim_backend)
job_sim =

backend_monitor GitHub(opens in a new tab)

Monitor a single IBM Quantum backend.


backend (IBMBackend) – Backend to monitor.


Examples: .. code-block:: python

from qiskit_ibm_provider import IBMProvider from import backend_monitor provider = IBMProvider() backend_monitor(provider.get_backend(‘ibm_sherbrooke’))

backend_overview GitHub(opens in a new tab)

Gives overview information on all the IBM Quantum backends that are available.


from import backend_overview

Events (

A helper component for publishing and subscribing to events. GitHub(opens in a new tab)

A simple text-based progress bar.

output_handlerthe handler the progress bar should be written to, default

is sys.stdout, another option is sys.stderr


The progress bar can be used to track the progress of a parallel_map.

import numpy as np
from import parallel_map
from import TextProgressBar
%qiskit_progress_bar -t text
parallel_map(np.sin, np.linspace(0,10,100));

And it can also be used individually.

from import TextProgressBar
iterations = 100
t = TextProgressBar()
for i in range(iterations):
    # step i of heavy calculation ...
    t.update(i + 1)  # update progress bar
Was this page helpful?
Report a bug or request content on GitHub.