Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 5.98 KB

README.md

File metadata and controls

90 lines (61 loc) · 5.98 KB

Image

License Build Status Build Status Downloads DOI

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

Qiskit is made up of elements that work together to enable quantum computing. This is a simple meta-package to install the elements of Qiskit altogether.

Installation

The best way of installing qiskit is by using pip:

$ pip install qiskit

See install Qiskit for detailed instructions, how to use virtual environments, and build from source standalone versions of the individual Qiskit elements and components.

Qiskit Packaging

The Qiskit project is made up of many components that all serve a particular purpose. This repository contains a meta-package that will install the following components:

Build Version Contribute
Qiskit Terra
Qiskit Aer

Deprecated

These components are installed as part of the metapackage for the time being, but are deprecated (or will be deprecated in the near future) and will be removed in a future release.

Build Version Contribute
Qiskit IBM Quantum Provider

Optional components

These components are part of the Qiskit ecosystem but are built on top of qiskit and are not installed by default with the meta-package. You can either install them manually, as an optional extra (ie pip install "qiskit[finance,experiments]"), or all together with pip install "qiskit[all]".

Build Version Contribute
Qiskit Optimization
Qiskit Finance
Qiskit Machine Learning
Qiskit Nature
Qiskit Experiments

Using quantum services

If you are interested in using quantum services (i.e. using a real quantum computer, not a simulator) you can look at the Qiskit Partners program for partner organizations that have provider packages available for their offerings:

https://qiskit.org/documentation/partners/

Contribution Guidelines

If you'd like to contribute to Qiskit, 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 use our Slack 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 our Qiskit Tutorials repository.

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.

License

Apache License 2.0