a3b359b899
* Add tweedledum to requirements-dev.txt This commit adds a tweedledum to the requirements-dev.txt list. Since the release of qiskit-terra 0.23.0 the CI docs job has started to fail. This is because tweedledum is a requirement for the classicalfunction compiler docs. It turns out we were getting tweedledum installed in docs build jobs via a weird path. The install order for docs build was installing packages that require qiskit-terra before terra itself was being installed. This would cause qiskit-terra from pypi from being isntalled first, and old versions of terra required tweedledum which would install it. Then we'd later upgrade terra to the current version under test. To fix this in the short term this adds add tweedledum to the requirements list so we unblock CI. One thing to note is that since the primary reason we removed tweedledum from the requirements list in #8947 was because macOS users were not able to install it reliably the new entry in the requirement-dev.txt list does not cause issues for developers on macOS systems. Longer term we should make two fixes, first we need to update the classicalfunction compiler docs so they build without having tweedledum installed. The second is we should update the CI job to avoid installing terra from pypi before we build it from source. But, given that CI is currently broken just adding it to the requirements-dev.txt list is the fastest fix. * Exclude tweedledum on Python 3.11 too |
||
---|---|---|
.azure | ||
.binder | ||
.cargo | ||
.github | ||
docs | ||
examples | ||
qiskit | ||
releasenotes | ||
src | ||
test | ||
tools | ||
.editorconfig | ||
.git-blame-ignore-revs | ||
.gitignore | ||
.local-spellings | ||
.mailmap | ||
.mergify.yml | ||
.pylintrc | ||
.stestr.conf | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
Cargo.lock | ||
Cargo.toml | ||
LICENSE.txt | ||
MANIFEST.in | ||
Makefile | ||
README.md | ||
azure-pipelines.yml | ||
constraints.txt | ||
pyproject.toml | ||
qiskit_bot.yaml | ||
requirements-dev.txt | ||
requirements.txt | ||
setup.py | ||
tox.ini |
README.md
Qiskit Terra
Qiskit is an open-source framework for working with noisy quantum computers at the level of pulses, circuits, and algorithms.
This library is the core component of Qiskit, Terra, which contains the building blocks for creating and working with quantum circuits, programs, and algorithms. 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
. The following command installs the core Qiskit components, including Terra.
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 Terra
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 simple 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 example scripts in examples/python. You can start with using_qiskit_terra_level_0.py and working up in the levels. Also you can refer to 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:
- https://github.com/Qiskit/qiskit-ibmq-provider
- https://github.com/Qiskit-Partners/qiskit-ionq
- https://github.com/Qiskit-Partners/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 Terra, please take a look at our contribution guidelines. This project adheres to Qiskit's code of conduct. By participating, you are expected to uphold this code.
We use GitHub issues for tracking requests and bugs. Please
join the Qiskit Slack community
and use our Qiskit Slack channel for discussion and simple questions.
For questions that are more suited for a forum we use the qiskit
tag in the Stack Exchange.
Next Steps
Now you're set up and ready to check out some of the other examples from our Qiskit Tutorials repository.
Authors and Citation
Qiskit Terra 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: 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