Branch: master
Find file Copy path
138 lines (90 sloc) 4.3 KB

Guide for Installation and Setup

1. Download the Qiskit Tutorials

Get the tutorials

For the full experience, you can start by downloading the latest release of the tutorials from here. Unzip the archive in the directory of your choice (this is the recommend way).

To properly view and run the tutorials, you will need to install Jupyter Notebook.

2. Install Qiskit, Qiskit Aqua and Qiskit Aqua Chemistry

At least Python 3.5 or later 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. This can be done using the environment.yml file, as detailed below.

When there are no issues with dependencies, Qiskit can be simply installed using

pip install qiskit qiskit-aqua qiskit-chemistry

Or, pre-installed qiskit can be updated using

pip install -U qiskit qiskit-aqua qiskit-chemistry

However, in case of issues with dependencies, we recommend the following installation procedure:

  1. Install conda

  2. Create conda environment for Qiskit and install packages (with the accompanying environment.yml file)

cd qiskit-tutorial
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 IBMQ provider

  • Create an IBM Q account if you haven't already done so
  • Get an API token from the IBM Q website under “My Account” > “Advanced”
  • 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:
    from qiskit import IBMQ

  • Your credentials will be stored on disk. Once they are stored, at any point in the future you can load and use them via:
    from qiskit import IBMQ

  • For those who do not want to save their credentials to disk please use
    from qiskit import IBMQ


and the token will only be active for the session.

4. Explore the tutorials

Activate the environment
For MacOS and Linux, run:

source activate Qiskitenv

For Windows, run:

activate Qiskitenv

Note for conda users
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.

python -m ipykernel install --user --name Qiskitenv --display-name "Python (Qiskitenv)"

Start Jupyter with the index notebook

jupyter notebook index.ipynb

5. [Optional] Visualizing Circuits with Latex

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:

On Linux:

  • Install MiKTeX
  • Install Poppler:
    • Run: apt-get install -y poppler-utils

On MacOS:

  • Install MiKTeX.
  • Install Poppler:
    • Run:brew install poppler

On Windows:

  • Install MiKTeX.
  • Install Poppler:
    • Download the latest binary.
    • Extract the downloaded .7z file into user directory: c:\Users\<user_name>\. Note: You will need to have the 7zip software for this.
    • Add to PATH:
      • Right click on "This PC" -> Properties -> Advanced System Settings -> Environment Variables
      • Add C:\Users\<user_name>\poppler-0.51\bin to the user's path.