You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 21, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: INSTALL.md
+39-22Lines changed: 39 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,34 +9,45 @@
9
9
10
10
**Get the tutorials**<BR>
11
11
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).
12
+
For the full experience, you can start by downloading the latest release of the
13
+
tutorials from [here](https://github.com/Qiskit/qiskit-iqx-tutorials/releases).
14
+
Unzip the archive in the directory of your choice (this is the recommended
15
+
way).
13
16
14
-
To properly view and run the tutorials, you will need to install [Jupyter Notebook](https://jupyter.readthedocs.io/en/latest/install.html).
17
+
To properly view and run the tutorials, you will need to install [Jupyter
## 2. Install Qiskit, Qiskit Aqua and Qiskit Aqua Chemistry
17
21
18
-
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/projects/conda/en/latest/user-guide/getting-started.html#managing-python). This can be done using the `environment.yml` file, as detailed below.
22
+
At least [Python 3.5 or later](https://www.python.org/downloads/) is required
23
+
to install and use Qiskit. If you have multiple Python versions installed (and
24
+
particularly if the command `python --version` returns an incompatible
25
+
version), you will need to ensure that your versions are [managed
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:
126
+
You can visualize your quantum circuits directly from Qiskit. Qiskit circuit
127
+
drawers support text, LaTeX and matplotlib. The text and matplotlib version is
128
+
entirely native to Python, and thus easy to use. The LaTeX version produces
129
+
publication-quality circuit images, but relies on some pre-requisite software.
130
+
These include the `pdflatex` compiler for rendering LaTeX documents, and the
131
+
Poppler library for converting PDF to image. To get these:
Welcome to the [Qiskit](https://www.qiskit.org/)tutorials!
5
+
Welcome to the [Qiskit](https://www.qiskit.org/)IQX Tutorials!
6
6
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.
7
+
In this repository, we've put together a collection of Jupyter notebooks aimed
8
+
at teaching people who want to use Qiskit for writing quantum computing
9
+
programs, and executing them on one of several backends (online quantum
10
+
processors, online simulators, and local simulators). The online quantum
11
+
processors are the [IBM Q](https://quantum-computing.ibm.com) devices.
8
12
9
-
For our community-contributed tutorials, please check out the [qiskit-community-tutorials](https://github.com/Qiskit/qiskit-tutorials-community) repository.
13
+
For our community-contributed tutorials, please check out the
The notebooks for these tutorials can be viewed here on GitHub...but for the full experience, you'll want to interact with them!
19
+
The notebooks for these tutorials can be viewed here on GitHub...but for the
20
+
full experience, you'll want to interact with them! The easiest way to do this
21
+
is by logging into the [IBM Quantum
22
+
Experience](https://quantum-computing.ibm.com/), which lets you use Jupyter
23
+
notebooks, including these tutorials, via the web.
14
24
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.
16
-
17
-
Please refer to this [installation guide](INSTALL.md) for setting up Qiskit and the tutorials on your own machine (this is the recommended way).
25
+
Please refer to this [installation guide](INSTALL.md) for setting up Qiskit and
26
+
the tutorials on your own machine (this is the recommended way).
18
27
19
28
## Contents
20
29
21
-
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.
22
-
-[Basics](qiskit/fundamentals) is meant for those who are getting started.
23
-
-[Terra](qiskit/advanced/terra) is meant for those who want to study circuits.
24
-
-[Aer](qiskit/advanced/aer) is meant for those who want to simulate quantum circuits.
25
-
-[Ignis](qiskit/advanced/ignis) is meant for those who want to study noise.
26
-
-[Aqua](qiskit/advanced/aqua) is meant for those who want to develop applications on NISQ computers.
30
+
We've collected a core reference set of notebooks in this section outlining the
31
+
features of Qiskit. We will be keeping them up to date with the latest Qiskit
32
+
version.
33
+
34
+
-[Basics](qiskit/fundamentals) is for those who are getting started.
35
+
-[Terra](qiskit/advanced/terra) is for those who want to study circuits.
36
+
-[Aer](qiskit/advanced/aer) is for those who want to simulate quantum circuits.
37
+
-[Ignis](qiskit/advanced/ignis) is for those who want to study noise.
38
+
-[Aqua](qiskit/advanced/aqua) is for those who want to develop applications on NISQ computers.
27
39
28
-
To go through the Qiskit examples, load up the [start_here.ipynb](qiskit/1_start_here.ipynb) notebook and start seeing how Qiskit works.
40
+
To go through the Qiskit examples, load up the
41
+
[start_here.ipynb](qiskit/1_start_here.ipynb) notebook and start seeing how
42
+
Qiskit works.
29
43
30
44
## Contribution Guidelines
31
45
32
-
If you'd like to contribute to Qiskit Tutorials, please take a look at our
33
-
[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.
46
+
If you'd like to contribute to Qiskit IQX Tutorials, please take a look at our
47
+
[contribution guidelines](.github/CONTRIBUTING.md). This project adheres to
48
+
Qiskit's [code of conduct](.github/CODE_OF_CONDUCT.md). By participating, you
49
+
are expect to uphold to this code.
34
50
35
-
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).
51
+
We use [GitHub issues](https://github.com/Qiskit/qiskit-iqx-tutorials/issues) for
52
+
tracking requests and bugs. Please use our [Slack](https://qiskit.slack.com)
53
+
for discussion and simple questions. To join our Slack community, use the
Qiskit Tutorials is the work of [many people](https://github.com/Qiskit/qiskit-tutorials/graphs/contributors) who contribute
40
-
to the project at different levels. If you use Qiskit, please cite as per the included [BibTeX file](https://github.com/Qiskit/qiskit/blob/master/Qiskit.bib).
61
+
Qiskit IQX Tutorials is the work of [many
62
+
people](https://github.com/Qiskit/qiskit-iqx-tutorials/graphs/contributors) who
63
+
contribute to the project at different levels. If you use Qiskit, please cite
0 commit comments