Skip to content
This repository was archived by the owner on Aug 21, 2023. It is now read-only.

Commit d94cbb3

Browse files
authored
Update README.md
1 parent cb6cf12 commit d94cbb3

1 file changed

Lines changed: 40 additions & 24 deletions

File tree

README.md

Lines changed: 40 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,53 @@
1-
<img src="images/qiskit_header.png" >
2-
31
# Qiskit Tutorials
42

53
[![License](https://img.shields.io/github/license/Qiskit/qiskit-tutorials.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)
64

7-
Welcome to the [Qiskit](https://www.qiskit.org/) Tutorials!
5+
These tutorials are rendered as part of the:
86

9-
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 the [IBM Quantum](https://quantum-computing.ibm.com) systems.
7+
### [>>Qiskit Documentation<<](Qiskit documentation](https://qiskit.org/documentation/)
108

11-
For our community-contributed tutorials, please check out the [qiskit-community-tutorials](https://github.com/Qiskit/qiskit-community-tutorials) repository.
129

13-
## Installation
1410

15-
The notebooks for these tutorials can be viewed here on GitHub. However, for the
16-
full experience, you will want to interact with them. The easiest way to do this
17-
is by logging into the [IBM Quantum Experience](https://quantum-computing.ibm.com/),
18-
which lets you use Jupyter notebooks, including these tutorials, via the web.
11+
## Contents
1912

20-
Please refer to this [installation guide](INSTALL.md) for setting up Qiskit and
21-
the tutorials on your own machine (this is the recommended way).
13+
Welcome to the [Qiskit](https://www.qiskit.org/) Tutorials!
2214

23-
## Contents
15+
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 the [IBM Quantum](https://quantum-computing.ibm.com) systems.
2416

25-
To start seeing how Qiskit works, load up the [start_here.ipynb](start_here.ipynb) notebook
26-
or view the tutorials in the [Qiskit documentation](https://qiskit.org/documentation/).
17+
For our community-contributed tutorials, please check out the [qiskit-community-tutorials](https://github.com/Qiskit/qiskit-community-tutorials) repository.
18+
19+
## Contribution Guidelines
20+
21+
If you'd like to contribute to Qiskit Tutorials, please take a look at our [contribution guidelines](.github/CONTRIBUTING.md). This project adheres to Qiskit's [code of conduct](.github/CODE_OF_CONDUCT.md). By participating, you are expect to uphold to this code.
22+
23+
### Tutorial limitations
24+
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:
25+
26+
1. There is currently a 3min/cell execution time limit. Cells that go over this limit will raise an exception.
27+
28+
2. It is important to maintain stict header compliance. All notebooks should start with, and contain only one, top level (h1) header:
29+
30+
```
31+
# I am a top level header
32+
```
33+
34+
Additionally, the nesting of headers should make sense:
35+
36+
```
37+
# I am a top level header
38+
39+
## I am a secondary header
40+
41+
### I am a tertiary header
42+
43+
## I am another secondary header
44+
45+
## I am another secondary header
46+
```
47+
48+
### Adding a gallery image
49+
50+
To add a gallery image to a notebook, select a cell with an output image and add `nbsphinx-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.
2751
2852
## Building documentation
2953
@@ -35,17 +59,9 @@ pip install sphinx-rtd-theme
3559
pip install nbsphinx
3660
```
3761

38-
## Contribution Guidelines
39-
40-
If you'd like to contribute to Qiskit IQX Tutorials, please take a look at our [contribution guidelines](.github/CONTRIBUTING.md). This project adheres to Qiskit's [code of conduct](.github/CODE_OF_CONDUCT.md). By participating, you are expect to uphold to this code.
41-
42-
We use [GitHub issues](https://github.com/Qiskit/qiskit-iqx-tutorials/issues) for tracking requests and bugs. Please use our [Slack](https://qiskit.slack.com) for discussion and simple questions. To join our Slack community, use the
43-
[link](https://join.slack.com/t/qiskit/shared_invite/enQtODQ2NTIyOTgwMTQ3LTI0NzM2NzkzZjJhNDgzZjY5MTQzNDY3MGNiZGQzNTNkZTE4Nzg1MjMwMmFjY2UwZTgyNDlmYWQwYmZjMjE1ZTM).
44-
For questions that are more suited for a forum, we use the Qiskit tag in the [Stack Exchange](https://quantumcomputing.stackexchange.com/questions/tagged/qiskit).
45-
4662
## Authors and Citation
4763

48-
Qiskit IQX Tutorials is the work of [many people](https://github.com/Qiskit/qiskit-iqx-tutorials/graphs/contributors) who contribute to the project at different levels. If you use Qiskit, please cite as per the included [BibTeX
64+
Qiskit Tutorials is the work of [many people](https://github.com/Qiskit/qiskit-tutorials/graphs/contributors) who contribute to the project at different levels. If you use Qiskit, please cite as per the included [BibTeX
4965
file](https://github.com/Qiskit/qiskit/blob/master/Qiskit.bib).
5066

5167
## License

0 commit comments

Comments
 (0)