Repository files navigation

⚠️This repository is archived: The content in this repositorywas moved to other locations. If you have issues or PR, please submit them to their new location.

• algorithms folder ->qiskit-algorithms (GitHub)
• circuits folder ->Qiskit (GitHub)
• circuits_advanced folder ->Qiskit (GitHub)
• opflow folder ->Qiskit (GitHub)
• simulators folder ->qiskit-aer (GitHub)
• textbook folder -> removed in favor ofhttps://www.qiskit.org/learn

Welcome to theQiskit Tutorials!

In this repository, we've put together a collection of Jupyter notebooks aimed at teaching people who want to use Qiskit for writing quantum computing programs, and executing them on one of several backends (online quantum processors, online simulators, and local simulators). The online quantum processors are theIBM Quantum systems.

For our community-contributed tutorials, please check out theqiskit-community-tutorials repository.

If you'd like to contribute to Qiskit Tutorials, please take a look at ourcontribution guidelines. This project adheres to Qiskit'scode of conduct. By participating you are expected to uphold this code.

Because the tutorials are executed as part of the build process, and eventually turned into RST documentation, there are several limitations to be aware of:

1. There is currently a three minute per cell execution time limit. Cells that go over this limit will raise an exception.

2. Tutorials cannot make calls to the IBM Quantum Experience, e.g. noIBMQ.load_account().

3. It is important to maintain strict header compliance. All notebooks should start with, and contain only one, top level (h1) header:

   # I am a top level header

   Additionally, the nesting of headers should make sense:

   # I am a top level header## I am a secondary header### I am a tertiary header## I am another secondary header## I am another secondary header

4. All math equations expressed using$$ ... $$ need to be surrounded on top and bottom by white space.

5. In order for a tutorial to show up in the Qiskit documentation, after successful merging, an additional PR needs to be made in theQiskit meta-repo to trigger the rebuilding of the documentation.

To add a gallery image to a notebook, select a cell with an output image and addnbsphinx-thumbnail as a cell tag. To see the cell tags go to:View -> Cell Toolbar -> Tags in the notebook menu. Adding gallery images from images not generated inside of the notebooks themselves should be avoided if possible as this gets messy in the present build system.

In addition to serving up standalone notebooks, this repository also includes the infrastructure needed to build the tutorials into HTML documentation usingSphinx.

We useTox, which you will need to install globally (e.g. usingpipx).

1. Fork and clone the forked repository.
2. tox -e docs

Sometimes Sphinx's caching can get in a bad state. First, try runningtox -e docs-clean, which will remove Sphinx's cache. If you are still having issues, try runningtox -e docs -r.-r tells Tox to reinstall the dependencies.

Qiskit Tutorials is the work ofmany people who contribute to the project at different levels. If you use Qiskit, please cite as per the includedBibTeXfile.

Apache License 2.0