pyrbd 0.2.5__py3-none-any.whl → 0.3.1__py3-none-any.whl

pyrbd/block.py

@@ -3,6 +3,10 @@
 from typing import Optional
 from itertools import combinations
 from copy import deepcopy
+from collections import namedtuple
+
+
+Padding = namedtuple("Padding", ["n", "e", "s", "w"])
 
 
 class Block:
@@ -40,7 +44,7 @@ class Block:
             "anchor=west",
             "align=center",
             "fill={fill_color}",
-            "draw=black",
+            "draw=black!70!gray",
             "minimum height=1cm",
             "rounded corners=0.3mm",
             "inner sep=4pt",
@@ -48,6 +52,9 @@ class Block:
         ]
     )
 
+    arrow_options: str = "arrowcolor, thick"
+    arrow_length: float = 0.5
+
     def __init__(
         self,
         text: str,
@@ -68,7 +75,13 @@ class Block:
         if self.parent is None:
             return ""
 
-        return f"[right={0.5 + self.shift[0]}cm of {self.parent.id}, yshift={self.shift[1]}cm]"
+        return " ".join(
+            [
+                f"[right={self.arrow_length + self.shift[0]}cm",
+                f"of {self.parent.id},",
+                f"yshift={self.shift[1]}cm]",
+            ]
+        )
 
     def arrow(self, connector_position: float) -> str:
         """Get TikZ arrow string.
@@ -90,18 +103,18 @@ class Block:
 
         return "".join(
             [
-                f"\\draw[thick, rectangle connector={connector_position}cm]",
+                f"\\draw[{self.arrow_options}, rectangle connector={connector_position}cm]",
                 f"({self.parent.id}.east) to ({self.id}.west);\n\n",
             ]
         )
 
-    def get_node(self, connector_position: float = 0.25) -> str:
+    def get_node(self, connector_position: Optional[float] = None) -> str:
         """Get TikZ node string.
 
         Parameters
         ----------
-        connector_position : float, default: 0.25
-            distance in cm to right angle bend in connector
+        connector_position : Optional[float]
+            distance in cm to right angle bend in connector. Defaults to `0.5*arrow_length`.
 
         Returns
         -------
@@ -109,6 +122,9 @@ class Block:
             TikZ string for rendering block
         """
 
+        if connector_position is None:
+            connector_position = self.arrow_length / 2
+
         node = "".join(
             [
                 "% Block\n",
@@ -206,6 +222,10 @@ class Series(Block):
         ]
     )
 
+    internal_arrow_length = 0.3
+    pad = Padding(1, 1, 1, 2.5)
+    label_height = 5
+
     def __init__(
         self,
         blocks: list[Block],
@@ -217,11 +237,13 @@ class Series(Block):
 
         self.blocks = blocks
         self.blocks[0].id = f"{self.id}+0"
+        self.blocks[0].shift = (self.internal_arrow_length, 0)
         for i, (block, new_parent) in enumerate(
             zip(self.blocks[1::], self.blocks[0:-1]), start=1
         ):
             block.parent = new_parent
             block.id = f"{self.id}+{i}"
+            block.arrow_length = self.internal_arrow_length
 
     @property
     def background(self) -> str:
@@ -230,11 +252,13 @@ class Series(Block):
         if self.color in ("white", ""):
             return ""
 
+        pad = self.pad
+
         return "".join(
             [
                 "\\begin{pgfonlayer}{background}\n",
-                f"\\coordinate (sw) at ($({self.id}.south west)+(-1mm, -1mm)$);\n",
-                f"\\coordinate (ne) at ($({self.id}.north east)+(1mm, 1mm)$);\n",
+                f"\\coordinate (sw) at ($({self.id}.south west)+(-{pad.w}mm, -{pad.s}mm)$);\n",
+                f"\\coordinate (ne) at ($({self.id}.north east)+({pad.e}mm, {pad.n}mm)$);\n",
                 f"\\draw[{self.color}, thick] (sw) rectangle (ne);\n",
                 "\\end{pgfonlayer}\n",
             ]
@@ -247,24 +271,27 @@ class Series(Block):
         if len(self.text) == 0:
             return ""
 
+        pad = self.pad
+
         return "".join(
             [
-                f"\\coordinate (nw) at ($({self.id}.north west)+(-1mm, 1mm)$);\n",
-                f"\\coordinate (ne) at ($({self.id}.north east)+(1mm, 1mm)$);\n",
-                f"\\coordinate (n) at ($({self.id}.north)+(0mm, 1mm)$);\n",
+                f"\\coordinate (nw) at ($({self.id}.north west)+(-{pad.w}mm, {pad.n}mm)$);\n",
+                f"\\coordinate (ne) at ($({self.id}.north east)+({pad.e}mm, {pad.n}mm)$);\n",
+                "\\coordinate (n) at "
+                f"($({self.id}.north)+(0mm, {self.label_height / 2 + pad.n}mm)$);\n",
                 f"\\draw[{self.color}, fill={self.color}!50, thick] (nw) ",
-                "rectangle ($(ne)+(0, 0.5cm)$);\n",
-                f"\\node[anchor=south] at (n) {{{self.text}}};\n",
+                f"rectangle ($(ne)+(0, {self.label_height}mm)$);\n",
+                f"\\node[anchor=center, inner sep=0pt, outer sep=0pt] at (n) {{{self.text}}};\n",
             ]
         )
 
-    def get_node(self, connector_position: float = 0.25) -> str:
+    def get_node(self, connector_position: Optional[float] = None) -> str:
         """Get TikZ node string.
 
         Parameters
         ----------
-        connector_position : float, default: 0.25
-            distance in cm to right angle bend in connector
+        connector_position : Optional[float]
+            distance in cm to right angle bend in connector. Defaults to `0.5 * arrow_length`
 
         Returns
         -------
@@ -273,12 +300,15 @@ class Series(Block):
 
         """
 
+        if connector_position is None:
+            connector_position = self.arrow_length / 2
+
         block_nodes = "\n".join(
             block.get_node(connector_position) for block in self.blocks
         )
         series_node = "".join(
             [
-                f"\\node[{self.tikz_options}]",
+                f"%%% Series\n\\node[{self.tikz_options}]",
                 f"({self.id})",
                 self.position,
                 "{\\begin{tikzpicture}\n",
@@ -320,6 +350,9 @@ class Group(Block):
             "anchor=west",
         ]
     )
+    internal_arrow_length = 0.3
+    pad = Padding(1, 1, 1, 1)
+    label_height = 5
 
     def __init__(
         self,
@@ -335,6 +368,7 @@ class Group(Block):
             block.shift = (0, shift)
             block.parent = self
             block.id = f"{self.id}-{i}"
+            block.arrow_length = self.internal_arrow_length
 
     @property
     def shifts(self) -> list[float]:
@@ -357,11 +391,13 @@ class Group(Block):
         if self.color in ("white", ""):
             return ""
 
+        pad = self.pad
+
         return "".join(
             [
                 "\\begin{pgfonlayer}{background}\n",
-                f"\\coordinate (sw) at ($({self.id}.south west)+(-1mm, -1mm)$);\n",
-                f"\\coordinate (ne) at ($({self.id}.north east)+(1mm, 1mm)$);\n",
+                f"\\coordinate (sw) at ($({self.id}.south west)+(-{pad.w}mm, -{pad.s}mm)$);\n",
+                f"\\coordinate (ne) at ($({self.id}.north east)+({pad.e}mm, {pad.n}mm)$);\n",
                 f"\\draw[{self.color}, thick] (sw) rectangle (ne);\n",
                 "\\end{pgfonlayer}\n",
             ]
@@ -374,14 +410,17 @@ class Group(Block):
         if len(self.text) == 0:
             return ""
 
+        pad = self.pad
+
         return "".join(
             [
-                f"\\coordinate (nw) at ($({self.id}.north west)+(-1mm, 1mm)$);\n",
-                f"\\coordinate (ne) at ($({self.id}.north east)+(1mm, 1mm)$);\n",
-                f"\\coordinate (n) at ($({self.id}.north)+(0mm, 1mm)$);\n",
+                f"\\coordinate (nw) at ($({self.id}.north west)+(-{pad.w}mm, {pad.n}mm)$);\n",
+                f"\\coordinate (ne) at ($({self.id}.north east)+({pad.e}mm, {pad.n}mm)$);\n",
+                "\\coordinate (n) at ",
+                f"($({self.id}.north)+(0mm, {self.label_height / 2 + pad.n}mm)$);\n",
                 f"\\draw[{self.color}, fill={self.color}!50, thick] (nw) ",
-                "rectangle ($(ne)+(0, 0.5cm)$);\n",
-                f"\\node[anchor=south] at (n) {{{self.text}}};\n",
+                f"rectangle ($(ne)+(0, {self.label_height}mm)$);\n",
+                f"\\node[anchor=center, inner sep=0pt, outer sep=0pt] at (n) {{{self.text}}};\n",
             ]
         )
 
@@ -402,17 +441,20 @@ class Group(Block):
         if self.parent is None:
             return ""
 
-        return f"\\draw[thick] ({self.parent.id}.east) to ({self.id}.west);\n"
+        return f"\\draw[{self.arrow_options}] ({self.parent.id}.east) to ({self.id}.west);\n"
 
     @property
     def arrows(self) -> str:
         """Get TikZ string for arrow connecting stacked blocks."""
 
+        scaling = 0.75
+
         return "\n".join(
             [
                 " ".join(
                     [
-                        "\\draw[thick, rectangle line]",
+                        f"\\draw[{self.arrow_options},",
+                        f"rectangle line={scaling * self.internal_arrow_length}cm]",
                         f"({block1.id}.east) to ({block2.id}.east);\n",
                     ]
                 )
@@ -420,13 +462,14 @@ class Group(Block):
             ]
         )
 
-    def get_node(self, connector_position: float = 0.0) -> str:
+    def get_node(self, connector_position: Optional[float] = None) -> str:
         """Get TikZ node string.
 
         Parameters
         ----------
-        connector_position : float, default: 0.0
-            distance in cm to right angle bend in connector
+        connector_position : Optional[float]
+            distance in cm to right angle bend in connector.
+            Locked to 0.0 for `Group` class
 
         Returns
         -------
@@ -434,12 +477,15 @@ class Group(Block):
             TikZ string for rendering group
         """
 
+        connector_position = 0.0
+
         block_nodes = "\n".join(
             block.get_node(connector_position) for block in self.blocks
         )
 
         group_node = "".join(
             [
+                "%%% Group\n"
                 f"\\node[anchor=west, outer sep=0pt, inner sep=0pt, align=center] ({self.id}) ",
                 self.position,
                 "{\\begin{tikzpicture}\n",

pyrbd/diagram.py

@@ -1,5 +1,6 @@
 """Module containing Diagram class definition."""
 
+from typing import Optional
 import subprocess
 
 import pymupdf
@@ -18,12 +19,24 @@ class Diagram:
         list of `Block` instances
     hazard : str, optional
         string defining the `hazard` block text
+    colors : dict[str, str], optional
+        dictionary with custom color definitions in HEX format:
+        `{'color name': '6 digit hex code'}`
     """
 
-    def __init__(self, name: str, blocks: list[Block], hazard: str = "") -> None:
+    # Default color definitions
+    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, "red!60")
+            self.head = Block(hazard, "hazardcolor")
         else:
             self.head = blocks.pop(0)
 
