mpl-spaceplot 0.3.0__tar.gz → 0.3.1__tar.gz

{mpl_spaceplot-0.3.0/src/mpl_spaceplot.egg-info → mpl_spaceplot-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mpl-spaceplot
-Version: 0.3.0
+Version: 0.3.1
 Summary: layout wrappers for matplotlib
 Author-email: Florian Raths <raths.f@gmail.com>
 License: MIT

{mpl_spaceplot-0.3.0 → mpl_spaceplot-0.3.1}/pyproject.toml

@@ -19,7 +19,7 @@ include-package-data = true
 
 [project]
 name = "mpl-spaceplot"
-version = "0.3.0"
+version = "0.3.1"
 description = "layout wrappers for matplotlib"
 keywords = ["matplotlib", "plotting", "wrappers"]
 classifiers = [
@@ -43,9 +43,7 @@ dependencies = [
 dev = [
     "ipykernel >= 6.30.1",
     "ipywidgets >= 8.1.7",
-    "ruff == 0.13.1",
     "jupytext >= 1.18.0",
-    "prek >= 0.2.10",
 ]
 docs = ["mkdocs ~= 1.6", "mkdocs-material ~= 9.6"]
 

{mpl_spaceplot-0.3.0 → mpl_spaceplot-0.3.1/src/mpl_spaceplot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mpl-spaceplot
-Version: 0.3.0
+Version: 0.3.1
 Summary: layout wrappers for matplotlib
 Author-email: Florian Raths <raths.f@gmail.com>
 License: MIT

{mpl_spaceplot-0.3.0 → mpl_spaceplot-0.3.1}/src/mpl_spaceplot.egg-info/SOURCES.txt

@@ -12,7 +12,6 @@ src/spaceplot/montage_plot.py
 src/spaceplot/simulate_data.py
 src/spaceplot/utils.py
 src/spaceplot/appearance/__init__.py
-src/spaceplot/appearance/_layout.py
 src/spaceplot/appearance/display.py
 src/spaceplot/appearance/inline.py
 src/spaceplot/appearance/layout.py

{mpl_spaceplot-0.3.0 → mpl_spaceplot-0.3.1}/src/spaceplot/__init__.py

@@ -9,6 +9,11 @@ from .appearance.layout import layout
 from .montage_plot import montage_plot
 from .plotting import plt_category, plt_continous
 
+
+def show():
+    plt.show()
+
+
 __all__ = [
     'aligner',
     'decs',

{mpl_spaceplot-0.3.0 → mpl_spaceplot-0.3.1}/src/spaceplot/appearance/display.py

@@ -8,10 +8,7 @@ from .. import utils
 from . import inline, styles, tools
 
 
-def display(
-    theme: str | Theme = 'default',
-    **kwargs,
-):
+def display(theme: str | Theme = 'dark', **kwargs):
     theme = Theme(source_theme=theme, **kwargs) if isinstance(theme, str) else theme
     theme.apply()
 

{mpl_spaceplot-0.3.0 → mpl_spaceplot-0.3.1}/src/spaceplot/montage_plot.py

@@ -4,6 +4,8 @@ import numpy as np
 from matplotlib import gridspec
 from matplotlib.pyplot import figure
 
+from .appearance.layout import layout as splayout
+
 
 def montage_plot(
     n_plots: int = None,
@@ -27,7 +29,8 @@ def montage_plot(
     w_ratios = np.ones(n_cols) if w_ratios is None else np.array(w_ratios)
     h_ratios = np.ones(n_rows) if h_ratios is None else np.array(h_ratios)
 
-    figsize = calculate_figure_size(design, ref_panel, panel_size, w_ratios, h_ratios)
+    if figsize is None:
+        figsize = calculate_figure_size(design, ref_panel, panel_size, w_ratios, h_ratios)
 
     fig = figure(figsize=figsize, layout=layout)
     fig.suptitle(title)
@@ -46,8 +49,8 @@ def montage_plot(
     axes_list, labels, axes_by_label = get_plot_layout(design, grid)
     axs = Axs(axes_list)
 
-    if len(axs) == 1:
-        return axs[0]
+    # if len(axs) == 1:
+    #     return axs[0]
 
     return axs
 
@@ -132,6 +135,9 @@ class Axs(Sequence):
         for ax in self._axes:
             setattr(ax, name, value)
 
+    def layout(self, **kwargs):
+        splayout(self._axes, **kwargs)
+
 
 def _build_design(n_plots, n_rows, n_cols):
     n_rows, n_cols = int(n_rows), int(n_cols)

{mpl_spaceplot-0.3.0 → mpl_spaceplot-0.3.1}/src/spaceplot/utils.py

@@ -34,59 +34,59 @@ allowed_params = {
     ],
     'abc_': ['style', 'size', 'loc', 'box', 'pad', 'label_pos'],
     'grid_': [
-        'color',
-        'alpha',
-        'linestyle',
-        'linewidth',
-        'dashes',
-        'dash_capstyle',
-        'dash_joinstyle',
-        'clip_box',
-        'clip_on',
-        'clip_path',
-        'data',
-        'drawstyle',
-        'figure',
-        'fillstyle',
-        'gapcolor',
-        'gid',
-        'in_layout',
-        'label',
-        'marker',
-        'markeredgecolor',
-        'markeredgewidth',
-        'markerfacecolor',
-        'markerfacecoloralt',
-        'markersize',
-        'markevery',
-        'mouseover',
-        'path_effects',
-        'picker',
-        'pickradius',
-        'rasterized',
-        'sketch_params',
-        'snap',
-        'solid_capstyle',
-        'solid_joinstyle',
-        'transform',
-        'url',
-        'visible',
-        'xdata',
-        'ydata',
-        'zorder',
-        'aa',
-        'c',
-        'ds',
-        'ls',
-        'lw',
-        'mec',
-        'mew',
-        'mfc',
-        'mfcalt',
-        'ms',
-        'agg_filter',
-        'animated',
-        'antialiased',
+        'grid_color',
+        'grid_alpha',
+        'grid_linestyle',
+        'grid_linewidth',
+        'grid_dashes',
+        'grid_dash_capstyle',
+        'grid_dash_joinstyle',
+        'grid_clip_box',
+        'grid_clip_on',
+        'grid_clip_path',
+        'grid_data',
+        'grid_drawstyle',
+        'grid_figure',
+        'grid_fillstyle',
+        'grid_gapcolor',
+        'grid_gid',
+        'grid_in_layout',
+        'grid_label',
+        'grid_marker',
+        'grid_markeredgecolor',
+        'grid_markeredgewidth',
+        'grid_markerfacecolor',
+        'grid_markerfacecoloralt',
+        'grid_markersize',
+        'grid_markevery',
+        'grid_mouseover',
+        'grid_path_effects',
+        'grid_picker',
+        'grid_pickradius',
+        'grid_rasterized',
+        'grid_sketch_params',
+        'grid_snap',
+        'grid_solid_capstyle',
+        'grid_solid_joinstyle',
+        'grid_transform',
+        'grid_url',
+        'grid_visible',
+        'grid_xdata',
+        'grid_ydata',
+        'grid_zorder',
+        'grid_aa',
+        'grid_c',
+        'grid_ds',
+        'grid_ls',
+        'grid_lw',
+        'grid_mec',
+        'grid_mew',
+        'grid_mfc',
+        'grid_mfcalt',
+        'grid_ms',
+        'grid_agg_filter',
+        'grid_animated',
+        'grid_antialiased',
     ],
 }
 

mpl_spaceplot-0.3.0/src/spaceplot/appearance/_layout.py

@@ -1,236 +0,0 @@
-from collections.abc import Iterable
-from itertools import cycle
-
-import numpy as np
-
-from .. import decorators as decs
-from .. import utils
-from . import tools
-
-major_grid_style = 'solid'
-minor_grid_style = (0, (1, 2))
-
-
-def layout(
-    axs,
-    *,
-    axis: str = 'both',
-    title: str | list = None,
-    x_label: str = None,
-    y_label: str = None,
-    abc: str | bool = None,
-    make_square: bool = None,
-    margins: float = None,
-    aspect: str | float | tuple = None,
-    ticks: tools._tick_vis = None,
-    grid: tools._grid_vis = None,
-    minor: bool = None,
-    spines: tools._tick_vis = None,
-    x_breaks: list[float] = None,
-    y_breaks: list[float] = None,
-    x_lims: list[float] = None,
-    y_lims: list[float] = None,
-    x_scale: str = None,
-    y_scale: str = None,
-    x_tick_labels: list[str] = None,
-    y_tick_labels: list[str] = None,
-    **kwargs,
-):
-    # decompose kwargs into title, label, tick, and grid settings
-    title_settings = utils.get_hook_dict(kwargs, 'title', remove_hook=True)
-    label_settings = utils.get_hook_dict(kwargs, 'label', remove_hook=True)
-
-    tick_settings = utils.get_hook_dict(kwargs, 'tick', remove_hook=True)
-    grid_settings = utils.get_hook_dict(kwargs, 'grid', remove_hook=False)
-    tick_settings.update(grid_settings)
-
-    # ensure axs is a list
-    if not isinstance(axs, Iterable):
-        axs = [axs]
-    if not isinstance(title, list):
-        title = [title]
-
-    handle_abc_labels(axs, abc, **kwargs)
-
-    pairs = list(zip(axs, cycle(title)))
-
-    for ax, title in pairs:
-        # handle ticks, grid, and spine visibility
-        # NOTE when axis != 'both', ticks=True does weird things... seems to be a matplotlib issue
-        handle_tick_settings(ax, axis, ticks, minor, grid, tick_settings)
-
-        # handle other layout elements
-        handle_title(ax, title, title_settings)
-        handle_labels(ax, axis, x_label, y_label, label_settings)
-        handle_tick_labels(ax, x_tick_labels, y_tick_labels)
-
-        handle_spines(ax, spines)
-        handle_breaks(ax, x_breaks, y_breaks)
-        handle_scales(ax, x_scale, y_scale)
-        handle_lims(ax, x_lims, y_lims)
-
-        handle_aspect(ax, aspect)
-
-        # TODO when x_lim/y_lim are set, margins don't work as expected
-        handle_margins(ax, margins, make_square)
-
-        if make_square is True:
-            tools.axis_ratio(ax, yx_ratio=1, margins=margins, how='lims')
-
-
-def handle_abc_labels(axs, abc=None, **kwargs):
-    if abc:
-        ax_labels = np.arange(1, len(axs) + 1)
-        if abc == 'ABC':
-            ax_labels = [chr(64 + num) for num in ax_labels]
-        elif abc == 'abc':
-            ax_labels = [chr(96 + num) for num in ax_labels]
-
-        abc_params = utils.get_hook_dict(kwargs, 'abc')
-        abc_params['loc'] = abc_params['loc'] if 'loc' in abc_params else 'tl'
-        abc_params['size'] = abc_params['size'] if 'size' in abc_params else 18
-        for i, ax in enumerate(axs):
-            decs.place_abc_label(
-                ax,
-                label=ax_labels[i],
-                **abc_params,
-            )
-
-
-def handle_tick_grid_vis(ax, axis, ticks, minor, grid, tick_settings):
-    tools.set_minor_ticks_by_axis(ax, axis=axis)
-    minor = False if minor is None else minor
-
-    tools.set_tick_visibility(ax, axis=axis, ticks=ticks, minor=minor)
-
-    # set axis below if no grid zorder is specified to make sure grid lines are below other plot elements
-    ax_below = False if 'grid_zorder' in tick_settings else True
-    ax.set_axisbelow(ax_below)
-
-    maj_grid, min_grid = tools.set_grid_visibility(ax, axis=axis, grid=grid, minor=minor, apply=False)
-    tick_settings['gridOn'] = [maj_grid, min_grid]
-
-    # Set default grid style, since rcParams don't offer minor grid style
-    if 'grid_linestyle' not in tick_settings:
-        tick_settings['grid_linestyle'] = [major_grid_style, minor_grid_style]
-
-
-def handle_text_element(getter, setter, text: str = None, params: dict = {}):
-    """Generic helper to get current text if needed and set it with params."""
-    if text is None and len(params) == 0:
-        return
-
-    if text is None and len(params) > 0:
-        text = getter()
-
-    setter(text, **params)
-
-
-def handle_tick_settings(ax, axis, ticks, minor, grid, tick_settings):
-    if ticks is None and minor is None and grid is None and len(tick_settings) == 0:
-        return
-
-    # first all the visibility settings
-    handle_tick_grid_vis(ax, axis, ticks, minor, grid, tick_settings)
-
-    # tick (and grid) settings are applied separately for major and minor ticks
-    majmin_settings = {k: utils.maj_min_args(maj_min=v) for k, v in tick_settings.items()}
-
-    for i, which in enumerate(['major', 'minor']):
-        tick_settings_select = {k: v[i] for k, v in majmin_settings.items()}
-        ax.tick_params(axis=axis, which=which, **tick_settings_select)
-
-
-def handle_spines(ax, spines):
-    if spines is not None:
-        tools.set_spine_visibility(ax, spines)
-
-
-def handle_aspect(ax, aspect):
-    if aspect is not None:
-        aspect = [aspect] if not isinstance(aspect, (list, tuple)) else aspect
-        adjustable = None if len(aspect) < 2 else aspect[1]
-        aspect_params = {'aspect': aspect[0], 'adjustable': adjustable}
-        ax.set_aspect(**aspect_params)
-
-
-def handle_breaks(ax, x_breaks, y_breaks):
-    if x_breaks is not None:
-        ax.set_xticks(x_breaks)
-
-    if y_breaks is not None:
-        ax.set_yticks(y_breaks)
-
-
-def handle_scales(ax, x_scale, y_scale):
-    if y_scale is not None:
-        scale_params = tools.parse_scale(scale=y_scale)
-        ax.set_yscale(**scale_params)
-
-    if x_scale is not None:
-        scale_params = tools.parse_scale(scale=x_scale)
-        ax.set_xscale(**scale_params)
-
-
-def handle_lims(ax, x_lims, y_lims):
-    if y_lims is not None:
-        ax.set_ylim(y_lims)
-
-    if x_lims is not None:
-        ax.set_xlim(x_lims)
-
-
-def handle_title(ax, title, title_params):
-    if title is None and len(title_params) == 0:
-        return
-
-    if title is None:
-        title = ax.get_title()
-        title = None if len(title) == 0 else title
-
-    if title is not None or len(title_params) > 0:
-        handle_text_element(ax.get_title, ax.set_title, title, title_params)
-
-
-def handle_labels(ax, axis, x_label, y_label, label_params):
-    if x_label is None and y_label is None and len(label_params) == 0:
-        return
-
-    loc_lookup = {
-        'x': {'start': 'left', 'center': 'center', 'end': 'right'},
-        'y': {'start': 'bottom', 'center': 'center', 'end': 'top'},
-    }
-
-    def normalize_params(axis_key: str, params: dict | None) -> dict:
-        params = params or {}
-        loc = params.get('loc')
-        if loc is not None:
-            try:
-                params['loc'] = loc_lookup[axis_key][loc]
-            except KeyError:
-                raise ValueError(
-                    f"Invalid {axis_key} label loc '{loc}'. Valid options are {list(loc_lookup[axis_key])}."
-                )
-        return params
-
-    x_label_params = normalize_params('x', label_params.copy()) if axis in ['x', 'both'] else {}
-    y_label_params = normalize_params('y', label_params.copy()) if axis in ['y', 'both'] else {}
-
-    handle_text_element(ax.get_xlabel, ax.set_xlabel, x_label, x_label_params)
-    handle_text_element(ax.get_ylabel, ax.set_ylabel, y_label, y_label_params)
-
-
-def handle_tick_labels(ax, x_tick_labels, y_tick_labels):
-    if x_tick_labels is not None:
-        ax.set_xticklabels(x_tick_labels)
-
-    if y_tick_labels is not None:
-        ax.set_yticklabels(y_tick_labels)
-
-
-def handle_margins(ax, margins, make_square):
-    if margins is not None and not make_square:
-        xmargin, ymargin = utils.maj_min_args(margins)
-
-        ax.set_xmargin(xmargin)
-        ax.set_ymargin(ymargin)