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

Commit 149eae9

Browse files
committed
Merge remote-tracking branch 'upstream/master'
2 parents cc5ffd5 + fc8978d commit 149eae9

757 files changed

Lines changed: 3355 additions & 127610 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/CODEOWNERS

Lines changed: 7 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -3,54 +3,13 @@
33

44
# Codeowners for individual folders
55
qiskit/* @jaygambetta @ajavadia
6+
7+
qiskit/aqua/**/* @jaygambetta @pistoia
8+
qiskit/artificial_intelligence/**/* @jaygambetta @pistoia
9+
qiskit/chemistry/**/* @jaygambetta @pistoia
10+
qiskit/finance/**/* @jaygambetta @pistoia
11+
qiskit/optimization/**/* @jaygambetta @pistoia
12+
613
qiskit/aer/* @chriseclectic @jaygambetta @ajavadia
714
qiskit/ignis/* @dcmckayibm @jaygambetta @ajavadia
815
qiskit/terra/* @nonhermitian @jaygambetta @ajavadia
9-
10-
community/* @attp @aasfaw @quantumjim @rraymondhp
11-
12-
community/aer/* @chriseclectic @attp @aasfaw @quantumjim @rraymondhp
13-
14-
community/algorithms/* @attp @aasfaw @quantumjim @rraymondhp
15-
community/algorithms/* @attp @aasfaw @quantumjim @rraymondhp
16-
17-
community/arts/* @attp @aasfaw @quantumjim @rraymondhp
18-
19-
community/aqua/* @chunfuchen @pistoia @aasfaw
20-
community/aqua/*/* @chunfuchen @pistoia @aasfaw
21-
community/aqua/*/*/* @chunfuchen @pistoia @aasfaw
22-
23-
community/artificial_intelligence/* @chunfuchen @pistoia @aasfaw
24-
community/artificial_intelligence/*/* @chunfuchen @pistoia @aasfaw
25-
community/artificial_intelligence/*/*/* @chunfuchen @pistoia @aasfaw
26-
27-
community/chemistry/* @chunfuchen @pistoia @aasfaw
28-
community/chemistry/*/* @chunfuchen @pistoia @aasfaw
29-
community/chemistry/*/*/* @chunfuchen @pistoia @aasfaw
30-
31-
community/finance/* @chunfuchen @pistoia @aasfaw
32-
community/finance/*/* @chunfuchen @pistoia @aasfaw
33-
community/finance/*/*/* @chunfuchen @pistoia @aasfaw
34-
35-
community/optimization/* @chunfuchen @pistoia @aasfaw
36-
community/optimization/*/* @chunfuchen @pistoia @aasfaw
37-
community/optimization/*/*/* @chunfuchen @pistoia @aasfaw
38-
39-
community/awards/teach_me_qiskit_2018/* @attp @aasfaw @quantumjim @rraymondhp
40-
community/awards/teach_me_qiskit_2018/*/* @attp @aasfaw @quantumjim @rraymondhp
41-
42-
community/awards/teach_me_quantum_2018/* @attp @aasfaw @quantumjim @rraymondhp
43-
community/awards/teach_me_quantum_2018/*/* @attp @aasfaw @quantumjim @rraymondhp
44-
45-
community/games/* @attp @aasfaw @quantumjim @rraymondhp
46-
community/games/*/* @attp @aasfaw @quantumjim @rraymondhp
47-
community/games/*/*/* @attp @aasfaw @quantumjim @rraymondhp
48-
community/games/*/*/*/* @attp @aasfaw @quantumjim @rraymondhp
49-
50-
community/hello_world/* @quantumjim @aasfaw
51-
community/hello_world/*/* @quantumjim @aasfaw
52-
53-
community/ignis/* @dcmckayibm @yehuda-naveh @attp @aasfaw @quantumjim @rraymondhp
54-
55-
community/terra/* @nonhermitian @attp @aasfaw @quantumjim @rraymondhp
56-
community/terra/*/* @nonhermitian @attp @aasfaw @quantumjim @rraymondhp

INSTALL.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,21 @@
99

1010
**Get the tutorials**<BR>
1111

