maxplotlibx 0.1__tar.gz → 0.1.2__tar.gz

{maxplotlibx-0.1/src/maxplotlibx.egg-info → maxplotlibx-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maxplotlibx
-Version: 0.1
+Version: 0.1.2
 Summary: A reproducible plotting module with various backends and export options.
 Author: Max
 Project-URL: Source, https://github.com/max-models/maxplotlib
@@ -12,6 +12,7 @@ License-File: LICENSE
 Requires-Dist: matplotlib
 Requires-Dist: pint
 Requires-Dist: plotly
+Requires-Dist: tikzpics>=0.1.1
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: coverage; extra == "test"
@@ -37,8 +38,6 @@ Dynamic: license-file
 
 This is a wrapper for matplotlib so I can produce figures with consistent formatting. It also has some pretty nice additions such as using layers and exporting to tikz.
 
-Related packages: [maxtikzlib](https://github.com/max-models/maxtikzlib) and [maxtexlib](https://github.com/max-models/maxtexlib).
-
 ## Install
 
 Create and activate python environment

{maxplotlibx-0.1 → maxplotlibx-0.1.2}/README.md

@@ -2,8 +2,6 @@
 
 This is a wrapper for matplotlib so I can produce figures with consistent formatting. It also has some pretty nice additions such as using layers and exporting to tikz.
 
-Related packages: [maxtikzlib](https://github.com/max-models/maxtikzlib) and [maxtexlib](https://github.com/max-models/maxtexlib).
-
 ## Install
 
 Create and activate python environment

{maxplotlibx-0.1 → maxplotlibx-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "maxplotlibx"
-version = "0.1"
+version = "0.1.2"
 description = "A reproducible plotting module with various backends and export options."
 readme = "README.md"
 requires-python = ">=3.8"
@@ -18,6 +18,7 @@ dependencies = [
     "matplotlib",
     "pint",
     "plotly",
+    "tikzpics>=0.1.1",
 ]
 [project.optional-dependencies]
 test = [
@@ -47,3 +48,12 @@ dev = [
 
 [tool.setuptools.packages.find]
 where = ["src"]
+
+[tool.black]
+line-length = 88
+
+[tool.ruff]
+line-length = 88
+
+[tool.isort]
+profile = "black"

{maxplotlibx-0.1 → maxplotlibx-0.1.2}/src/maxplotlib/backends/matplotlib/utils.py

@@ -1,18 +1,9 @@
 # import sys; from os.path import dirname; sys.path.append(f'{dirname(__file__)}/../../')
 
 # import matplotlib.pylab as pylab
-import math
-import pickle
-from pathlib import Path
 
-import _pickle as cPickle
-import matplotlib.colors as mcolors
 import matplotlib.pyplot as plt
-import numpy as np
 import pint
-from matplotlib.collections import PatchCollection
-from mpl_toolkits.mplot3d import Axes3D
-from mpl_toolkits.mplot3d.art3d import Line3DCollection, Poly3DCollection
 
 
 def setup_tex_fonts(fontsize=14, usetex=False):
@@ -71,7 +62,6 @@ def _2pt(width, dpi=300):
     elif isinstance(width, str):
         length_in = convert_to_inches(width)
         length_pt = length_in * dpi
-        # print(f"{length_in = } {length_pt = }")
         return length_pt
     else:
         raise NotImplementedError

{maxplotlibx-0.1 → maxplotlibx-0.1.2}/src/maxplotlib/canvas/canvas.py

@@ -1,16 +1,38 @@
 import os
+import re
+from typing import Dict
 
+import matplotlib.patches as patches
 import matplotlib.pyplot as plt
-import plotly.graph_objects as go
 from plotly.subplots import make_subplots
-
-import maxplotlib.backends.matplotlib.utils as plt_utils
+from tikzpics import TikzFigure
+
+from maxplotlib.backends.matplotlib.utils import (
+    set_size,
+    setup_plotstyle,
+    setup_tex_fonts,
+)
+from maxplotlib.colors.colors import Color
+from maxplotlib.linestyle.linestyle import Linestyle
 from maxplotlib.subfigure.line_plot import LinePlot
-from maxplotlib.subfigure.tikz_figure import TikzFigure
+from maxplotlib.utils.options import Backends
 
 
 class Canvas:
-    def __init__(self, **kwargs):
+    def __init__(
+        self,
+        nrows: int = 1,
+        ncols: int = 1,
+        figsize: tuple | None = None,
+        caption: str | None = None,
+        description: str | None = None,
+        label: str | None = None,
+        fontsize: int = 14,
+        dpi: int = 300,
+        width: str = "17cm",
+        ratio: str = "golden",  # TODO Add literal
+        gridspec_kw: Dict = {"wspace": 0.08, "hspace": 0.1},
+    ):
         """
         Initialize the Canvas class for multiple subplots.
 
@@ -18,21 +40,27 @@ class Canvas:
         nrows (int): Number of subplot rows. Default is 1.
         ncols (int): Number of subplot columns. Default is 1.
         figsize (tuple): Figure size.
+        caption (str): Caption for the figure.
+        description (str): Description for the figure.
+        label (str): Label for the figure.
+        fontsize (int): Font size. Default is 14.
+        dpi (int): DPI for the figure. Default is 300.
+        width (str): Width of the figure. Default is "17cm".
+        ratio (str): Aspect ratio. Default is "golden".
+        gridspec_kw (dict): Gridspec keyword arguments. Default is {"wspace": 0.08, "hspace": 0.1}.
         """
 
-        # nrows=1, ncols=1, caption=None, description=None, label=None, figsize=None
-        self._nrows = kwargs.get("nrows", 1)
-        self._ncols = kwargs.get("ncols", 1)
-        self._figsize = kwargs.get("figsize", None)
-        self._caption = kwargs.get("caption", None)
-        self._description = kwargs.get("description", None)
-        self._label = kwargs.get("label", None)
-        self._fontsize = kwargs.get("fontsize", 14)
-        self._dpi = kwargs.get("dpi", 300)
-        # self._width = kwargs.get("width", 426.79135)
-        self._width = kwargs.get("width", "17cm")
-        self._ratio = kwargs.get("ratio", "golden")
-        self._gridspec_kw = kwargs.get("gridspec_kw", {"wspace": 0.08, "hspace": 0.1})
+        self._nrows = nrows
+        self._ncols = ncols
+        self._figsize = figsize
+        self._caption = caption
+        self._description = description
+        self._label = label
+        self._fontsize = fontsize
+        self._dpi = dpi
+        self._width = width
+        self._ratio = ratio
+        self._gridspec_kw = gridspec_kw
         self._plotted = False
 
         # Dictionary to store lines for each subplot
@@ -120,8 +148,6 @@ class Canvas:
 
         # Initialize the LinePlot for the given subplot position
         tikz_figure = TikzFigure(
-            col=col,
-            row=row,
             label=label,
             **kwargs,
         )
@@ -196,11 +222,10 @@ class Canvas:
     def savefig(
         self,
         filename,
-        backend="matplotlib",
-        layers=None,
-        layer_by_layer=False,
-        verbose=False,
-        plot=True,
+        backend: Backends = "matplotlib",
+        layers: list | None = None,
+        layer_by_layer: bool = False,
+        verbose: bool = False,
     ):
         filename_no_extension, extension = os.path.splitext(filename)
         if backend == "matplotlib":
@@ -229,7 +254,6 @@ class Canvas:
                 else:
 
                     fig, axs = self.plot(
-                        show=False,
                         backend="matplotlib",
                         savefig=True,
                         layers=layers,
@@ -238,20 +262,33 @@ class Canvas:
                 if verbose:
                     print(f"Saved {full_filepath}")
 
-    def plot(self, backend="matplotlib", savefig=False, layers=None):
+    def plot(
+        self,
+        backend: Backends = "matplotlib",
+        savefig=False,
+        layers=None,
+    ):
         if backend == "matplotlib":
             return self.plot_matplotlib(savefig=savefig, layers=layers)
         elif backend == "plotly":
             return self.plot_plotly(savefig=savefig)
+        elif backend == "tikzpics":
+            return self.plot_tikzpics(savefig=savefig)
         else:
             raise ValueError(f"Invalid backend: {backend}")
 
-    def show(self, backend="matplotlib"):
+    def show(
+        self,
+        backend: Backends = "matplotlib",
+    ):
         if backend == "matplotlib":
             self.plot(backend="matplotlib", savefig=False, layers=None)
             self._matplotlib_fig.show()
         elif backend == "plotly":
-            plot = self.plot_plotly(savefig=False)
+            self.plot_plotly(savefig=False)
+        elif backend == "tikzpics":
+            fig = self.plot_tikzpics(savefig=False)
+            fig.show()
         else:
             raise ValueError("Invalid backend")
 
@@ -263,9 +300,9 @@ class Canvas:
         filename (str, optional): Filename to save the figure.
         """
 
-        tex_fonts = plt_utils.setup_tex_fonts(fontsize=self.fontsize, usetex=usetex)
+        tex_fonts = setup_tex_fonts(fontsize=self.fontsize, usetex=usetex)
 
-        plt_utils.setup_plotstyle(
+        setup_plotstyle(
             tex_fonts=tex_fonts,
             axes_grid=True,
             axes_grid_which="major",
@@ -276,25 +313,26 @@ class Canvas:
         if self._figsize is not None:
             fig_width, fig_height = self._figsize
         else:
-            fig_width, fig_height = plt_utils.set_size(
+            fig_width, fig_height = set_size(
                 width=self._width,
                 ratio=self._ratio,
                 dpi=self.dpi,
             )
 
-        # print(f"{(fig_width / self._dpi, fig_height / self._dpi) = }")
-
         fig, axes = plt.subplots(
             self.nrows,
             self.ncols,
             figsize=(fig_width, fig_height),
             squeeze=False,
-            dpi=self._dpi,
+            dpi=self.dpi,
         )
 
         for (row, col), subplot in self.subplots.items():
             ax = axes[row][col]
-            subplot.plot_matplotlib(ax, layers=layers)
+            if isinstance(subplot, TikzFigure):
+                plot_matplotlib(subplot, ax, layers=layers)
+            else:
+                subplot.plot_matplotlib(ax, layers=layers)
             # ax.set_title(f"Subplot ({row}, {col})")
             ax.grid()
 
@@ -304,6 +342,22 @@ class Canvas:
         self._matplotlib_axes = axes
         return fig, axes
 
+    def plot_tikzpics(
+        self,
+        savefig=None,
+        verbose=False,
+    ) -> TikzFigure:
+        if len(self.subplots) > 1:
+            raise NotImplementedError(
+                "Only one subplot is supported for tikzpics backend."
+            )
+        for (row, col), line_plot in self.subplots.items():
+            if verbose:
+                print(f"Plotting subplot at row {row}, col {col}")
+                print(f"{line_plot = }")
+            tikz_subplot = line_plot.plot_tikzpics(verbose=verbose)
+        return tikz_subplot
+
     def plot_plotly(self, show=True, savefig=None, usetex=False):
         """
         Generate and optionally display the subplots using Plotly.
@@ -313,7 +367,7 @@ class Canvas:
         savefig (str, optional): Filename to save the figure if provided.
         """
 
-        tex_fonts = plt_utils.setup_tex_fonts(
+        setup_tex_fonts(
             fontsize=self.fontsize,
             usetex=usetex,
         )  # adjust or redefine for Plotly if needed
@@ -322,7 +376,7 @@ class Canvas:
         if self._figsize is not None:
             fig_width, fig_height = self._figsize
         else:
-            fig_width, fig_height = plt_utils.set_size(
+            fig_width, fig_height = set_size(
                 width=self._width,
                 ratio=self._ratio,
             )
@@ -398,9 +452,6 @@ class Canvas:
         return self._subplot_matrix
 
     # Property setters
-    @nrows.setter
-    def dpi(self, value):
-        self._dpi = value
 
     @nrows.setter
     def nrows(self, value):
@@ -447,75 +498,140 @@ class Canvas:
             raise IndexError("Subplot index out of range")
         self._subplot_matrix[row][col] = value
 
-    # def generate_matplotlib_code(self):
-    #     """Generate code for plotting the data using matplotlib."""
-    #     code = "import matplotlib.pyplot as plt\n\n"
-    #     code += f"fig, axes = plt.subplots({self.nrows}, {self.ncols}, figsize={self.figsize})\n\n"
-    #     if self.nrows == 1 and self.ncols == 1:
-    #         code += "axes = [axes]  # Single subplot\n\n"
-    #     else:
-    #         code += "axes = axes.flatten()\n\n"
-    #     for idx, (subplot_idx, lines) in enumerate(self.subplots.items()):
-    #         code += f"# Subplot {subplot_idx}\n"
-    #         code += f"ax = axes[{idx}]\n"
-    #         for line in lines:
-    #             x_data = line['x']
-    #             y_data = line['y']
-    #             label = line['label']
-    #             kwargs = line.get('kwargs', {})
-    #             kwargs_str = ', '.join(f"{k}={repr(v)}" for k, v in kwargs.items())
-    #             code += f"ax.plot({x_data}, {y_data}, label={repr(label)}"
-    #             if kwargs_str:
-    #                 code += f", {kwargs_str}"
-    #             code += ")\n"
-    #         code += "ax.set_xlabel('X-axis')\n"
-    #         code += "ax.set_ylabel('Y-axis')\n"
-    #         if self.nrows * self.ncols > 1:
-    #             code += f"ax.set_title('Subplot {subplot_idx}')\n"
-    #         code += "ax.legend()\n\n"
-    #     code += "plt.tight_layout()\nplt.show()\n"
-    #     return code
-
-    # def generate_latex_plot(self):
-    #     """Generate LaTeX code for plotting the data using pgfplots in subplots."""
-    #     latex_code = "\\begin{figure}[h!]\n\\centering\n"
-    #     total_subplots = self.nrows * self.ncols
-    #     for idx in range(total_subplots):
-    #         subplot_idx = divmod(idx, self.ncols)
-    #         lines = self.subplots.get(subplot_idx, [])
-    #         if not lines:
-    #             continue  # Skip empty subplots
-    #         latex_code += "\\begin{subfigure}[b]{0.45\\textwidth}\n"
-    #         latex_code += "    \\begin{tikzpicture}\n"
-    #         latex_code += "        \\begin{axis}[\n"
-    #         latex_code += "            xlabel={X-axis},\n"
-    #         latex_code += "            ylabel={Y-axis},\n"
-    #         if self.nrows * self.ncols > 1:
-    #             latex_code += f"            title={{Subplot {subplot_idx}}},\n"
-    #         latex_code += "            legend style={at={(1.05,1)}, anchor=north west},\n"
-    #         latex_code += "            legend entries={" + ", ".join(f"{{{line['label']}}}" for line in lines) + "}\n"
-    #         latex_code += "        ]\n"
-    #         for line in lines:
-    #             options = []
-    #             kwargs = line.get('kwargs', {})
-    #             if 'color' in kwargs:
-    #                 options.append(f"color={kwargs['color']}")
-    #             if 'linestyle' in kwargs:
-    #                 linestyle_map = {'-': 'solid', '--': 'dashed', '-.': 'dash dot', ':': 'dotted'}
-    #                 linestyle = linestyle_map.get(kwargs['linestyle'], kwargs['linestyle'])
-    #                 options.append(f"style={linestyle}")
-    #             options_str = f"[{', '.join(options)}]" if options else ""
-    #             latex_code += f"        \\addplot {options_str} coordinates {{\n"
-    #             for x, y in zip(line['x'], line['y']):
-    #                 latex_code += f"            ({x}, {y})\n"
-    #             latex_code += "        };\n"
-    #         latex_code += "        \\end{axis}\n"
-    #         latex_code += "    \\end{tikzpicture}\n"
-    #         latex_code += "\\end{subfigure}\n"
-    #         latex_code += "\\hfill\n" if (idx + 1) % self.ncols != 0 else "\n"
-    #     latex_code += "\\caption{Multiple Subplots}\n"
-    #     latex_code += "\\end{figure}\n"
-    #     return latex_code
+
+def plot_matplotlib(tikzfigure: TikzFigure, ax, layers=None):
+    """
+    Plot all nodes and paths on the provided axis using Matplotlib.
+
+    Parameters:
+    - ax (matplotlib.axes.Axes): Axis on which to plot the figure.
+    """
+
+    # TODO: Specify which layers to retreive nodes from with layers=layers
+    nodes = tikzfigure.layers.get_nodes()
+    paths = tikzfigure.layers.get_paths()
+
+    for path in paths:
+        x_coords = [node.x for node in path.nodes]
+        y_coords = [node.y for node in path.nodes]
+
+        # Parse path color
+        path_color_spec = path.kwargs.get("color", "black")
+        try:
+            color = Color(path_color_spec).to_rgb()
+        except ValueError as e:
+            print(e)
+            color = "black"
+
+        # Parse line width
+        line_width_spec = path.kwargs.get("line_width", 1)
+        if isinstance(line_width_spec, str):
+            match = re.match(r"([\d.]+)(pt)?", line_width_spec)
+            if match:
+                line_width = float(match.group(1))
+            else:
+                print(
+                    f"Invalid line width specification: '{line_width_spec}', defaulting to 1",
+                )
+                line_width = 1
+        else:
+            line_width = float(line_width_spec)
+
+        # Parse line style using Linestyle class
+        style_spec = path.kwargs.get("style", "solid")
+        linestyle = Linestyle(style_spec).to_matplotlib()
+
+        ax.plot(
+            x_coords,
+            y_coords,
+            color=color,
+            linewidth=line_width,
+            linestyle=linestyle,
+            zorder=1,  # Lower z-order to place behind nodes
+        )
+
+    # Plot nodes after paths so they appear on top
+    for node in nodes:
+        # Determine shape and size
+        shape = node.kwargs.get("shape", "circle")
+        fill_color_spec = node.kwargs.get("fill", "white")
+        edge_color_spec = node.kwargs.get("draw", "black")
+        linewidth = float(node.kwargs.get("line_width", 1))
+        size = float(node.kwargs.get("size", 1))
+
+        # Parse colors using the Color class
+        try:
+            facecolor = Color(fill_color_spec).to_rgb()
+        except ValueError as e:
+            print(e)
+            facecolor = "white"
+
+        try:
+            edgecolor = Color(edge_color_spec).to_rgb()
+        except ValueError as e:
+            print(e)
+            edgecolor = "black"
+
+        # Plot shapes
+        if shape == "circle":
+            radius = size / 2
+            circle = patches.Circle(
+                (node.x, node.y),
+                radius,
+                facecolor=facecolor,
+                edgecolor=edgecolor,
+                linewidth=linewidth,
+                zorder=2,  # Higher z-order to place on top of paths
+            )
+            ax.add_patch(circle)
+        elif shape == "rectangle":
+            width = height = size
+            rect = patches.Rectangle(
+                (node.x - width / 2, node.y - height / 2),
+                width,
+                height,
+                facecolor=facecolor,
+                edgecolor=edgecolor,
+                linewidth=linewidth,
+                zorder=2,  # Higher z-order
+            )
+            ax.add_patch(rect)
+        else:
+            # Default to circle if shape is unknown
+            radius = size / 2
+            circle = patches.Circle(
+                (node.x, node.y),
+                radius,
+                facecolor=facecolor,
+                edgecolor=edgecolor,
+                linewidth=linewidth,
+                zorder=2,
+            )
+            ax.add_patch(circle)
+
+        # Add text inside the shape
+        if node.content:
+            ax.text(
+                node.x,
+                node.y,
+                node.content,
+                fontsize=10,
+                ha="center",
+                va="center",
+                wrap=True,
+                zorder=3,  # Even higher z-order for text
+            )
+
+    # Remove axes, ticks, and legend
+    ax.axis("off")
+
+    # Adjust plot limits
+    all_x = [node.x for node in nodes]
+    all_y = [node.y for node in nodes]
+    padding = 1  # Adjust padding as needed
+    ax.set_xlim(min(all_x) - padding, max(all_x) + padding)
+    ax.set_ylim(min(all_y) - padding, max(all_y) + padding)
+    ax.set_aspect("equal", adjustable="datalim")
 
 
 if __name__ == "__main__":

{maxplotlibx-0.1 → maxplotlibx-0.1.2}/src/maxplotlib/colors/colors.py

@@ -1,7 +1,6 @@
 import re
 
 import matplotlib.colors as mcolors
-import matplotlib.patches as patches
 import numpy as np