Skip to main content

Qiskit

License Current Release Extended Support Release Downloads Coverage Status PyPI - Python Version Minimum rustc 1.87 Downloads DOI

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.

Qiskit provides two public APIs: a Python API and a C API. The Python API is the primary interface and prior to Qiskit 2.0 was the only public API available for Qiskit. The C API is designed to provide direct access to Qiskit's internal data model (which is written in Rust). The C API can be consumed as either a shared library (libqiskit.so) for standalone use, or from its embedding in the qiskit Python package for writing Python extension modules.

For more details on how to use Qiskit, refer to the documentation located here:

https://quantum.cloud.ibm.com/docs/

Installation

Python

For running Qiskit on Python we recommend installing Qiskit via pip:

pip install qiskit

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.

Standalone C library

To install Qiskit as a standalone C library the only option is currently to build Qiskit from source. This requires having the Rust compiler installed. To simplify building having GNU Make installed is recommended. With these requirements installed you can run:

make c

Which will compile the C library and put the dist/c directory in the root of the repository which will contain the shared library and C headers for the library.

You can refer to the documentation on installing the C API for more details and how to use the built library.

Create your first quantum program in Qiskit

Now that Qiskit is installed, it's time to begin working with Qiskit. We will use the Python interface to demonstrate creating a quantum program. The essential parts of a quantum program are:

  1. Define and build a quantum circuit that represents the quantum state
  2. Define the classical output by measurements or a set of observable operators
  3. 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 $(|000\rangle + i|111\rangle)/\sqrt{2}$. It uses the standard quantum gates: Hadamard gate (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 $XXY+XYX+YXX-YYY$ and pass it to the 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 $0 \leftrightarrow 1 \leftrightarrow 2$ with the 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 the 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:

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: Releases The changelog provides a quick overview of notable changes for a given release.

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.

License

Apache License 2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qiskit-2.5.2.tar.gz (4.3 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

qiskit-2.5.2-cp310-abi3-win_amd64.whl (9.5 MB view details)

Uploaded CPython 3.10+Windows x86-64

qiskit-2.5.2-cp310-abi3-manylinux_2_28_x86_64.whl (9.8 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ x86-64

qiskit-2.5.2-cp310-abi3-manylinux_2_28_s390x.whl (11.2 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ s390x

qiskit-2.5.2-cp310-abi3-manylinux_2_28_ppc64le.whl (10.0 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ ppc64le

qiskit-2.5.2-cp310-abi3-manylinux_2_28_aarch64.whl (9.0 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ ARM64

qiskit-2.5.2-cp310-abi3-macosx_11_0_arm64.whl (8.7 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

qiskit-2.5.2-cp310-abi3-macosx_10_12_x86_64.whl (9.3 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

Details for the file qiskit-2.5.2.tar.gz.

File metadata

  • Download URL: qiskit-2.5.2.tar.gz
  • Upload date:
  • Size: 4.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for qiskit-2.5.2.tar.gz
Algorithm Hash digest
SHA256 cf05388c717392cff5d01be4ea9b45652c2709a5c697c174428d8863089b6247
MD5 976cba5e8c0ba2c6a2414954cb79da8e
BLAKE2b-256 c3b39e080540cf1dedc6ce36d9c346f0d1e17772fb646c09049b609271acf5a0

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit-2.5.2.tar.gz:

Publisher: wheels.yml on Qiskit/qiskit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qiskit-2.5.2-cp310-abi3-win_amd64.whl.

File metadata

  • Download URL: qiskit-2.5.2-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 9.5 MB
  • Tags: CPython 3.10+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for qiskit-2.5.2-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 d436cd45db22ea0132be815930d7c90343774756da9620dee68714968966f65e
MD5 7f597a119c85a4a5878729307468023d
BLAKE2b-256 c2b461872b4ba4319c685615123739b25a3c42abc0f057c4a4889f7b3cad8c7b

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit-2.5.2-cp310-abi3-win_amd64.whl:

Publisher: wheels.yml on Qiskit/qiskit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qiskit-2.5.2-cp310-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for qiskit-2.5.2-cp310-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 28fcb983e565b8f027a13ef43cda7aaeb1f1a6caf9df07408708abcf7bc0b59d
MD5 37e9bfb369d860e8afc013bfc228d026
BLAKE2b-256 c4321e411db90b68a6096275186e7fc57ea16d99355fc3b498182845dd5419ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit-2.5.2-cp310-abi3-manylinux_2_28_x86_64.whl:

Publisher: wheels.yml on Qiskit/qiskit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qiskit-2.5.2-cp310-abi3-manylinux_2_28_s390x.whl.

File metadata

File hashes

Hashes for qiskit-2.5.2-cp310-abi3-manylinux_2_28_s390x.whl
Algorithm Hash digest
SHA256 c2eab89804161dd927d25d521c6c43af1bcd17042e6b02124166d6d07a9c9cb1
MD5 8b45672abbf47f3c348a2f3920ec817e
BLAKE2b-256 ed92404d085301365d79a06a1ae34b4292e35a510a22a32ec0b5a8e8ee1d87dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit-2.5.2-cp310-abi3-manylinux_2_28_s390x.whl:

Publisher: wheels.yml on Qiskit/qiskit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qiskit-2.5.2-cp310-abi3-manylinux_2_28_ppc64le.whl.

File metadata

File hashes

Hashes for qiskit-2.5.2-cp310-abi3-manylinux_2_28_ppc64le.whl
Algorithm Hash digest
SHA256 d7940da5ea03d638bace6f9cc47bb892502c85a9c05eebe1cbe3c0e693586109
MD5 8865a0dc2de6450bf7a07d308c94f104
BLAKE2b-256 e037b09591e2386b0c4773d2c405ace6e89552366fc798df7f3ee72b46b26603

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit-2.5.2-cp310-abi3-manylinux_2_28_ppc64le.whl:

Publisher: wheels.yml on Qiskit/qiskit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qiskit-2.5.2-cp310-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for qiskit-2.5.2-cp310-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 2835e38af67932e592562c7b1b6b7fadd015bd1101a1320e2c5051de12508428
MD5 8aae41c538c423bcc3f67a7826fa1f1f
BLAKE2b-256 43420eb83d0eefd6a1d3752db43839c327c39d67b2ef060b2b1da8fcd3424dc5

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit-2.5.2-cp310-abi3-manylinux_2_28_aarch64.whl:

Publisher: wheels.yml on Qiskit/qiskit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qiskit-2.5.2-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for qiskit-2.5.2-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c559ee1e2a92b5ded6a130f1fd8dc4bea19a5b35e99d39180889746f12550666
MD5 74ac8bb5397bcf159c1a7c1b4de69f8b
BLAKE2b-256 60c426f9f63a6954b69778b7401822e7855ed62194c959562e4ad3645e5ebfca

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit-2.5.2-cp310-abi3-macosx_11_0_arm64.whl:

Publisher: wheels.yml on Qiskit/qiskit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qiskit-2.5.2-cp310-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for qiskit-2.5.2-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 4aa7ddb0d9c1cd14298bf2fdd242646a5e0eaeebdebd2f31d5d2a018c75fa744
MD5 1d14699afe54e212e6de69b7958c73fa
BLAKE2b-256 9c6692681da23c4f4502fabe16cb23c7c98d141ae1e25a2f14fdd8e351ae8ef8

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit-2.5.2-cp310-abi3-macosx_10_12_x86_64.whl:

Publisher: wheels.yml on Qiskit/qiskit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page