12-
For the full experience, you can start by downloading the latest release of the tutorials from [here](https://github.com/Qiskit/qiskit-tutorials/releases). Unzip the archive in the directory of your choice (this is the recommend way).
12+
For the full experience, you can start by downloading the latest release of the tutorials from [here](https://github.com/Qiskit/qiskit-tutorials/releases). Unzip the archive in the directory of your choice (this is the recommended way).
1313

1414
To properly view and run the tutorials, you will need to install [Jupyter Notebook](https://jupyter.readthedocs.io/en/latest/install.html).
1515

1616
## 2. Install Qiskit, Qiskit Aqua and Qiskit Aqua Chemistry
1717

1818
At least [Python 3.5 or later](https://www.python.org/downloads/) is required to install and use Qiskit. If you have multiple Python versions installed (and particularly if the command `python --version` returns an incompatble version), you will need to ensure that your versions are [managed correctly](https://conda.io/docs/user-guide/tasks/manage-python.html). This can be done using the `environment.yml` file, as detailed below.
1919

20-
When there are no issues with dependencies, Qiskit can be simply installed using
20+
When there are no issues with dependencies, Qiskit can be installed using
2121

2222
```
2323
pip install qiskit
2424
```
2525

26-
Or, pre-installed qiskit can be updated using
26+
Or, pre-installed Qiskit can be updated using
2727

2828
```
2929
pip install -U qiskit
@@ -47,7 +47,7 @@ conda env update -f environment.yml
4747
```
4848

4949

50-
## 3. Configure your IBMQ provider
50+
## 3. Configure your IBM Q Provider
5151

5252
- Create an [IBM Q](https://quantumexperience.ng.bluemix.net) account if
5353
you haven't already done so
@@ -71,7 +71,7 @@ conda env update -f environment.yml
7171
IBMQ.load_accounts()
7272
```
7373

74-
- For those who do not want to save their credentials to disk please use
74+
- For those who do not want to save their credentials to disk, please use
7575

7676
```python
7777
from qiskit import IBMQ
@@ -82,7 +82,7 @@ conda env update -f environment.yml
8282
and the token will only be active for the session.
8383

8484

85-
## 4. Explore the tutorials
85+
## 4. Explore the Tutorials
8686

8787
**Activate the environment**<BR>
8888
For MacOS and Linux, run:
@@ -97,7 +97,7 @@ For Windows, run:
9797
activate Qiskitenv
9898
```
9999
**Note for conda users**<BR>
100-
You need to be sure that you have installed the right Jupyter Kernel, because in the last conda version it's not installed by default.
100+
Verify that you have installed the right Jupyter Kernel, because in the last conda version it's not installed by default.
101101

102102
```
103103
python -m ipykernel install --user --name Qiskitenv --display-name "Python (Qiskitenv)"
@@ -109,8 +109,8 @@ python -m ipykernel install --user --name Qiskitenv --display-name "Python (Qisk
109109
jupyter notebook index.ipynb
110110
```
111111

112-
## 5. [Optional] Visualizing Circuits with Latex
113-
You can visualize your quantum circuits directly from Qiskit. Qiskit circuit drawers support Text, Latex and matplotlib. The text and matplotlib version is entirely native to Python, and thus easy to use. The Latex version produces publication-quality circuit images, but relies on some pre-requisite software. These include the `pdflatex` compiler for rendering latex documents, and the Poppler library for converting PDF to image. To get these:
112+
## 5. [Optional] Visualizing Circuits with LaTeX
113+
You can visualize your quantum circuits directly from Qiskit. Qiskit circuit drawers support text, LaTeX and matplotlib. The text and matplotlib version is entirely native to Python, and thus easy to use. The LaTeX version produces publication-quality circuit images, but relies on some pre-requisite software. These include the `pdflatex` compiler for rendering LaTeX documents, and the Poppler library for converting PDF to image. To get these:
114114

115115
On Linux:
116116

README.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,20 @@
44

55
Welcome to the [Qiskit](https://www.qiskit.org/) tutorials!
66

7-
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 Q](https://quantumexperience.ng.bluemix.net/qx/devices) devices.
7+
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 Q](https://quantum-computing.ibm.com) devices.
8+
9+
For our community-contributed tutorials, please check out the [qiskit-community-tutorials](https://github.com/Qiskit/qiskit-tutorials-community) repository.
810

911
## Installation
1012

11-
The notebooks for these tutorials can be viewed here on GitHub. But for the full experience, you'll want to interact with them!
13+
The notebooks for these tutorials can be viewed here on GitHub...but for the full experience, you'll want to interact with them!
1214

13-
The easiest way to do this is using [the Binder image](https://mybinder.org/v2/gh/qiskit/qiskit-tutorials/master?filepath=./qiskit/start_here.ipynb), which lets you use the notebooks via the web. This means that you don't need to download or install anything, but it also means that you should not insert any private information into the notebooks (such as your API key). We recommend as pointed out in [issue #231](https://github.com/Qiskit/qiskit-tutorials/issues/231) that after you are done using mybinder that you regenerate your token.
15+
The easiest way to do this is using [the Binder image](https://mybinder.org/v2/gh/qiskit/qiskit-tutorials/master?filepath=./qiskit/start_here.ipynb), which lets you use the notebooks via the web. This means that you don't need to download or install anything, but it also means that you should not insert any private information into the notebooks (such as your API key). We recommend, as pointed out in [issue #231](https://github.com/Qiskit/qiskit-tutorials/issues/231), that after you are done using mybinder that you regenerate your token.
1416

1517
Please refer to this [installation guide](INSTALL.md) for setting up Qiskit and the tutorials on your own machine (this is the recommended way).
1618

1719
## Contents
1820

19-
We have organized the tutorials into two sections:
20-
21-
### 1. [Qiskit notebooks](qiskit/)<a id='qiskit'></a>
22-
2321
We've collected a core reference set of notebooks in this section outlining the features of Qiskit. We will be keeping them up to date with the latest Qiskit version.
2422
- [Basics](qiskit/basics) is meant for those who are getting started.
2523
- [Terra](qiskit/terra) is meant for those who want to study circuits.
@@ -28,27 +26,14 @@ We've collected a core reference set of notebooks in this section outlining the
2826
- [Aqua](qiskit/aqua) is meant for those who want to develop applications on NISQ computers.
2927
- [Jupyter](qiskit/jupyter) is meant to highlight some cool Juypter features.
3028

31-
To go through the official qiskit examples load up the [start_here.ipynb](qiskit/start_here.ipynb) notebook and start seeing how qiskit works.
32-
33-
### 2. [Community notebooks](community/)<a id='community'></a>
34-
35-
Teaching quantum computing and qiskit has many different paths of learning. We love our community, and we love the contributions so keep them coming. Because Qiskit is changing so much, at the moment we cant keep this updated, but there are some great notebooks in here. See:
36-
- [Hello, Quantum World](community/hello_world/) learn from the community how to write your first quantum program.
37-
- [Quantum Games](community/games/), learn quantum computing by having fun.
38-
- [Quantum Information Science with Terra](community/terra/), learn about quantum information science with Qiskit Terra.
39-
- [Investigate Quantum Noise with Ignis](community/ignis/), learn about quantum noise with Qiskit Ignis.
40-
- [Textbook Quantum Algorithms](community/algorithms/), learn Qiskit from the textbook algorithms.
41-
- [Quantum Algorithms](community/aqua/), learn about quantum algorithms for noisy near-term devices with Qiskit Aqua.
42-
- [IBM Q Awards](community/awards/), learn from the great contributions to the [IBM Q Awards](https://qe-awards.mybluemix.net/), [Teach Me Qiskit 2018](community/awards/teach_me_qiskit_2018/index.ipynb) and [Teach Me Quantum 2018](community/awards/teach_me_quantum_2018/index.ipynb).
43-
44-
To go through the community driven tutorials, load up the [index.ipynb](community/index.ipynb) notebook and start learning.
29+
To go through the Qiskit examples, load up the [start_here.ipynb](qiskit/start_here.ipynb) notebook and start seeing how Qiskit works.
4530

4631
## Contribution Guidelines
4732

4833
If you'd like to contribute to Qiskit Tutorials, please take a look at our
4934
[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.
5035

51-
We use [GitHub issues](https://github.com/Qiskit/qiskit-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 [link](https://join.slack.com/t/qiskit/shared_invite/enQtNDc2NjUzMjE4Mzc0LTMwZmE0YTM4ZThiNGJmODkzN2Y2NTNlMDIwYWNjYzA2ZmM1YTRlZGQ3OGM0NjcwMjZkZGE0MTA4MGQ1ZTVmYzk). 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).
36+
We use [GitHub issues](https://github.com/Qiskit/qiskit-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 [link](https://join.slack.com/t/qiskit/shared_invite/enQtNDc2NjUzMjE4Mzc0LTMwZmE0YTM4ZThiNGJmODkzN2Y2NTNlMDIwYWNjYzA2ZmM1YTRlZGQ3OGM0NjcwMjZkZGE0MTA4MGQ1ZTVmYzk). 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).
5237

5338
## Authors and Citation
5439

community/algorithms/README.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)