Qiskit
Qiskit is an open-source SDK for working with quantum computers at the level of extended quantum circuits, operators, and primitives.
This library is the core component of Qiskit, which contains the building blocks for creating and working with quantum circuits, quantum operators, and primitive functions (Sampler and Estimator). It also contains a transpiler that supports optimizing quantum circuits, and a quantum information toolbox for creating advanced operators.
For more details on how to use Qiskit, refer to the documentation located here:
https://quantum.cloud.ibm.com/docs/
Installation
We encourage installing Qiskit via pip:
Pip will handle all dependencies automatically and you will always install the latest (and well-tested) version.
To install from source, follow the instructions in the documentation.
Create your first quantum program in Qiskit
Now that Qiskit is installed, it's time to begin working with Qiskit. The essential parts of a quantum program are:
- Define and build a quantum circuit that represents the quantum state
- Define the classical output by measurements or a set of observable operators
- Depending on the output, use the Sampler primitive to sample outcomes or the Estimator primitive to estimate expectation values.
Create an example quantum circuit using the QuantumCircuit class:
import numpy as np from qiskit import QuantumCircuit # 1. A quantum circuit for preparing the quantum state |000> + i |111> / √2 qc = QuantumCircuit(3) qc.h(0) # generate superposition qc.p(np.pi / 2, 0) # add quantum phase qc.cx(0, 1) # 0th-qubit-Controlled-NOT gate on 1st qubit qc.cx(0, 2) # 0th-qubit-Controlled-NOT gate on 2nd qubit
This simple example creates an entangled state known as a GHZ state h), Phase gate (p), and CNOT gate (cx).
Once you've made your first quantum circuit, choose which primitive you will use. Starting with the Sampler,
we use measure_all(inplace=False) to get a copy of the circuit in which all the qubits are measured:
# 2. Add the classical output in the form of measurement of all qubits qc_measured = qc.measure_all(inplace=False) # 3. Execute using the Sampler primitive from qiskit.primitives import StatevectorSampler sampler = StatevectorSampler() job = sampler.run([qc_measured], shots=1000) result = job.result() print(f" > Counts: {result[0].data['meas'].get_counts()}")
Running this will give an outcome similar to {'000': 497, '111': 503} which is 000 50% of the time and 111 50% of the time up to statistical fluctuations.
To illustrate the power of the Estimator, we now use the quantum information toolbox to create the operator run() function, along with our quantum circuit. Note that the Estimator requires a circuit without measurements, so we use the qc circuit we created earlier.
# 2. Define the observable to be measured from qiskit.quantum_info import SparsePauliOp operator = SparsePauliOp.from_list([("XXY", 1), ("XYX", 1), ("YXX", 1), ("YYY", -1)]) # 3. Execute using the Estimator primitive from qiskit.primitives import StatevectorEstimator estimator = StatevectorEstimator() job = estimator.run([(qc, operator)], precision=1e-3) result = job.result() print(f" > Expectation values: {result[0].data.evs}")
Running this will give the outcome 4. For fun, try to assign a value of +/- 1 to each single-qubit operator X and Y
and see if you can achieve this outcome. (Spoiler alert: this is not possible!)
Using the Qiskit-provided qiskit.primitives.StatevectorSampler and qiskit.primitives.StatevectorEstimator will not take you very far.
The power of quantum computing cannot be simulated on classical computers and you need to use real quantum hardware to scale to larger quantum circuits.
However, running a quantum circuit on hardware requires rewriting to the basis gates and connectivity of the quantum hardware.
The tool that does this is the transpiler, and Qiskit includes transpiler passes for synthesis, optimization, mapping, and scheduling.
However, it also includes a default compiler, which works very well in most examples.
The following code will map the example circuit to the basis_gates = ["cz", "sx", "rz"] and a
bidirectional linear chain of qubits coupling_map = [[0, 1], [1, 0], [1, 2], [2, 1]].
from qiskit import transpile from qiskit.transpiler import Target, CouplingMap target = Target.from_configuration( basis_gates=["cz", "sx", "rz"], coupling_map=CouplingMap.from_line(3), ) qc_transpiled = transpile(qc, target=target)
Executing your code on real quantum hardware
Qiskit provides an abstraction layer that lets users run quantum circuits on hardware from any vendor that provides a compatible interface.
The best way to use Qiskit is with a runtime environment that provides optimized implementations of Sampler and Estimator for a given hardware platform. This runtime may involve using pre- and post-processing, such as optimized transpiler passes with error suppression, error mitigation, and, eventually, error correction built in. A runtime implements qiskit.primitives.BaseSamplerV2 and qiskit.primitives.BaseEstimatorV2 interfaces. For example,
some packages that provide implementations of a runtime primitive implementation are:
Qiskit also provides a lower-level abstract interface for describing quantum backends. This interface, located in
qiskit.providers, defines an abstract BackendV2 class that providers can implement to represent their
hardware or simulators to Qiskit. The backend class includes a common interface for executing circuits on the backends; however, in this interface each provider may perform different types of pre- and post-processing and return outcomes that are vendor-defined. Some examples of published provider packages that interface with real hardware are:
- https://github.com/qiskit-community/qiskit-ionq
- https://github.com/qiskit-community/qiskit-aqt-provider
- https://github.com/qiskit-community/qiskit-braket-provider
- https://github.com/qiskit-community/qiskit-quantinuum-provider
- https://github.com/rigetti/qiskit-rigetti
You can refer to the documentation of these packages for further instructions on how to get access and use these systems.
Contribution Guidelines
If you'd like to contribute to Qiskit, please take a look at our contribution guidelines. By participating, you are expected to uphold our code of conduct.
We use GitHub issues for tracking requests and bugs. Please
join the Qiskit Slack community for discussion, comments, and questions.
For questions related to running or using Qiskit, Stack Overflow has a qiskit.
For questions on quantum computing with Qiskit, use the qiskit tag in the Quantum Computing Stack Exchange (please, read first the guidelines on how to ask in that forum).
Authors and Citation
Qiskit is the work of many people who contribute to the project at different levels. If you use Qiskit, please cite as per the included BibTeX file.
Changelog and Release Notes
The changelog for a particular release is dynamically generated and gets
written to the release page on Github for each release. For example, you can
find the page for the 1.2.0 release here:
https://github.com/Qiskit/qiskit/releases/tag/1.2.0
The changelog for the current release can be found in the releases tab:
Additionally, as part of each release, detailed release notes are written to document in detail what has changed as part of a release. This includes any documentation on potential breaking changes on upgrade and new features. See all release notes here.
Acknowledgements
We acknowledge partial support for Qiskit development from the DOE Office of Science National Quantum Information Science Research Centers, Co-design Center for Quantum Advantage (C2QA) under contract number DE-SC0012704.