60 lines
2.7 KiB
Plaintext
60 lines
2.7 KiB
Plaintext
---
|
||
title: plot_coupling_map
|
||
description: API reference for qiskit.visualization.plot_coupling_map
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: function
|
||
python_api_name: qiskit.visualization.plot_coupling_map
|
||
---
|
||
|
||
# qiskit.visualization.plot\_coupling\_map
|
||
|
||
<Function id="qiskit.visualization.plot_coupling_map" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/visualization/gate_map.py" signature="plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)">
|
||
Plots an arbitrary coupling map of qubits (embedded in a plane).
|
||
|
||
**Parameters**
|
||
|
||
* **num\_qubits** (*int*) – The number of qubits defined and plotted.
|
||
* **qubit\_coordinates** (*List\[List\[int]]*) – A list of two-element lists, with entries of each nested list being the planar coordinates in a 0-based square grid where each qubit is located.
|
||
* **coupling\_map** (*List\[List\[int]]*) – A list of two-element lists, with entries of each nested list being the qubit numbers of the bonds to be plotted.
|
||
* **figsize** (*tuple*) – Output figure size (wxh) in inches.
|
||
* **plot\_directed** (*bool*) – Plot directed coupling map.
|
||
* **label\_qubits** (*bool*) – Label the qubits.
|
||
* **qubit\_size** (*float*) – Size of qubit marker.
|
||
* **line\_width** (*float*) – Width of lines.
|
||
* **font\_size** (*int*) – Font size of qubit labels.
|
||
* **qubit\_color** (*list*) – A list of colors for the qubits
|
||
* **qubit\_labels** (*list*) – A list of qubit labels
|
||
* **line\_color** (*list*) – A list of colors for each line from coupling\_map.
|
||
* **font\_color** (*str*) – The font color for the qubit labels.
|
||
* **ax** (*Axes*) – A Matplotlib axes instance.
|
||
* **filename** (*str*) – file path to save image to.
|
||
|
||
**Returns**
|
||
|
||
A Matplotlib figure instance.
|
||
|
||
**Return type**
|
||
|
||
Figure
|
||
|
||
**Raises**
|
||
|
||
* **MissingOptionalLibraryError** – if matplotlib not installed.
|
||
* **QiskitError** – If length of qubit labels does not match number of qubits.
|
||
|
||
**Example**
|
||
|
||
```python
|
||
from qiskit.visualization import plot_coupling_map
|
||
%matplotlib inline
|
||
|
||
num_qubits = 8
|
||
qubit_coordinates = [[0, 1], [1, 1], [1, 0], [1, 2], [2, 0], [2, 2], [2, 1], [3, 1]]
|
||
coupling_map = [[0, 1], [1, 2], [2, 3], [3, 5], [4, 5], [5, 6], [2, 4], [6, 7]]
|
||
plot_coupling_map(num_qubits, qubit_coordinates, coupling_map)
|
||
```
|
||
|
||
|
||
</Function>
|
||
|