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

Commit

Permalink
Installation (#301)
Browse files Browse the repository at this point in the history
* Fixes #231

* Making install clearer

* Updated the note about latex installation

* minor typo
  • Loading branch information
jaygambetta authored Oct 7, 2018
1 parent df3a3c1 commit 18ad9c5
Showing 1 changed file with 24 additions and 5 deletions.
29 changes: 24 additions & 5 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,37 @@ conda env update -f environment.yml

## 3. Configure your IBMQ provider

- Create an `IBM Q <https://quantumexperience.ng.bluemix.net>`__ account if
- 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” > “Advanced”
- The API token can be used by
- 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

IBMQ.load_accounts()
```

- For those who do not want to save their credentials to disk please use

```python
from qiskit import IBMQ

IBMQ.enable_account('MY_API_TOKEN')
```

and the token will only be active for the session.


## 4. Explore the tutorials
Expand All @@ -84,7 +103,7 @@ For Windows, run:
```
activate Qiskitenv
```
**Note for conda users**<BR>t
**Note for conda users**<BR>
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.

```
Expand All @@ -97,8 +116,8 @@ python -m ipykernel install --user --name Qiskitenv --display-name "Python (Qisk
jupyter notebook index.ipynb
```

## 5. Visualizing Circuits
You can visualize your quantum circuits directly from Qiskit. To get publication-quality images, Qiskit plots circuits using LaTeX, which means you will need to install some pre-requisite software. These include the `pdflatex` compiler for rendering latex documents, and the Poppler library for converting PDF to image. In the future, we will provide ways of plotting circuits without relying on Latex.
## 5. Visualizing Circuits with Latex
You can visualize your quantum circuits directly from Qiskit. Qiskit circuit drawers are based on matplotlib and latex. The 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:

Expand Down

0 comments on commit 18ad9c5

Please sign in to comment.