CompositeBloq Graph Drawing

qualtran.drawing includes classes for drawing a CompositeBloq as a directed acyclic graph. This uses the popular package graphviz to render the drawings. The simplest way to get started is by calling show_bloq.

Basic Usage

from qualtran.drawing import show_bloq

# Use some test bloqs to show drawing features
from qualtran.bloqs.for_testing import TestAtom, TestParallelCombo

Each constituent bloq is a table whose header contains the bloq name. Each row is a register. Edges represent connections between soquets. Each edge is labeled with the bitsize of the connected registers. Dangling soquets (corresponding to the enclosing bloq’s registers) are drawn as plain text.

show_bloq(TestAtom())

show_bloq(TestParallelCombo())

cbloq = TestParallelCombo().decompose_bloq()
show_bloq(cbloq)

Advanced Usage

PrettyGraphDrawer and GraphDrawer

These classes contain the complete functionality for translating a composite bloq into a graphviz-compatible graph.

By default, we use PrettyGraphDrawer which abbreviates names, hides some details of reshaping bloqs, and chooses drawing parameters to give a compact visualization of the bloq. For debugging purposes or to serve as a base class for modifying drawing parameters to your liking, consider GraphDrawer which relies solely on graphviz defaults.

from qualtran.drawing import PrettyGraphDrawer

PrettyGraphDrawer(cbloq).get_svg()

from qualtran.drawing import GraphDrawer

GraphDrawer(cbloq).get_svg()

ClassicalSimGraphDrawer

This simple extension of GraphDrawer annotates each edge according to classical data that flows through bloqs supporting the classical simulation protocol.

from qualtran.drawing import ClassicalSimGraphDrawer
from qualtran.bloqs.mcmt import MultiAnd

ClassicalSimGraphDrawer(
    bloq=MultiAnd((1,1,1,1)).decompose_bloq(), 
    vals=dict(ctrl=[1,1,0,1])
).get_svg()

Graphviz and pydot

We use pydot to manupulate graphviz graphs. You can get that graph directly:

graph = GraphDrawer(cbloq).get_graph()
print(graph.to_string())

digraph my_graph {
rankdir=LR;
subgraph {
rank=same;
reg_G7 [label=reg, shape=plaintext];
}
TestAtom [label=<<TABLE >
  <TR><TD colspan="2">TestAtom</TD></TR>
  <TR><TD colspan="2" port="q_G6">q</TD></TR>
</TABLE>>, shape=plain];
Join [label=<<TABLE >
  <TR><TD colspan="2">Join</TD></TR>
  <TR><TD  port="reg_G13">reg[0]</TD><TD rowspan="3" port="reg_G12">reg</TD></TR>
  <TR><TD  port="reg_G11">reg[1]</TD></TR>
  <TR><TD  port="reg_G17">reg[2]</TD></TR>
</TABLE>>, shape=plain];
TestAtom_G0 [label=<<TABLE >
  <TR><TD colspan="2">TestAtom</TD></TR>
  <TR><TD colspan="2" port="q_G10">q</TD></TR>
</TABLE>>, shape=plain];
TestAtom_G2 [label=<<TABLE >
  <TR><TD colspan="2">TestAtom</TD></TR>
  <TR><TD colspan="2" port="q_G16">q</TD></TR>
</TABLE>>, shape=plain];
Split [label=<<TABLE >
  <TR><TD colspan="2">Split</TD></TR>
  <TR><TD rowspan="3" port="reg_G14">reg</TD><TD  port="reg_G5">reg[0]</TD></TR>
  <TR><TD  port="reg_G15">reg[1]</TD></TR>
  <TR><TD  port="reg_G9">reg[2]</TD></TR>
</TABLE>>, shape=plain];
subgraph {
rank=same;
reg_G8 [label=reg, shape=plaintext];
}
reg_G7:e -> Split:reg_G14:w [label=3];
Split:reg_G5:e -> TestAtom_G2:q_G16:w [label=1];
Split:reg_G15:e -> TestAtom:q_G6:w [label=1];
Split:reg_G9:e -> TestAtom_G0:q_G10:w [label=1];
TestAtom_G2:q_G16:e -> Join:reg_G13:w [label=1];
TestAtom:q_G6:e -> Join:reg_G11:w [label=1];
TestAtom_G0:q_G10:e -> Join:reg_G17:w [label=1];
Join:reg_G12:e -> reg_G8:w [label=3];
}

Register Groups

We group left and right registers with shared names. This section shows some usual and unusual register specifications to test the graphviz logic for making the table rows match up.

from qualtran import Bloq, Register, Signature, Side, QAny

class SignatureBloq(Bloq):
    """Placeholder bloq that lets you specify its signature."""
    def __init__(self, signature: Signature):
        self._signature = signature
        
    @property
    def signature(self) -> Signature:
        return self._signature
        
    def __str__(self):
        return 'Bloq'

bloq = SignatureBloq(Signature([
    Register('x', QAny(100)),
    Register('y', QAny(200)),
]))
show_bloq(bloq)

bloq = SignatureBloq(Signature([
    Register('x', QAny(100)),
    Register('a', QAny(2), shape=(2,), side=Side.LEFT),
    Register('y', QAny(200)),
]))
show_bloq(bloq)

bloq = SignatureBloq(Signature([
    Register('x', QAny(100)),
    Register('a', QAny(2), shape=(2,2), side=Side.LEFT),
    Register('a', QAny(8),  side=Side.RIGHT),
    Register('y', QAny(200)),
]))
show_bloq(bloq)

bloq = SignatureBloq(Signature([
    Register('x', QAny(100)),
    Register('a', QAny(2), shape=(2,2), side=Side.LEFT),
    Register('a', QAny(4), shape=(2,), side=Side.RIGHT),
    Register('y', QAny(200)),
]))
show_bloq(bloq)