mpl-spaceplot 0.1.1__tar.gz

mpl_spaceplot-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Florian Raths
+
+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.

mpl_spaceplot-0.1.1/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: mpl-spaceplot
+Version: 0.1.1
+Summary: layout wrappers for matplotlib
+Author-email: Florian Raths <raths.f@gmail.com>
+License: MIT
+Keywords: matplotlib,plotting,wrappers
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib>=3.7
+Requires-Dist: cmcrameri>=1.9
+Dynamic: license-file
+
+# spaceplot

mpl_spaceplot-0.1.1/README.md

@@ -0,0 +1 @@
+# spaceplot

mpl_spaceplot-0.1.1/pyproject.toml

@@ -0,0 +1,50 @@
+# [build-system]
+# requires = ["uv_build"]
+# build-backend = "uv_build"
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mpl-spaceplot"
+version = "0.1.1"
+description = "layout wrappers for matplotlib"
+keywords = ["matplotlib", "plotting", "wrappers"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+authors = [{ name = "Florian Raths", email = "raths.f@gmail.com" }]
+license = { text = "MIT" }
+readme = "README.md"
+
+requires-python = ">=3.10"
+
+dependencies = ["matplotlib >= 3.7", "cmcrameri >= 1.9"]
+
+[dependency-groups]
+dev = [
+    "ipykernel >= 6.30.1",
+    "ipywidgets >= 8.1.7",
+    "pre-commit >= 4.3.0",
+    "ruff == 0.13.1",
+    "jupytext>=1.18.0",
+]
+docs = ["mkdocs ~= 1.6", "mkdocs-material ~= 9.6"]
+
+[tool.uv]
+required-version = ">=0.7.0"
+default-groups = ["dev", "docs"]
+
+
+[tool.uv-ship]
+release-branch = "main"
+allow-dirty = false
+
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["spaceplot*"]

mpl_spaceplot-0.1.1/setup.cfg

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

mpl_spaceplot-0.1.1/src/mpl_spaceplot.egg-info/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: mpl-spaceplot
+Version: 0.1.1
+Summary: layout wrappers for matplotlib
+Author-email: Florian Raths <raths.f@gmail.com>
+License: MIT
+Keywords: matplotlib,plotting,wrappers
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib>=3.7
+Requires-Dist: cmcrameri>=1.9
+Dynamic: license-file
+
+# spaceplot

mpl_spaceplot-0.1.1/src/mpl_spaceplot.egg-info/SOURCES.txt

@@ -0,0 +1,27 @@
+LICENSE
+README.md
+pyproject.toml
+src/mpl_spaceplot.egg-info/PKG-INFO
+src/mpl_spaceplot.egg-info/SOURCES.txt
+src/mpl_spaceplot.egg-info/dependency_links.txt
+src/mpl_spaceplot.egg-info/requires.txt
+src/mpl_spaceplot.egg-info/top_level.txt
+src/spaceplot/__init__.py
+src/spaceplot/aligner.py
+src/spaceplot/montage_plot.py
+src/spaceplot/simulate_data.py
+src/spaceplot/utils.py
+src/spaceplot/appearance/__init__.py
+src/spaceplot/appearance/display.py
+src/spaceplot/appearance/inline.py
+src/spaceplot/appearance/layout.py
+src/spaceplot/appearance/palettes.py
+src/spaceplot/appearance/styles.py
+src/spaceplot/appearance/tools.py
+src/spaceplot/decorators/__init__.py
+src/spaceplot/decorators/decorators.py
+src/spaceplot/decorators/tools.py
+src/spaceplot/plotting/__init__.py
+src/spaceplot/plotting/plotting.py
+src/spaceplot/plotting/tools.py
+src/spaceplot/resources/font_loader.py

mpl_spaceplot-0.1.1/src/mpl_spaceplot.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mpl_spaceplot-0.1.1/src/mpl_spaceplot.egg-info/requires.txt

@@ -0,0 +1,2 @@
+matplotlib>=3.7
+cmcrameri>=1.9

mpl_spaceplot-0.1.1/src/mpl_spaceplot.egg-info/top_level.txt

@@ -0,0 +1 @@
+spaceplot

mpl_spaceplot-0.1.1/src/spaceplot/__init__.py

@@ -0,0 +1,25 @@
+import matplotlib.pyplot as plt
+
+from . import aligner
+from . import decorators as decs
+from . import utils as ut
+from .appearance import palettes as plts
+from .appearance.display import Theme, display
+from .appearance.layout import layout
+from .montage_plot import montage_plot
+from .plotting import plt_category, plt_continous, plt_image
+
+__all__ = [
+    'aligner',
+    'decs',
+    'ut',
+    'plts',
+    'Theme',
+    'display',
+    'layout',
+    'montage_plot',
+    'plt_category',
+    'plt_continous',
+    'plt_image',
+    'plt',
+]

mpl_spaceplot-0.1.1/src/spaceplot/aligner.py

@@ -0,0 +1,112 @@
+from typing import Literal
+
+import numpy as np
+
+aligns = Literal[
+    'top_left',
+    'top_right',
+    'bottom_left',
+    'bottom_right',
+    'center_left',
+    'center_right',
+    'center_top',
+    'center_bottom',
+]
+
+align_map = {
+    'c': 0.5,
+    'l': 0,
+    'r': 1,
+    'b': 0,
+    't': 1,
+}
+
+align_full_names = {
+    'c': 'center',
+    'l': 'left',
+    'r': 'right',
+    'b': 'bottom',
+    't': 'top',
+}
+
+
+def translate_align(how: aligns, format: str = 'frac', xfact: float = None, yfact: float = None) -> tuple[float, float]:
+    if how is None and (xfact is None or yfact is None):
+        raise ValueError("Either 'how' must be provided or both 'xfact' and 'yfact' must be specified.")
+
+    if how is not None:
+        x_a, y_a = parse_alignment(how)
+    else:
+        x_a, y_a = 'c', 'c'
+
+    x = xfact if xfact else align_map[x_a]
+    y = yfact if yfact else align_map[y_a]
+
+    if format == 'name':
+        x = align_full_names[x_a] if xfact is None else xfact
+        y = align_full_names[y_a] if yfact is None else yfact
+
+    return x, y
+
+
+def parse_alignment(inpt: aligns) -> tuple[aligns, aligns]:
+    """reutrns a tuple of (x, y) alignment based on the input string."""
+
+    def get_inpt_type(inpt):
+        if inpt in ['l', 'r']:
+            inpt_type = 'horizontal'
+        elif inpt in ['t', 'b']:
+            inpt_type = 'vertical'
+        else:
+            inpt_type = 'centered'
+        return inpt_type
+
+    if len(inpt) > 2:
+        if '_' in inpt:
+            parts = inpt.split('_')
+
+            if len(parts) == 2:
+                inpt = parts[0][0] + parts[1][0]
+            else:
+                raise ValueError('Input must be a two-part string separated by an underscore.')
+        else:
+            inpt = inpt[0]
+
+    x = y = None
+    if len(inpt) == 1:
+        in_type = get_inpt_type(inpt)
+        if in_type == 'horizontal':
+            x, y = inpt, 'c'
+        elif in_type == 'vertical':
+            x, y = 'c', inpt
+        else:
+            x = y = 'c'
+
+    elif len(inpt) == 2:
+        in_type_a = get_inpt_type(inpt[0])
+        in_type_b = get_inpt_type(inpt[1])
+
+        types = np.array([in_type_a, in_type_b])
+
+        if in_type_a == in_type_b:
+            raise ValueError('Both inputs cannot be of the same kind.')
+
+        h_idx = np.where(types == 'horizontal')[0]
+        v_idx = np.where(types == 'vertical')[0]
+
+        if len(h_idx) == 0:
+            x = 'c'
+        elif len(h_idx) == 1:
+            x = inpt[h_idx[0]]
+        else:
+            raise ValueError('More than one horizontal input provided.')
+        if len(v_idx) == 0:
+            y = 'c'
+        elif len(v_idx) == 1:
+            y = inpt[v_idx[0]]
+        else:
+            raise ValueError('More than one vertical input provided.')
+    else:
+        raise ValueError('Input must be a single character or a two-character string.')
+
+    return x, y

mpl_spaceplot-0.1.1/src/spaceplot/appearance/__init__.py

@@ -0,0 +1,8 @@
+import importlib.resources as resources
+
+from ..resources.font_loader import register_fonts
+
+# register fonts supplied with package
+path = resources.files('spaceplot.resources.fonts')
+for cont in path.iterdir():
+    register_fonts(cont)

mpl_spaceplot-0.1.1/src/spaceplot/appearance/display.py

@@ -0,0 +1,178 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+import matplotlib.pyplot as plt
+
+from .. import utils
+from . import inline, styles, tools
+
+
+def display(
+    theme: str | Theme = 'default',
+    **kwargs,
+):
+    theme = Theme(source_theme=theme, **kwargs) if isinstance(theme, str) else theme
+    theme.apply()
+
+
+@dataclass
+class Theme:
+    source_theme: str = None
+    explicit_rcParams: dict = None
+    retina: bool = False
+    transparent: bool = False
+    figsize: tuple[float, float] = None
+    dpi: int = None
+    palette: list[str] = None
+    cmap: str = None
+    text_color: str = None
+    line_color: str = None
+    ticks: list[str] = None
+    minor_visible: bool = None
+    spines: bool = None
+    margins: float = None
+    grid: bool = None
+    grid_color: str = None
+    grid_alpha: float = None
+    grid_linestyle: str = None
+    grid_linewidth: float = None
+    tick_linewidth: tuple[float, float] = (None, None)
+    tick_pad: tuple[float, float] = (None, None)
+    spine_linewidth: float = None
+    tick_size: tuple[float, float] = (None, None)
+    font_family: str = None
+    font_size: int = None
+    fig_facecolor: str = None
+    axes_facecolor: str = None
+    labelsize: dict = field(default_factory=lambda: {'axes': None, 'figure': None, 'ticks': None})
+    titlesize: dict = field(default_factory=lambda: {'axes': None, 'figure': None})
+    titleweight: dict = field(default_factory=lambda: {'axes': None, 'figure': None})
+    labelweight: dict = field(default_factory=lambda: {'axes': None, 'figure': None})
+    axes_labelpad: float = None
+    axes_titlepad: float = None
+    inline_config: dict = field(default_factory=dict)
+
+    def parse_source_theme(self):
+        if isinstance(self.source_theme, str):
+            base_theme = styles.themes.get(self.source_theme, {})
+            return Theme(source_theme=base_theme)
+
+        elif isinstance(self.source_theme, dict):
+            return Theme(**self.source_theme)
+
+        else:
+            return self.source_theme
+
+    def reset_defaults(self):
+        plt.rcdefaults()
+
+    @property
+    def rcDict(self):
+        from cycler import cycler
+
+        tick_unset_val = None if self.ticks is None else False
+        tick_t, tick_b, tick_l, tick_r = tools.set_position(positions=self.ticks, unset_value=tick_unset_val)
+
+        spine_unset_val = None if self.spines is None else False
+        spine_t, spine_b, spine_l, spine_r = tools.set_position(positions=self.spines, unset_value=spine_unset_val)
+
+        prop_cycle = None if self.palette is None else cycler('color', self.palette)
+
+        rc_dict = {
+            key: value
+            for key, value in {
+                'figure.figsize': self.figsize,
+                'figure.dpi': self.dpi,
+                'axes.prop_cycle': prop_cycle,
+                'image.cmap': self.cmap,
+                'xtick.color': self.line_color,
+                'ytick.color': self.line_color,
+                'axes.grid': self.grid,
+                'axes3d.grid': self.grid,
+                'polaraxes.grid': self.grid,
+                'grid.alpha': self.grid_alpha,
+                'grid.color': self.grid_color,
+                'grid.linestyle': self.grid_linestyle,
+                'grid.linewidth': self.grid_linewidth,
+                'text.color': self.text_color,
+                'axes.labelcolor': self.text_color,
+                'axes.titlecolor': self.text_color,
+                'ytick.labelcolor': self.text_color,
+                'xtick.labelcolor': self.text_color,
+                'axes.edgecolor': self.line_color,
+                'axes.facecolor': self.axes_facecolor,
+                'figure.facecolor': self.fig_facecolor,
+                'font.family': self.font_family,
+                'font.size': self.font_size,
+                'figure.titlesize': self.titlesize.get('figure', None),
+                'axes.titlesize': self.titlesize.get('axes', None),
+                'figure.titleweight': self.titleweight.get('figure', None),
+                'axes.titleweight': self.titleweight.get('axes', None),
+                'figure.labelsize': self.labelsize.get('figure', None),
+                'axes.labelsize': self.labelsize.get('axes', None),
+                'xtick.labelsize': self.labelsize.get('ticks', None),
+                'ytick.labelsize': self.labelsize.get('ticks', None),
+                'axes.labelpad': self.axes_labelpad,
+                'axes.titlepad': self.axes_titlepad,
+                'figure.labelweight': self.labelweight.get('figure', None),
+                'axes.labelweight': self.labelweight.get('axes', None),
+                'axes.linewidth': self.spine_linewidth,
+                'axes.xmargin': self.margins,
+                'axes.ymargin': self.margins,
+                'axes.zmargin': self.margins,
+                'axes.spines.top': spine_t,
+                'axes.spines.bottom': spine_b,
+                'axes.spines.left': spine_l,
+                'axes.spines.right': spine_r,
+                'xtick.top': tick_t,
+                'xtick.bottom': tick_b,
+                'ytick.left': tick_l,
+                'ytick.right': tick_r,
+                'ytick.major.left': tick_l,
+                'ytick.major.right': tick_r,
+                'xtick.major.top': tick_t,
+                'xtick.major.bottom': tick_b,
+                'ytick.minor.left': tick_l,
+                'ytick.minor.right': tick_r,
+                'xtick.minor.top': tick_t,
+                'xtick.minor.bottom': tick_b,
+                'ytick.labelleft': tick_l,
+                'ytick.labelright': tick_r,
+                'xtick.labeltop': tick_t,
+                'xtick.labelbottom': tick_b,
+                'xtick.major.pad': utils.maj_min_args(self.tick_pad)[0],
+                'xtick.minor.pad': utils.maj_min_args(self.tick_pad)[1],
+                'ytick.major.pad': utils.maj_min_args(self.tick_pad)[0],
+                'ytick.minor.pad': utils.maj_min_args(self.tick_pad)[1],
+                'xtick.major.size': utils.maj_min_args(self.tick_size)[0],
+                'xtick.minor.size': utils.maj_min_args(self.tick_size)[1],
+                'ytick.major.size': utils.maj_min_args(self.tick_size)[0],
+                'ytick.minor.size': utils.maj_min_args(self.tick_size)[1],
+                'xtick.major.width': utils.maj_min_args(self.tick_linewidth)[0],
+                'xtick.minor.width': utils.maj_min_args(self.tick_linewidth)[1],
+                'ytick.major.width': utils.maj_min_args(self.tick_linewidth)[0],
+                'ytick.minor.width': utils.maj_min_args(self.tick_linewidth)[1],
+                'ytick.minor.visible': self.minor_visible,
+                'xtick.minor.visible': self.minor_visible,
+            }.items()
+            if value is not None
+        }
+
+        if self.explicit_rcParams is not None:
+            rc_dict.update(self.explicit_rcParams)
+
+        if self.source_theme is not None:
+            source = self.parse_source_theme()
+            rc_dict = {**source.rcDict, **rc_dict}
+
+        return rc_dict
+
+    def apply(self):
+        if self.source_theme == 'default':
+            print('Theme: resetting to matplotlib defaults')
+            plt.rcdefaults()
+
+        plt.rcParams.update(self.rcDict)
+
+        inline.inline_config(retina=self.retina, transparent=self.transparent, **self.inline_config)

mpl_spaceplot-0.1.1/src/spaceplot/appearance/inline.py

@@ -0,0 +1,45 @@
+import matplotlib_inline.backend_inline as mpl_inline
+from matplotlib import rcParams
+
+rc_mapping = {
+    'dpi': 'figure.dpi',
+    'pad_inches': 'savefig.pad_inches',
+    'facecolor': 'figure.facecolor',
+    'bbox_inches': 'savefig.bbox',
+}
+
+
+def from_rc(key):
+    return rcParams[rc_mapping[key]] if key in rc_mapping else None
+
+
+def inline_config(
+    retina: bool = None,
+    facecolor: str = 'rc',
+    dpi: int | str = 'rc',
+    pad_inches: float | str = 'rc',
+    bbox_inches: float | str = 'tight',
+    transparent: bool = False,
+    **kwargs,
+):
+    dpi = from_rc('dpi') if dpi == 'rc' else dpi
+    pad_inches = from_rc('pad_inches') if pad_inches == 'rc' else pad_inches
+    bbox_inches = from_rc('bbox_inches') if bbox_inches == 'rc' else bbox_inches
+    facecolor = from_rc('facecolor') if facecolor == 'rc' else facecolor
+
+    facecolor = 'none' if transparent else facecolor
+
+    if retina:
+        inl_format = 'retina'
+        dpi = dpi * 2
+    else:
+        inl_format = 'png'
+
+    mpl_inline.set_matplotlib_formats(
+        inl_format,
+        facecolor=facecolor,
+        bbox_inches=bbox_inches,
+        dpi=dpi,
+        pad_inches=pad_inches,
+        **kwargs,
+    )