pyrbd 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

pyrbd/block.py

@@ -1,8 +1,11 @@
 """Module containing Block, Series and Group class definitions."""
 
-from typing import Optional
-from itertools import combinations
+from typing import Optional, Generator
 from copy import deepcopy
+from collections import namedtuple
+
+
+Padding = namedtuple("Padding", ["n", "e", "s", "w"])
 
 
 class Block:
@@ -49,6 +52,7 @@ class Block:
     )
 
     arrow_options: str = "arrowcolor, thick"
+    arrow_length: float = 0.5
 
     def __init__(
         self,
@@ -70,7 +74,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.
@@ -97,13 +107,13 @@ class Block:
             ]
         )
 
-    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
         -------
@@ -111,6 +121,9 @@ class Block:
             TikZ string for rendering block
         """
 
+        if connector_position is None:
+            connector_position = self.arrow_length / 2
+
         node = "".join(
             [
                 "% Block\n",
@@ -123,6 +136,11 @@ class Block:
         )
         return node
 
+    def get_blocks(self) -> Generator["Block", None, None]:
+        """Yield child `Block` istances."""
+
+        yield self
+
     def __add__(self, block: "Block") -> "Series":
         """Add two `Block` instances to make a `Series` instance.
 
@@ -208,6 +226,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],
@@ -219,11 +241,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:
@@ -232,11 +256,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",
             ]
@@ -249,24 +275,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
         -------
@@ -275,12 +304,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",
@@ -293,6 +325,11 @@ class Series(Block):
         )
         return series_node
 
+    def get_blocks(self) -> Generator[Block, None, None]:
+        yield from [
+            children for block in self.blocks for children in block.get_blocks()
+        ]
+
 
 class Group(Block):
     """Group of `Block` instances for vertical stacking.
@@ -322,6 +359,9 @@ class Group(Block):
             "anchor=west",
         ]
     )
+    internal_arrow_length = 0.3
+    pad = Padding(1, 1, 1, 1)
+    label_height = 5
 
     def __init__(
         self,
@@ -337,6 +377,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]:
@@ -359,11 +400,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",
             ]
@@ -376,14 +419,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",
             ]
         )
 
@@ -410,25 +456,41 @@ class Group(Block):
     def arrows(self) -> str:
         """Get TikZ string for arrow connecting stacked blocks."""
 
+        scaling = 0.75
+
+        series_blocks = [block for block in self.blocks if isinstance(block, Series)]
+        series_blocks.sort(
+            key=lambda block: len(list(block.get_blocks())), reverse=True
+        )
+
+        if len(series_blocks) > 0:
+            longest_series_index = self.blocks.index(series_blocks[0])
+        else:
+            longest_series_index = 0
+        blocks = deepcopy(self.blocks)
+        longest_series = blocks.pop(longest_series_index)
+
         return "\n".join(
             [
                 " ".join(
                     [
-                        f"\\draw[{self.arrow_options}, rectangle line]",
-                        f"({block1.id}.east) to ({block2.id}.east);\n",
+                        f"\\draw[{self.arrow_options},",
+                        f"rectangle line={scaling * self.internal_arrow_length}cm]",
+                        f"({longest_series.id}.east) to ({block.id}.east);\n",
                     ]
                 )
-                for (block1, block2) in combinations(self.blocks, 2)
+                for block in blocks
             ]
         )
 
-    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
         -------
@@ -436,12 +498,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",
@@ -456,3 +521,6 @@ class Group(Block):
         )
 
         return group_node
+
+    def get_blocks(self) -> Generator[Block, None, None]:
+        yield from self.blocks

pyrbd/diagram.py

@@ -143,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"])

{pyrbd-0.3.0.dist-info → pyrbd-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyrbd
-Version: 0.3.0
+Version: 0.3.2
 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,6 +11,7 @@ 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
 
@@ -46,6 +47,6 @@ diagram.compile()
 ```
 
 producing the following diagram
-<div><img src="https://raw.githubusercontent.com/hghugdal/pyrbd/23d7f00ca74e8465df3760821488b4bb78df803c/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.2.dist-info/RECORD

@@ -0,0 +1,8 @@
+pyrbd/__init__.py,sha256=mpsb022BX9eDGSBhuYIr2gOr4sg_M9sYbPGHLPIdvl0,219
+pyrbd/block.py,sha256=xRb4FnPTCA6CEAax2q3GRsngtzJvXlg9wCqr5q3nkEQ,14576
+pyrbd/diagram.py,sha256=YiU2tslUh4HbtuVP2dXSsVQFKpOjLl_ArSYjCSiQoks,6806
+pyrbd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyrbd-0.3.2.dist-info/METADATA,sha256=3JIMvqVdxlQq-30y4omd_yipT8YfgxZOmZxq5SopBBU,2402
+pyrbd-0.3.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pyrbd-0.3.2.dist-info/licenses/LICENSE,sha256=mxXMgWpFgk71JpEEElFrb9FJxeoaDgvrU8gjUUU9LzA,1069
+pyrbd-0.3.2.dist-info/RECORD,,

pyrbd-0.3.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-pyrbd/__init__.py,sha256=mpsb022BX9eDGSBhuYIr2gOr4sg_M9sYbPGHLPIdvl0,219
-pyrbd/block.py,sha256=qQJx2Sn_SvAnm3Chz1f078nTzbS61LSFdxaEveu2RcY,12319
-pyrbd/diagram.py,sha256=llZ0ncDmyJRg7zyQfTXAzbEM1W66wyHs9gfiovy-ujI,6762
-pyrbd-0.3.0.dist-info/METADATA,sha256=KEMFXHPv7ykDCYbh2fOOjcKPyqhOchXl0Ck2pc3ODwQ,2369
-pyrbd-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pyrbd-0.3.0.dist-info/licenses/LICENSE,sha256=mxXMgWpFgk71JpEEElFrb9FJxeoaDgvrU8gjUUU9LzA,1069
-pyrbd-0.3.0.dist-info/RECORD,,