pyqcircuit 0.2.0

No project description provided

pyqcircuit

A tiny pure‑Python helper for drawing quantum‑circuit diagrams with Matplotlib.

---

Why?

Most open‑source quantum SDKs bundle heavyweight drawing stacks or require you to adopt their full IR just to get a circuit picture. pyqcircuit keeps things… well, simple: with zero dependencies beyond Matplotlib.

---

Installation

pip install pyqcircuit             # if you don’t already have it

---

Quick demo

from pyqcircuit import QuantumCircuit

qc = QuantumCircuit(3)
qc.h(0)
qc.x(2, step=1)  # share column 1
qc.custom([0, 2], "Foo")  # tall box spanning q0–q2
qc.cx(0, 1, step=3)

qc.draw()

---

Features

Category	Highlights
Lightweight	No quantum SDKs; pure Python 3.
Gate set	H, X/Y/Z, S, T, ½‑rotations (X90 etc.), arbitrary R_x/y/z(θ), CNOT, CZ, SWAP, measurement.
Custom gates	qc.custom(qubits, "LABEL") draws one‑ or multi‑qubit labelled boxes.
Flexible layout	Explicit step= pinning or automatic sequential placement.

---

API primer

Call	Effect
qc.h(0)	One‑qubit Hadamard in next free column.
qc.x(1, step=2)	X gate pinned to column 2.
qc.cx(0,1)	CNOT; control on q0, target on q1.
qc.custom([0,2], "U")	One tall box spanning q0…q2.
qc.measure([0,1])	Standard meter symbol on listed qubits.

---

Development

To refresh the baseline images used in tests, run:

# create / refresh baseline images
env GENERATE=1 pytest -q tests/test_draw_baselines.py

# run the full test suite
pytest

For Windows users, you will need to set the GENERATE environment variable to 1 before running the first command, e.g.:

set GENERATE=1
pytest -q tests/test_draw_baselines.py
set GENERATE=0
pytest

or using PowerShell:

$env:GENERATE = "1"
pytest -q tests/test_draw_baselines.py
$env:GENERATE = "0"
pytest