# Contributing
## What makes a good tutorial?
## Adding a tutorial
## Setting gallery thumbnails
To set the gallery thumbnail for a given tutorial (as seen in the image above) one needs to set a cell tag in the notebook for a cell that generates an image as its output. To make the tabs visible do:
The cell's whos output you would like to use, you must add the tag: `nbsphinx-thumbnail`.
If a tag is not set, then the Qiskit logo is used as a placeholder.
================================================
FILE: INSTALL.md
================================================
# Qiskit Tutorials
## Installation and setup
### Get the tutorials
For the full experience, you can start by downloading the latest release of the
tutorials from [here](https://github.com/Qiskit/qiskit-iqx-tutorials/releases).
Unzip the archive in the directory of your choice (this is the recommended
way).
To properly view and run the tutorials, you will need to install [Jupyter
Notebook](https://jupyter.readthedocs.io/en/latest/install.html).
### Install Qiskit
At least [Python 3.7 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 incompatible
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.
When there are no issues with dependencies, Qiskit can be installed using
```
pip install qiskit
```
Or, a pre-installed Qiskit can be updated using
```
pip install -U qiskit
```
However, in case of issues with dependencies, we recommend the following
installation procedure:
1. **Install [conda](https://conda.io/docs/index.html)**
2. **Create conda environment for Qiskit and install packages** (with the
accompanying `environment.yml` file)
```
cd qiskit-tutorials
conda env create -f environment.yml
```
If you have already created `environment`, you can upgrade it by running
```
conda env update -f environment.yml
```
## 3. Configure your IBM Q Provider
- Create an [IBM Q](https://quantumexperience.ng.bluemix.net) account if
you haven't already done so
- Get an API token from the IBM Q website under “My Account" > "Qiskit in
local environment"
- We are now going to add the necessary credentials to Qiskit. Take your
token, here called `MY_API_TOKEN`, and pass it to the `IBMQ.save_account()`
function:
```python
from qiskit import IBMQ
IBMQ.save_account('MY_API_TOKEN')
```
- Your credentials will be stored on disk. Once they are stored, at any point
in the future you can load and use them via:
```python
from qiskit import IBMQ
provider = IBMQ.load_account()
```
- For those who do not want to save their credentials to disk, please use
```python
from qiskit import IBMQ
provider = IBMQ.enable_account('MY_API_TOKEN')
```
and the token will only be active for the session.
## 4. Explore the Tutorials
**Activate the environment**© Copyright IBM 2017, 2021.
This code is licensed under the Apache License, Version 2.0. You may
obtain a copy of this license in the LICENSE.txt file in the root directory
of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
Any modifications or derivative works of this code must retain this
copyright notice, and modified files need to carry a notice indicating
that they have been altered from the originals.
| Qiskit Software | Version |
|---|---|
qiskit-terra | 0.23.0.dev0+f52bb33 |
qiskit-aer | 0.11.1 |
qiskit-ignis | 0.7.1 |
qiskit-ibmq-provider | 0.19.2 |
qiskit-nature | 0.5.0 |
qiskit-optimization | 0.5.0 |
qiskit-machine-learning | 0.6.0 |
| System information | |
| Python version | 3.10.4 |
| Python compiler | Clang 12.0.0 |
| Python build | main, Mar 31 2022 03:38:35 |
| OS | Darwin |
| CPUs | 4 |
| Memory (Gb) | 32.0 |
| Wed Dec 07 11:02:26 2022 CET | |
© Copyright IBM 2017, 2022.
This code is licensed under the Apache License, Version 2.0. You may
obtain a copy of this license in the LICENSE.txt file in the root directory
of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
Any modifications or derivative works of this code must retain this
copyright notice, and modified files need to carry a notice indicating
that they have been altered from the originals.
| Qiskit Software | Version |
|---|---|
qiskit-terra | 0.22.2 |
qiskit-aer | 0.11.1 |
qiskit-ignis | 0.7.1 |
qiskit-ibmq-provider | 0.19.2 |
qiskit | 0.39.2 |
| System information | |
| Python version | 3.10.2 |
| Python compiler | Clang 13.0.0 (clang-1300.0.29.30) |
| Python build | v3.10.2:a58ebcc701, Jan 13 2022 14:50:16 |
| OS | Darwin |
| CPUs | 8 |
| Memory (Gb) | 64.0 |
| Fri Nov 18 01:08:34 2022 CET | |
© Copyright IBM 2017, 2022.
This code is licensed under the Apache License, Version 2.0. You may
obtain a copy of this license in the LICENSE.txt file in the root directory
of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
Any modifications or derivative works of this code must retain this
copyright notice, and modified files need to carry a notice indicating
that they have been altered from the originals.
| Qiskit Software | Version |
|---|---|
qiskit-terra | 0.22.2 |
qiskit-aer | 0.11.1 |
qiskit-ignis | 0.7.1 |
qiskit-ibmq-provider | 0.19.2 |
qiskit | 0.39.2 |
| System information | |
| Python version | 3.10.2 |
| Python compiler | Clang 13.0.0 (clang-1300.0.29.30) |
| Python build | v3.10.2:a58ebcc701, Jan 13 2022 14:50:16 |
| OS | Darwin |
| CPUs | 8 |
| Memory (Gb) | 64.0 |
| Fri Nov 18 01:03:00 2022 CET | |
© Copyright IBM 2017, 2022.
This code is licensed under the Apache License, Version 2.0. You may
obtain a copy of this license in the LICENSE.txt file in the root directory
of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
Any modifications or derivative works of this code must retain this
copyright notice, and modified files need to carry a notice indicating
that they have been altered from the originals.
| Qiskit Software | Version |
|---|---|
qiskit-terra | 0.24.1 |
qiskit-aer | 0.12.0 |
qiskit-ibmq-provider | 0.20.2 |
qiskit | 0.43.1 |
| System information | |
| Python version | 3.11.3 |
| Python compiler | Clang 14.0.0 (clang-1400.0.29.202) |
| Python build | main, Apr 7 2023 20:13:31 |
| OS | Darwin |
| CPUs | 10 |
| Memory (Gb) | 32.0 |
| Fri Jun 09 14:52:12 2023 PDT | |
© Copyright IBM 2017, 2023.
This code is licensed under the Apache License, Version 2.0. You may
obtain a copy of this license in the LICENSE.txt file in the root directory
of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
Any modifications or derivative works of this code must retain this
copyright notice, and modified files need to carry a notice indicating
that they have been altered from the originals.
| Qiskit Software | Version |
|---|---|
qiskit-terra | 0.23.0 |
qiskit-aer | 0.11.1 |
qiskit-nature | 0.6.0 |
qiskit-finance | 0.4.0 |
qiskit-optimization | 0.5.0 |
qiskit-machine-learning | 0.6.0 |
| System information | |
| Python version | 3.9.13 |
| Python compiler | Clang 13.0.1 |
| Python build | main, May 27 2022 17:01:00 |
| OS | Darwin |
| CPUs | 2 |
| Memory (Gb) | 12.0 |
| Sun Jan 08 11:35:33 2023 EST | |
© Copyright IBM 2017, 2023.
This code is licensed under the Apache License, Version 2.0. You may
obtain a copy of this license in the LICENSE.txt file in the root directory
of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
Any modifications or derivative works of this code must retain this
copyright notice, and modified files need to carry a notice indicating
that they have been altered from the originals.
| Qiskit Software | Version |
|---|---|
qiskit-terra | 0.23.0.dev0+0f6c75e |
qiskit-aer | 0.11.1 |
qiskit-optimization | 0.5.0 |
| System information | |
| Python version | 3.9.10 |
| Python compiler | Clang 13.1.6 (clang-1316.0.21.2.5) |
| Python build | main, Aug 9 2022 18:26:17 |
| OS | Darwin |
| CPUs | 10 |
| Memory (Gb) | 64.0 |
| Fri Nov 25 21:25:09 2022 JST | |
© Copyright IBM 2017, 2022.
This code is licensed under the Apache License, Version 2.0. You may
obtain a copy of this license in the LICENSE.txt file in the root directory
of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
Any modifications or derivative works of this code must retain this
copyright notice, and modified files need to carry a notice indicating
that they have been altered from the originals.
| Qiskit Software | Version |
|---|---|
qiskit-terra | 0.23.3 |
qiskit-aer | 0.12.0 |
qiskit-ibmq-provider | 0.20.2 |
qiskit | 0.42.1 |
| System information | |
| Python version | 3.10.10 |
| Python compiler | GCC 12.2.1 20230201 |
| Python build | main, Mar 5 2023 22:26:53 |
| OS | Linux |
| CPUs | 32 |
| Memory (Gb) | 125.66083908081055 |
| Thu May 04 15:38:15 2023 EDT | |
© Copyright IBM 2017, 2023.
This code is licensed under the Apache License, Version 2.0. You may
obtain a copy of this license in the LICENSE.txt file in the root directory
of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
Any modifications or derivative works of this code must retain this
copyright notice, and modified files need to carry a notice indicating
that they have been altered from the originals.
| Qiskit Software | Version |
|---|---|
qiskit-terra | 0.23.0.dev0+1b4fed3 |
qiskit-aer | 0.11.1 |
qiskit-nature | 0.5.0 |
| System information | |
| Python version | 3.9.13 |
| Python compiler | Clang 12.0.0 |
| Python build | main, Oct 13 2022 16:12:30 |
| OS | Darwin |
| CPUs | 4 |
| Memory (Gb) | 32.0 |
| Fri Dec 09 16:18:07 2022 CET | |
© Copyright IBM 2017, 2022.
This code is licensed under the Apache License, Version 2.0. You may
obtain a copy of this license in the LICENSE.txt file in the root directory
of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
Any modifications or derivative works of this code must retain this
copyright notice, and modified files need to carry a notice indicating
that they have been altered from the originals.
| Qiskit Software | Version |
|---|---|
qiskit-terra | 0.24.0.dev0+d814ad4 |
qiskit-aer | 0.11.1 |
qiskit-ignis | 0.7.1 |
qiskit-ibmq-provider | 0.19.2 |
qiskit-nature | 0.6.0 |
qiskit-finance | 0.3.4 |
qiskit-optimization | 0.6.0 |
qiskit-machine-learning | 0.6.0 |
| System information | |
| Python version | 3.10.4 |
| Python compiler | Clang 12.0.0 |
| Python build | main, Mar 31 2022 03:38:35 |
| OS | Darwin |
| CPUs | 4 |
| Memory (Gb) | 32.0 |
| Tue May 09 13:16:11 2023 CEST | |
© Copyright IBM 2017, 2023.
This code is licensed under the Apache License, Version 2.0. You may
obtain a copy of this license in the LICENSE.txt file in the root directory
of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
Any modifications or derivative works of this code must retain this
copyright notice, and modified files need to carry a notice indicating
that they have been altered from the originals.
| Qiskit Software | Version |
|---|---|
qiskit-terra | 0.24.1 |
qiskit-aer | 0.12.0 |
qiskit-ibmq-provider | 0.20.2 |
qiskit | 0.43.1 |
| System information | |
| Python version | 3.10.12 |
| Python compiler | GCC 9.4.0 |
| Python build | main, Jun 7 2023 12:45:35 |
| OS | Linux |
| CPUs | 1 |
| Memory (Gb) | 12.678398132324219 |
| Fri Jun 16 00:10:15 2023 UTC | |
© Copyright IBM 2017, 2023.
This code is licensed under the Apache License, Version 2.0. You may
obtain a copy of this license in the LICENSE.txt file in the root directory
of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
Any modifications or derivative works of this code must retain this
copyright notice, and modified files need to carry a notice indicating
that they have been altered from the originals.
qiskit.algorithms.gradients framework | Qiskit Software | Version |
|---|---|
qiskit-terra | 0.24.0 |
qiskit-aer | 0.12.0 |
qiskit-ignis | 0.7.1 |
qiskit-ibmq-provider | 0.20.2 |
qiskit | 0.43.0 |
| System information | |
| Python version | 3.8.10 |
| Python compiler | GCC 9.4.0 |
| Python build | default, Mar 13 2023 10:26:41 |
| OS | Linux |
| CPUs | 4 |
| Memory (Gb) | 3.842151641845703 |
| Tue May 30 19:13:50 2023 UTC | |
© Copyright IBM 2017, 2023.
This code is licensed under the Apache License, Version 2.0. You may
obtain a copy of this license in the LICENSE.txt file in the root directory
of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
Any modifications or derivative works of this code must retain this
copyright notice, and modified files need to carry a notice indicating
that they have been altered from the originals.