quantum-circuit-drawer 0.3.0

Backend-agnostic quantum circuit drawing library with Matplotlib as the first renderer.

quantum-circuit-drawer

quantum-circuit-drawer draws quantum circuits from several ecosystems with one Matplotlib-based API.

The public API is now centered on two objects:

• DrawConfig: one ordered configuration object for view, mode, saving, style, and hover
• DrawResult: one consistent return object for managed figures, caller-owned axes, 2D, and 3D

Install

Inside your virtual environment:

python -m pip install quantum-circuit-drawer

For framework extras:

python -m pip install "quantum-circuit-drawer[qiskit]"
python -m pip install "quantum-circuit-drawer[cirq]"
python -m pip install "quantum-circuit-drawer[pennylane]"
python -m pip install "quantum-circuit-drawer[myqlm]"

Basic usage

from qiskit import QuantumCircuit

from quantum_circuit_drawer import DrawConfig, draw_quantum_circuit

circuit = QuantumCircuit(2, 1)
circuit.h(0)
circuit.cx(0, 1)
circuit.measure(1, 0)

result = draw_quantum_circuit(
    circuit,
    config=DrawConfig(show=False),
)

figure = result.primary_figure
axes = result.primary_axes

Modes

from quantum_circuit_drawer import DrawConfig, DrawMode, draw_quantum_circuit

result = draw_quantum_circuit(
    circuit,
    config=DrawConfig(mode=DrawMode.PAGES_CONTROLS, show=True),
)

Available modes:

• DrawMode.AUTO: notebooks default to pages; normal .py runs default to pages_controls
• DrawMode.PAGES: one figure per page when the library owns the figure
• DrawMode.PAGES_CONTROLS: managed Page / Visible controls
• DrawMode.SLIDER: discrete slider navigation
• DrawMode.FULL: full unpaged scene

Notes:

• In 2D, pages with ax=... renders the static paged composition into that axes.
• In 3D, pages, pages_controls, slider, and full are all supported.
• Interactive modes require a library-managed figure, so do not combine them with ax=....

3D example

from quantum_circuit_drawer import DrawConfig, DrawMode, draw_quantum_circuit

result = draw_quantum_circuit(
    circuit,
    config=DrawConfig(
        view="3d",
        mode=DrawMode.PAGES_CONTROLS,
        topology="grid",
        topology_menu=True,
        show=False,
    ),
)

Saving

draw_quantum_circuit(
    circuit,
    config=DrawConfig(
        mode=DrawMode.SLIDER,
        output_path="circuit.png",
        show=False,
    ),
)

Interactive modes save a clean figure without widgets. Paged modes save the concatenated paged composition. full saves the full unpaged view.

Styling

from quantum_circuit_drawer import DrawConfig, draw_quantum_circuit

result = draw_quantum_circuit(
    circuit,
    config=DrawConfig(
        style={
            "theme": "paper",
            "max_page_width": 10.0,
            "wire_line_width": 1.8,
            "measurement_line_width": 1.4,
            "connection_line_width": 1.9,
        },
        hover={"enabled": True, "show_size": True},
        show=False,
    ),
)

DrawTheme now also covers the managed UI colors, hover colors, control colors, control-connection colors, and topology colors.

Documentation

• API reference
• User guide
• Recipes
• Examples
• Changelog