uniqc.visualization.circuit_render package

Submodules

• uniqc.visualization.circuit_render.html module
  • render_html()
• uniqc.visualization.circuit_render.labels module
  • classify()
  • cop_label()
  • display_name()
  • fmt_num()
  • label_lines()
  • param_strings()
  • to_pi()
  • tooltip()
• uniqc.visualization.circuit_render.latex module
  • render_latex()
• uniqc.visualization.circuit_render.layout module
  • FlowSpan
    • FlowSpan.col_begin
    • FlowSpan.col_end
    • FlowSpan.cond
    • FlowSpan.kind
  • Layout
    • Layout.bands
    • Layout.col_widths
    • Layout.n_cols
    • Layout.ops
    • Layout.spans
  • estimate_text_width()
  • layout_circuit()
  • resolve_fold()
• uniqc.visualization.circuit_render.model module
  • DrawCircuit
    • DrawCircuit.n_cbits
    • DrawCircuit.n_qubits
    • DrawCircuit.ops
    • DrawCircuit.params
  • DrawOp
    • DrawOp.addr
    • DrawOp.cbits
    • DrawOp.col
    • DrawOp.cond
    • DrawOp.controls
    • DrawOp.dagger
    • DrawOp.data
    • DrawOp.index
    • DrawOp.name
    • DrawOp.note
    • DrawOp.op
    • DrawOp.params
    • DrawOp.qubits
    • DrawOp.raw
  • GREEK_SYMBOL_NAMES
  • display_param()
  • display_param_ascii()
  • to_draw_circuit()
• uniqc.visualization.circuit_render.mpl module
  • render_mpl()
  • render_png_bytes()
• uniqc.visualization.circuit_render.options module
  • RenderOptions
    • RenderOptions.charset
    • RenderOptions.fold
    • RenderOptions.mode
    • RenderOptions.orientation
    • RenderOptions.param_mode
    • RenderOptions.qubit_order
    • RenderOptions.scale
    • RenderOptions.show_clbits
    • RenderOptions.style
    • RenderOptions.theme
    • RenderOptions.vertical
• uniqc.visualization.circuit_render.styles module
  • Look
    • Look.fill
    • Look.ink
    • Look.stroke
  • Style
    • Style.box_h
    • Style.ctrl_r
    • Style.font
    • Style.fs
    • Style.key
    • Style.look()
    • Style.min_col
    • Style.pad
    • Style.palette
    • Style.palette_dark
    • Style.pfs
    • Style.rx
    • Style.sw
    • Style.targ_r
    • Style.theme()
    • Style.themes
    • Style.wire_gap
    • Style.wire_w
  • Theme
    • Theme.bg
    • Theme.bracket
    • Theme.clane
    • Theme.dim
    • Theme.hint
    • Theme.ink
    • Theme.wire
  • get_style()
• uniqc.visualization.circuit_render.svg module
  • RenderMeta
  • build_primitives()
  • render_svg()
  • serialize_svg()
• uniqc.visualization.circuit_render.text module
  • render_text()

Module contents

Circuit rendering: one entry point, seven output modes.

render() / uniqc.circuit_builder.Circuit.draw() are thin, equivalent wrappers around the same core (per the design-review decision).

Modes: text (self-developed ASCII/Unicode art — no pyqpanda3 needed), svg, png, mpl, latex (quantikz source), html (static, self-contained), interactive (HTML + click-to-inspect).

The core modes (text/svg/latex/html/interactive) are pure-stdlib. png prefers cairosvg and falls back to matplotlib; mpl requires matplotlib.

class uniqc.visualization.circuit_render.TextDrawing

Bases: str

str subclass whose REPL display is the drawing itself (qiskit-style).

uniqc.visualization.circuit_render.render(circuit, mode=None, *, style='quantikz', fold='auto', orientation='h', qubit_order='asc', theme='light', param_mode='pi', show_clbits=False, charset='ascii', scale=100, filename=None)

Render a quantum circuit.

Parameters:

• circuit – A Circuit, an OriginIR(-ext) or OpenQASM 2.0 string, or a JSON list of gate dicts.

• mode – None (smart default: terminal→``text``, Jupyter→``svg``), or one of text/svg/png/mpl/latex/html/interactive.

• style – quantikz (default) | qiskit | modern | print.

• fold – gates per row — "auto" (terminal width for text, 16 otherwise), an int, or 0 to disable folding.

• orientation – "h" (time→) or "v" (time↓, graphical modes only).

• qubit_order – "asc" (q0 on top, default) or "desc".

• theme – "light" | "dark".

• param_mode – "pi" (π-fractions, default) | "decimal" | "symbol" | "hidden".

• show_clbits – draw classical double-line wires (default False).

• charset – "ascii" (default) | "unicode" for text mode.

• scale – percent scaling for graphical modes.

• filename – when given, also write the output to this path.

Returns:

text/svg/latex/html/interactive → str (text returns a TextDrawing whose repr is the art); png → bytes; mpl → matplotlib.figure.Figure.