Skip to content

Tutorials

Simple diagram

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from pyrbd import Block, Diagram

# Define the blocks comprising the diagram
start_block = Block("Start", "blue!30")  # (1)
parallel = 2 * Block("Parallel blocks", "gray", parent=start_block)  # (2)
end_block = Block("End", "green!50", parent=parallel)  # (3)

# Define and compile the diagram
diagram = Diagram(
    "simple_RBD",
    blocks=[start_block, parallel, end_block],
)
diagram.write()
diagram.compile(["pdf", "svg"])  # (4)
  1. The first block does not need a parent
  2. To get identical parallel blocks, multiply a Block instance by an int
  3. For the other blocks we must specify the previous block in the diagram as the parent block
  4. We can specify multiple output formats by providing a list of formats. Defaults to PDF if unspecified.

Example with more functionality

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
from pyrbd import Block, Group, Series, Diagram, config

config.ARROW_STYLE = "-latex"  # (1)
config.SERIF_FONT = True

# Define all the blocks in the diagram
start_block = Block("Start", "myblue", parent=None)
parallel = 2 * Block("Parallel blocks", "gray", parent=start_block)  # (2)
block_1 = Block(r"Block 1", "yellow!50")
block_2 = Block(r"Block 2", "yellow!50")
block_3 = Block(r"Block 3", "yellow!50")
block_4 = Block(r"Block 4", "yellow!50")
group = Group(  # (3)
    [block_1 + block_2, block_3 + block_4],  # (4)
    parent=parallel,
    text="Group",
    color="yellow",
)
block_a = Block(r"Block A", "orange!50")
block_b = Block(r"Block B", "orange!50")
series = Series([block_a, block_b], "Series", "orange", parent=group)  # (5)
end_block = Block("End", "green!50", parent=series)

# Add blocks to Diagram class instance and compile diagram
diag = Diagram(
    "example_RBD",
    blocks=[start_block, parallel, group, series, end_block],
    hazard="Hazard",
    colors={"myblue": "8888ff"},  # (6)
)
diag.write()
diag.compile(["svg", "png"])
  1. The arrow style and font can be set by changing the value of config.ARROW_STYLE and config.SERIF_FONT
  2. Here, a Group block is made by simply multiplying a Block instance by an integer
  3. To group different blocks vertically and set a title and color, use the Group class
  4. Adding Block instances creates a Series instance
  5. To group different blocks horizontally and set a title and color, use the Series class
  6. Custom color myblue used in first block is defined here

Layered Series and Group instances

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
from pyrbd import Block, Group, Series, Diagram

# Define the blocks comprising the diagram
start_block = Block("Start", "blue!30")
block = Block("Block", "gray!20")
group_1 = Group(
    [b * 2 for b in 3 * [block]],
    text="Group with Series",
    color="orange",
    parent=start_block,
)
series_1 = Series(
    [deepcopy(block), 2 * block],
    text="Series with Group",
    color="red",
    parent=group_1,
)
series_2 = Series(
    [2 * block, deepcopy(block), 3 * (block * 2)],
    text="Series with mixed Groups",
    color="RoyalBlue",
    parent=series_1,
)
group_2 = Group(
    [
        block * 3,
        deepcopy(block),
        block * 4,
    ],
    text="Group with mixed Series",
    color="red",
    parent=series_2,
)
series_in_series = Series(
    [
        Series([deepcopy(block), deepcopy(block)], color="yellow", text="Child 1"),
        Series([deepcopy(block), deepcopy(block)], color="orange", text="Child 2"),
        deepcopy(block),
    ],
    parent=group_2,
    text="Parent series",
    color="red",
)
end_block = Block("End", "green!50", parent=series_in_series)

# Define and compile the diagram
diagram = Diagram(
    "layered_RBD",
    blocks=[
        start_block,
        group_1,
        series_1,
        series_2,
        group_2,
        series_in_series,
        end_block,
    ],
)
diagram.write()
diagram.compile(["pdf", "svg"])