Skip to content

diagram

Module containing Diagram class definition.

Diagram

Reliability block diagram class definition.

Parameters:

Name Type Description Default
name str

name of diagram

 required
blocks list[Block]

list of Block instances

 required
hazard str

string defining the hazard block text (optional)

 ""
colors Optional[dict[str, str]]

dictionary with custom color definitions in HEX format: {'color name': '6 digit hex code'}

 None

Attributes:

Name Type Description
colors dict[str, str], default={"arrowcolor": "4c4d4c", "hazardcolor": "ff6666"}

default diagram color definitions
Source code in pyrbd/diagram.py 
 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
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
class Diagram:
    """Reliability block diagram class definition.

    Parameters
    ----------
    name : str
        name of diagram
    blocks : list[Block]
        list of `Block` instances
    hazard : str, default=""
        string defining the `hazard` block text (optional)
    colors : Optional[dict[str, str]], default=None
        dictionary with custom color definitions in HEX format:
        `{'color name': '6 digit hex code'}`

    Attributes
    ----------
    colors : dict[str, str], default={"arrowcolor": "4c4d4c", "hazardcolor": "ff6666"}
        default diagram color definitions
    """

    _template: str = "diagram.tex.jinja"
    colors: dict[str, str] = {"arrowcolor": "4c4d4c", "hazardcolor": "ff6666"}

    def __init__(
        self,
        name: str,
        blocks: list[Block],
        hazard: str = "",
        colors: Optional[dict[str, str]] = None,
    ) -> None:
        self.filename = name
        if hazard:
            self.head = Block(hazard, "hazardcolor")
        else:
            self.head = blocks.pop(0)

        self.head.id = "0"
        self.blocks = blocks
        self.blocks[0].parent = self.head

        if colors is not None:
            self.colors = self.colors | colors

    def write(self) -> None:
        """Write diagram to .tex file."""

        environment = JINJA_ENV
        template = environment.get_template(self._template)

        context = {
            "serif_font": config.SERIF_FONT,
            "arrow_style": config.ARROW_STYLE,
            "color_defs": [
                {"name": name, "hex_code": code} for name, code in self.colors.items()
            ],
            "blocks": list(block.get_node() for block in [self.head, *self.blocks]),
        }
        content = template.render(context)

        with open(f"{self.filename}.tex", mode="w", encoding="utf-8") as file:
            file.write(content)

    def _to_svg(self) -> str:
        """Convert diagram file from pdf to svg.

        Returns
        -------
        str
            filename of .svg file
        """

        pdf_document = pymupdf.open(f"{self.filename}.pdf")
        page = pdf_document[0]

        # Get and convert page to svg image
        svg_content = page.get_svg_image().splitlines()
        svg_content.insert(
            1,
            "\n".join(
                [
                    "<style>",
                    "   @media (prefers-color-scheme: light) { :root { --color: #000000; } }",
                    "   @media (prefers-color-scheme: dark) { :root { --color: #DDDDDD; } }",
                    "</style>",
                ]
            ),
        )
        svg_content = "\n".join(svg_content).replace(r"#4c4d4c", "var(--color)")

        # Save to file
        with open(output_file := f"{self.filename}.svg", "w", encoding="utf-8") as file:
            file.write(svg_content)

        pdf_document.close()

        return output_file

    def _to_png(self) -> str:
        """Convert diagram file from pdf to png.

        Returns
        -------
        str
            filename of .png file
        """

        pdf_document = pymupdf.open(f"{self.filename}.pdf")
        page = pdf_document[0]

        # Get image
        image = page.get_pixmap(dpi=300)

        # Save to file
        image.save(output_file := f"{self.filename}.png")

        pdf_document.close()

        return output_file

    def compile(
        self, output: str | list[str] = "pdf", clear_source: bool = True
    ) -> list[str]:
        """Compile diagram .tex file.

        Parameters
        ----------
        output : str | list[str], default='pdf'
            output format string or list of output formats for diagram. Valid output formats are

            - `'pdf'` (default)
            - `'svg'`
            - `'png'`

        clear_source : bool, default=True
            .tex source file is deleted after compilation if `True`

        Returns
        -------
        list[str]
            list of output filenames

        Raises
        ------
        FileNotFoundError
            If .tex file is not found, e.g. because `Diagram.write()` has not been called
            before `Diagram.compile()`.
        """

        try:
            subprocess.check_call(
                ["latexmk", "--lualatex", f"{self.filename}.tex", "--silent"]
            )
            subprocess.check_call(["latexmk", "-c", f"{self.filename}.tex"])
            if clear_source:
                subprocess.check_call(["rm", f"{self.filename}.tex"])
        except subprocess.CalledProcessError as err:
            if err.returncode == 11:
                raise FileNotFoundError(
                    (
                        f"File {self.filename} not found. "
                        + "Check if call to Class method write() is missing."
                    )
                ) from err

        output_files: list[str] = []

        if not isinstance(output, list):
            output = [output]

        if "svg" in output:
            output_files.append(self._to_svg())
        if "png" in output:
            output_files.append(self._to_png())
        if "pdf" not in output:
            subprocess.check_call(["rm", f"{self.filename}.pdf"])
        else:
            output_files.append(f"{self.filename}.pdf")

        return output_files

