/qiskit-terra

Qiskit is an open-source SDK for working with quantum computers at the level of extended quantum circuits, operators, and algorithms.

Primary LanguagePythonApache License 2.0Apache-2.0

Qiskit

License Release Downloads Coverage Status PyPI - Python Version Minimum rustc 1.64.0 Downloads DOI

Qiskit is an open-source framework for working with noisy quantum computers at the level of pulses, circuits, and algorithms.

This framework allows for building, transforming, and visualizing quantum circuits. It also contains a compiler that supports different quantum computers and a common interface for running programs on different quantum computer architectures.

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

https://qiskit.org/documentation/

Installation

We encourage 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.

Creating Your First Quantum Program in Qiskit

Now that Qiskit is installed, it's time to begin working with Qiskit. To do this we create a QuantumCircuit object to define a basic quantum program.

from qiskit import QuantumCircuit
qc = QuantumCircuit(2, 2)
qc.h(0)
qc.cx(0, 1)
qc.measure([0,1], [0,1])

This example makes an entangled state, also called a Bell state.

Once you've made your first quantum circuit, you can then simulate it. To do this, first we need to compile your circuit for the target backend we're going to run on. In this case we are leveraging the built-in BasicAer simulator. However, this simulator is primarily for testing and is limited in performance and functionality (as the name implies). You should consider more sophisticated simulators, such as qiskit-aer, for any real simulation work.

from qiskit import transpile
from qiskit.providers.basicaer import QasmSimulatorPy
backend_sim = QasmSimulatorPy()
transpiled_qc = transpile(qc, backend_sim)

After compiling the circuit we can then run this on the backend object with:

result = backend_sim.run(transpiled_qc).result()
print(result.get_counts(qc))

The output from this execution will look similar to this:

{'00': 513, '11': 511}

For further examples of using Qiskit you can look at the tutorials in the documentation here:

https://qiskit.org/documentation/tutorials.html

Executing your code on a real quantum chip

You can also use Qiskit to execute your code on a real quantum processor. Qiskit provides an abstraction layer that lets users run quantum circuits on hardware from any vendor that provides an interface to their systems through Qiskit. Using these providers you can run any Qiskit code against real quantum computers. Some examples of published provider packages for running on 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 0.9.0 release here:

https://github.com/Qiskit/qiskit-terra/releases/tag/0.9.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. For example, you can find the release notes for the 0.9.0 release in the Qiskit documentation here:

https://qiskit.org/documentation/release_notes.html#terra-0-9

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