53 lines
2.9 KiB
Plaintext
53 lines
2.9 KiB
Plaintext
---
|
||
title: tools
|
||
description: API reference for qiskit.tools
|
||
in_page_toc_min_heading_level: 2
|
||
python_api_type: module
|
||
python_api_name: qiskit.tools
|
||
---
|
||
|
||
<span id="module-qiskit.tools" />
|
||
|
||
<span id="qiskit-tools-qiskit-tools" />
|
||
|
||
# Qiskit Tools
|
||
|
||
<span id="module-qiskit.tools" />
|
||
|
||
`qiskit.tools`
|
||
|
||
## Parallel Routines
|
||
|
||
A helper function for calling a custom function with python `ProcessPoolExecutor`. Tasks can be executed in parallel using this function. It has a built-in event publisher to show the progress of the parallel tasks.
|
||
|
||
| | |
|
||
| --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||
| [`parallel_map`](qiskit.tools.parallel_map "qiskit.tools.parallel_map")(task, values\[, task\_args, ...]) | Parallel execution of a mapping of values to the function task. This is functionally equivalent to::. |
|
||
|
||
## Monitoring
|
||
|
||
A helper module to get IBM backend information and submitted job status.
|
||
|
||
| | |
|
||
| ---------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||
| [`job_monitor`](qiskit.tools.job_monitor "qiskit.tools.job_monitor")(job\[, interval, quiet, output, ...]) | Monitor the status of a IBMQJob instance. |
|
||
| [`backend_monitor`](qiskit.tools.backend_monitor "qiskit.tools.backend_monitor")(backend) | Monitor a single IBMQ backend. |
|
||
| [`backend_overview`](qiskit.tools.backend_overview "qiskit.tools.backend_overview")() | Gives overview information on all the IBMQ backends that are available. |
|
||
|
||
<span id="module-qiskit.tools.events" />
|
||
|
||
<span id="events-qiskit-tools-events" />
|
||
|
||
### Events ([`qiskit.tools.events`](#module-qiskit.tools.events "qiskit.tools.events"))
|
||
|
||
A helper component for publishing and subscribing to events.
|
||
|
||
#### TextProgressBar
|
||
|
||
A text based progress bar, which also enables Jupyter magics.
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------ | --------------------------------- |
|
||
| [`TextProgressBar`](qiskit.tools.events.TextProgressBar "qiskit.tools.events.TextProgressBar")(\[output\_handler]) | A simple text-based progress bar. |
|
||
|