@@ -31,11 +44,14 @@ class Diagram:
         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."""
 
         with open(f"{self.filename}.tex", mode="w", encoding="utf-8") as file:
-            file.write(TEX_PREAMBLE)
+            file.write(tex_preamble(self.colors))
             for block in [self.head, *self.blocks]:
                 file.write(block.get_node())
             file.write(TEX_END)
@@ -53,7 +69,19 @@ class Diagram:
         page = pdf_document[0]
 
         # Get and convert page to svg image
-        svg_content = page.get_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:
@@ -115,7 +143,9 @@ class Diagram:
         """
 
         try:
-            subprocess.check_call(["latexmk", f"{self.filename}.tex", "--silent"])
+            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"])
@@ -145,38 +175,54 @@ class Diagram:
         return output_files
 
 
-TEX_PREAMBLE = "\n".join(
-    [
-        r"\documentclass{standalone}",
-        r"\usepackage{tikz}",
-        r"\usetikzlibrary{shapes,arrows,positioning,calc}",
-        r"\pgfdeclarelayer{background}",
-        r"\pgfsetlayers{background, main}",
-        r"\tikzset{",
-        r"connector/.style={",
-        r"-latex,",
-        r"font=\scriptsize},",
-        r"line/.style={",
-        r"font=\scriptsize},",
-        r"rectangle connector/.style={",
-        r"connector,"
-        r"to path={(\tikztostart) -- ++(#1,0pt) \tikztonodes |- (\tikztotarget) },",
-        r"pos=0.5},"
-        r"rectangle connector/.default=0.5cm,",
-        r"rectangle line/.style={",
-        r"line,"
-        r"to path={(\tikztostart) -- ++(#1,0pt) \tikztonodes |- (\tikztotarget) },",
-        r"pos=0.5},"
-        r"rectangle line/.default=0.5cm,",
-        r"straight connector/.style={",
-        r"connector,",
-        r"to path=--(\tikztotarget) \tikztonodes}",
-        r"}",
-        r"\begin{document}",
-        r"\begin{tikzpicture}",
-        "",
-    ]
-)
+def tex_preamble(custom_colors: dict[str, str] | None = None) -> str:
+    """LaTeX file preamble file with definition of custom colors given in dictionary."""
+
+    color_defs = []
+    if custom_colors is not None:
+        color_defs = [
+            f"\\definecolor{{{color_name}}}{{HTML}}{{{hex_code}}}"
+            for (color_name, hex_code) in custom_colors.items()
+        ]
+
+    return "\n".join(
+        [
+            r"\documentclass{standalone}",
+            r"\usepackage[T1]{fontenc}"
+            r"\usepackage{helvet}",
+            r"\renewcommand{\familydefault}{\sfdefault}",
+            r"\usepackage[dvipsnames,svgnames,x11names]{xcolor}",
+            r"\usepackage{tikz}",
+            r"\usetikzlibrary{shapes,arrows,positioning,calc}",
+            r"\pgfdeclarelayer{background}",
+            r"\pgfsetlayers{background, main}",
+            r"\tikzset{",
+            r"connector/.style={",
+            r"-latex,",
+            r"font=\scriptsize},",
+            r"line/.style={",
+            r"font=\scriptsize},",
+            r"rectangle connector/.style={",
+            r"connector,"
+            r"to path={(\tikztostart) -- ++(#1,0pt) \tikztonodes |- (\tikztotarget) },",
+            r"pos=0.5},"
+            r"rectangle connector/.default=0.5cm,",
+            r"rectangle line/.style={",
+            r"line,"
+            r"to path={(\tikztostart) -- ++(#1,0pt) \tikztonodes |- (\tikztotarget) },",
+            r"pos=0.5},"
+            r"rectangle line/.default=0.5cm,",
+            r"straight connector/.style={",
+            r"connector,",
+            r"to path=--(\tikztotarget) \tikztonodes}",
+            r"}",
+            *color_defs,
+            r"\begin{document}",
+            r"\begin{tikzpicture}",
+            "",
+        ]
+    )
+
 
 TEX_END = "\n".join(
     [

{pyrbd-0.2.5.dist-info → pyrbd-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyrbd
-Version: 0.2.5
+Version: 0.3.1
 Summary: Package for creating simple reliability block diagrams (RBDs) using LaTeX and TikZ.
 Project-URL: Repository, https://github.com/hghugdal/pyrbd
 Project-URL: Issues, https://github.com/hghugdal/pyrbd/issues
@@ -11,12 +11,17 @@ License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
+Requires-Dist: pre-commit>=4.3.0
 Requires-Dist: pymupdf>=1.26.3
 Description-Content-Type: text/markdown
 
-# <img alt="pyRBDlogo" src=docs/images/logo.svg width=40 align=top> pyRBD
+# <img alt="pyRBDlogo" src="https://raw.githubusercontent.com/hghugdal/pyrbd/23d7f00ca74e8465df3760821488b4bb78df803c/docs/images/logo.svg" width=40 align=top> pyRBD
 
-<img alt="Python" src="https://img.shields.io/badge/Python->= 3.10-blue?logo=python&link=None"> ![PyPI - Version](https://img.shields.io/pypi/v/pyrbd?link=https%3A%2F%2Fpypi.org%2Fproject%2Fpyrbd) <img alt="Tests" src="https://img.shields.io/badge/Tests-Passing-darkgreen?logo=pytest&link=None"> <img alt="Coverage" src="https://img.shields.io/badge/Coverage-100%25-darkgreen?link=None"> <img alt="Pylint" src="https://img.shields.io/badge/Pylint-10%2F10-darkgreen?link=None">
+[![PyPI - Version](https://img.shields.io/pypi/v/pyrbd)](https://pypi.org/project/pyrbd/)
+<img alt="Python" src="https://img.shields.io/badge/Python->= 3.10-blue?logo=python&link=None">
+<img alt="Tests" src="https://img.shields.io/badge/Tests-Passing-darkgreen?logo=pytest&link=None">
+<img alt="Coverage" src="https://img.shields.io/badge/Coverage-100%25-darkgreen?link=None">
+<img alt="Pylint" src="https://img.shields.io/badge/Pylint-10%2F10-darkgreen?link=None">
 
 A Python package for creating simple reliability block diagrams (RBDs) using `LaTeX` and [`TikZ`](https://en.wikipedia.org/wiki/PGF/TikZ).
 
@@ -25,6 +30,7 @@ A Python package for creating simple reliability block diagrams (RBDs) using `La
 
 ## Simple example diagram
 The blocks of the RBD are defined using `Block`, `Series` and `Group`, and the diagram itself is handled by the `Diagram` class. A simple example is given by the code
+
 ```python linenums="1"
 from pyrbd import Block, Diagram
 
@@ -39,7 +45,8 @@ diagram = Diagram(
 diagram.write()
 diagram.compile()
 ```
+
 producing the following diagram
-<div><img src="docs/examples/simple_RBD.svg" width=500/></div>
+<div><img src="https://raw.githubusercontent.com/hghugdal/pyrbd/e11808e9a40c902f0e1c2c2b0b42ca0d90170cd1/docs/examples/simple_RBD.svg" width=500/></div>
 
 For more examples, visit the [documentation](https://hghugdal.github.io/pyrbd/).

pyrbd-0.3.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+pyrbd/__init__.py,sha256=mpsb022BX9eDGSBhuYIr2gOr4sg_M9sYbPGHLPIdvl0,219
+pyrbd/block.py,sha256=l44FYLS9zQbyblDsVUb9GwvsFm_sU1IamlpbrjryVbw,13786
+pyrbd/diagram.py,sha256=YiU2tslUh4HbtuVP2dXSsVQFKpOjLl_ArSYjCSiQoks,6806
+pyrbd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyrbd-0.3.1.dist-info/METADATA,sha256=_IHhEyyaEaLB7lg1iicfWM4lZWg97I4wskgq3OuDqjc,2402
+pyrbd-0.3.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pyrbd-0.3.1.dist-info/licenses/LICENSE,sha256=mxXMgWpFgk71JpEEElFrb9FJxeoaDgvrU8gjUUU9LzA,1069
+pyrbd-0.3.1.dist-info/RECORD,,

pyrbd-0.2.5.dist-info/RECORD

@@ -1,7 +0,0 @@
-pyrbd/__init__.py,sha256=mpsb022BX9eDGSBhuYIr2gOr4sg_M9sYbPGHLPIdvl0,219
-pyrbd/block.py,sha256=ETRZJeEUU4OPk0qGo6zZIsaR1oLkyDPf1kelfuKWNsc,12219
-pyrbd/diagram.py,sha256=NVAsdfmqAu6-6J2mT5Gp2W_8a9WsI2iMbKjcEI6QFlE,5092
-pyrbd-0.2.5.dist-info/METADATA,sha256=WN1raYOu5KJtH5wj-7b1P8wH8-1GGHmnnqvwrt5hmZs,2196
-pyrbd-0.2.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pyrbd-0.2.5.dist-info/licenses/LICENSE,sha256=mxXMgWpFgk71JpEEElFrb9FJxeoaDgvrU8gjUUU9LzA,1069
-pyrbd-0.2.5.dist-info/RECORD,,