qiskit-documentation/docs/api/qiskit/0.31/tools_jupyter.mdx

114 lines
3.5 KiB
Plaintext

---
title: jupyter (v0.31)
description: API reference for qiskit.tools.jupyter in qiskit v0.31
in_page_toc_min_heading_level: 2
python_api_type: module
python_api_name: qiskit.tools.jupyter
---
<span id="module-qiskit.tools.jupyter" />
<span id="qiskit-tools-jupyter" />
<span id="jupyter-tools-qiskit-tools-jupyter" />
# Jupyter Tools
`qiskit.tools.jupyter`
A Collection of Jupyter magic functions and tools that extend the functionality of Qiskit.
## Overview of all available backends
```python
from qiskit import IBMQ
import qiskit.tools.jupyter
%matplotlib inline
IBMQ.load_account()
%qiskit_backend_overview
```
## Detailed information on a single backend
```python
from qiskit import IBMQ
import qiskit.tools.jupyter
%matplotlib inline
IBMQ.load_account()
provider = IBMQ.get_provider(hub='ibm-q')
backend = provider.get_backend('ibmq_vigo')
backend
```
## Load Qiskit Job Watcher
```python
import qiskit.tools.jupyter
%qiskit_job_watcher
```
## HTMLProgressBar
```python
import numpy as np
from qiskit.tools.parallel import parallel_map
import qiskit.tools.jupyter
%qiskit_progress_bar
parallel_map(np.sin, np.linspace(0,10,100));
```
## Qiskit version table
```python
import qiskit.tools.jupyter
%qiskit_version_table
```
### Version Information
| Qiskit Software | Version |
| ---------------------------- | ----------------------------------------------------- |
| `qiskit-terra` | 0.18.3 |
| `qiskit-aer` | 0.9.1 |
| `qiskit-ignis` | 0.6.0 |
| `qiskit-ibmq-provider` | 0.17.0 |
| `qiskit-aqua` | 0.9.5 |
| `qiskit` | 0.31.0 |
| `qiskit-nature` | 0.2.2 |
| `qiskit-finance` | 0.3.0 |
| `qiskit-optimization` | 0.2.3 |
| `qiskit-machine-learning` | 0.2.1 |
| System information | |
| Python | 3.7.12 (default, Nov 22 2021, 14:57:10) \[GCC 11.1.0] |
| OS | Linux |
| CPUs | 32 |
| Memory (Gb) | 125.71650314331055 |
| Wed Jan 05 16:36:28 2022 EST | |
## Qiskit copyright
```python
import qiskit.tools.jupyter
%qiskit_copyright
```
### This code is a part of Qiskit
© Copyright IBM 2017, 2022.
This code is licensed under the Apache License, Version 2.0. You mayobtain a copy of this license in the LICENSE.txt file in the root directoryof this source tree or at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).
Any modifications or derivative works of this code must retain thiscopyright notice, and modified files need to carry a notice indicatingthat they have been altered from the originals.
## Monospaced output
```python
import qiskit.tools.jupyter
%monospaced_output
```