maxplotlibx 0.1__tar.gz

maxplotlibx-0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Max
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

maxplotlibx-0.1/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: maxplotlibx
+Version: 0.1
+Summary: A reproducible plotting module with various backends and export options.
+Author: Max
+Project-URL: Source, https://github.com/max-models/maxplotlib
+Keywords: matplotlib
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib
+Requires-Dist: pint
+Requires-Dist: plotly
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: coverage; extra == "test"
+Provides-Extra: docs
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Requires-Dist: ipykernel; extra == "docs"
+Requires-Dist: nbconvert; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: maxplotlibx[docs,test]; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: jupyterlab; extra == "dev"
+Requires-Dist: nbstripout; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pyproject-fmt; extra == "dev"
+Dynamic: license-file
+
+# maxplotlib
+
+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
+
+```
+python -m venv env
+source env/bin/activate
+pip install --upgrade pip
+```
+
+Install the code and requirements with pip
+
+```
+pip install -e .
+```
+
+Additional dependencies for developers can be installed with
+
+```
+pip install -e ".[dev]"
+```
+
+Some examples can be found in `tutorials/`

maxplotlibx-0.1/README.md

@@ -0,0 +1,29 @@
+# maxplotlib
+
+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
+
+```
+python -m venv env
+source env/bin/activate
+pip install --upgrade pip
+```
+
+Install the code and requirements with pip
+
+```
+pip install -e .
+```
+
+Additional dependencies for developers can be installed with
+
+```
+pip install -e ".[dev]"
+```
+
+Some examples can be found in `tutorials/`

maxplotlibx-0.1/pyproject.toml

@@ -0,0 +1,49 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "maxplotlibx"
+version = "0.1"
+description = "A reproducible plotting module with various backends and export options."
+readme = "README.md"
+requires-python = ">=3.8"
+license = {file = "LICENSE.txt"}
+keywords = ["matplotlib"]
+authors = [{name = "Max"}]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+]
+dependencies = [
+    "matplotlib",
+    "pint",
+    "plotly",
+]
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "coverage",
+]
+docs = [
+    "myst-parser",
+    "sphinx",
+    "sphinx-rtd-theme",
+    "nbsphinx",
+    "ipykernel",
+    "nbconvert",
+]
+dev = [
+    "maxplotlibx[test,docs]",
+    "ruff",
+    "black",
+    "isort",
+    "jupyterlab",
+    "nbstripout",
+    "pre-commit",
+    "pyproject-fmt",
+]
+[project.urls]
+"Source" = "https://github.com/max-models/maxplotlib"
+
+[tool.setuptools.packages.find]
+where = ["src"]

maxplotlibx-0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

maxplotlibx-0.1/src/maxplotlib/__init__.py

@@ -0,0 +1,3 @@
+from maxplotlib.canvas.canvas import Canvas
+
+__all__ = ["Canvas"]

maxplotlibx-0.1/src/maxplotlib/backends/matplotlib/utils.py

@@ -0,0 +1,136 @@
+# 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):
+    """
+    Sets up LaTeX fonts for plotting.
+    """
+    tex_fonts = {
+        "text.usetex": usetex,
+        "font.family": "serif",
+        "pgf.rcfonts": False,
+        "axes.labelsize": fontsize,
+        "font.size": fontsize,
+        "legend.fontsize": fontsize,
+        "xtick.labelsize": fontsize,
+        "ytick.labelsize": fontsize,
+    }
+    plt.rcParams.update(tex_fonts)
+    return tex_fonts
+
+
+def setup_plotstyle(
+    tex_fonts=None,
+    axes_grid=False,
+    axes_grid_which="major",
+    grid_alpha=1.0,
+    grid_linestyle="dotted",
+):
+    """
+    Configures the plot style.
+    """
+    if tex_fonts:
+        plt.rcParams.update(tex_fonts)
+    plt.rcParams["axes.grid"] = axes_grid
+    plt.rcParams["axes.grid.which"] = axes_grid_which
+    plt.rcParams["grid.alpha"] = grid_alpha
+    plt.rcParams["grid.linestyle"] = grid_linestyle
+    plt.rcParams["xtick.direction"] = "in"
+    plt.rcParams["ytick.direction"] = "in"
+    plt.rcParams["xtick.major.pad"] = 8
+    plt.rcParams["ytick.major.pad"] = 8
+
+
+# TODO: Use the other unit package
+# Create a UnitRegistry
+ureg = pint.UnitRegistry()
+
+
+def convert_to_inches(length_str):
+    quantity = ureg(length_str)  # Parse the input string
+    return quantity.to("inch").magnitude  # Convert to inches
+
+
+def _2pt(width, dpi=300):
+    if isinstance(width, (int, float)):
+        return width
+    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
+
+
+def set_size(width, fraction=1, ratio="golden", dpi=300):
+    """
+    Sets figure dimensions to avoid scaling in LaTeX.
+    """
+    if width == "thesis":
+        width_pt = 426.79135
+    elif width == "beamer":
+        width_pt = 307.28987
+    else:
+        width_pt = _2pt(width=width, dpi=dpi)
+
+    fig_width_pt = width_pt * fraction
+    # inches_per_pt = 1 / 72.27
+
+    # Calculate the figure height based on the desired ratio
+    if ratio == "golden":
+        golden_ratio = (5**0.5 - 1) / 2
+        fig_height_pt = fig_width_pt * golden_ratio
+    elif ratio == "square":
+        fig_height_pt = fig_width_pt
+    elif isinstance(ratio, (int, float)):
+        fig_height_pt = fig_width_pt * ratio
+    else:
+        raise ValueError("Invalid ratio specified.")
+    fig_dim = (fig_width_pt, fig_height_pt)
+    return fig_dim
+
+
+def create_lineplot(
+    nx_subplots=1,
+    ny_subplots=1,
+    width=426.79135,
+    figsize=None,
+    dpi=300,
+    ratio="golden",
+    gridspec_kw=None,
+):
+    """
+    Creates a line plot figure and axes.
+    """
+    if figsize is not None:
+        fig_width, fig_height = figsize
+    else:
+        fig_width, fig_height = set_size(width, ratio=ratio)
+
+    if gridspec_kw is None:
+        gridspec_kw = {"wspace": 0.08, "hspace": 0.1}
+
+    fig, axs = plt.subplots(
+        ny_subplots,
+        nx_subplots,
+        figsize=(fig_width, fig_height),
+        dpi=dpi,
+        constrained_layout=False,
+        gridspec_kw=gridspec_kw,
+    )
+    return fig, axs