compile(output='pdf', clear_source=True)

Compile diagram .tex file.

Parameters:

Name Type Description Default
output str | list[str]

output format string or list of output formats for diagram. Valid output formats are

  • 'pdf' (default)
  • 'svg'
  • 'png'
 'pdf'
clear_source bool

.tex source file is deleted after compilation if True

 True

Returns:

Type Description
list[str]

list of output filenames

Raises:

Type Description
FileNotFoundError

If .tex file is not found, e.g. because Diagram.write() has not been called before Diagram.compile().
Source code in pyrbd/diagram.py 
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
def compile(
    self, output: str | list[str] = "pdf", clear_source: bool = True
) -> list[str]:
    """Compile diagram .tex file.

    Parameters
    ----------
    output : str | list[str], default='pdf'
        output format string or list of output formats for diagram. Valid output formats are

        - `'pdf'` (default)
        - `'svg'`
        - `'png'`

    clear_source : bool, default=True
        .tex source file is deleted after compilation if `True`

    Returns
    -------
    list[str]
        list of output filenames

    Raises
    ------
    FileNotFoundError
        If .tex file is not found, e.g. because `Diagram.write()` has not been called
        before `Diagram.compile()`.
    """

    try:
        subprocess.check_call(
            ["latexmk", "--lualatex", f"{self.filename}.tex", "--silent"]
        )
        subprocess.check_call(["latexmk", "-c", f"{self.filename}.tex"])
        if clear_source:
            subprocess.check_call(["rm", f"{self.filename}.tex"])
    except subprocess.CalledProcessError as err:
        if err.returncode == 11:
            raise FileNotFoundError(
                (
                    f"File {self.filename} not found. "
                    + "Check if call to Class method write() is missing."
                )
            ) from err

    output_files: list[str] = []

    if not isinstance(output, list):
        output = [output]

    if "svg" in output:
        output_files.append(self._to_svg())
    if "png" in output:
        output_files.append(self._to_png())
    if "pdf" not in output:
        subprocess.check_call(["rm", f"{self.filename}.pdf"])
    else:
        output_files.append(f"{self.filename}.pdf")

    return output_files

write()

Write diagram to .tex file.

Source code in pyrbd/diagram.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
def write(self) -> None:
    """Write diagram to .tex file."""

    environment = JINJA_ENV
    template = environment.get_template(self._template)

    context = {
        "serif_font": config.SERIF_FONT,
        "arrow_style": config.ARROW_STYLE,
        "color_defs": [
            {"name": name, "hex_code": code} for name, code in self.colors.items()
        ],
        "blocks": list(block.get_node() for block in [self.head, *self.blocks]),
    }
    content = template.render(context)

    with open(f"{self.filename}.tex", mode="w", encoding="utf-8") as file:
        file.write(content)