myplotlib 1.3.0__tar.gz → 1.5.0__tar.gz

{myplotlib-1.3.0 → myplotlib-1.5.0}/LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2023, Hayk Hakobyan
+Copyright (c) 2024, Hayk Hakobyan
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

{myplotlib-1.3.0 → myplotlib-1.5.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.3
 Name: myplotlib
-Version: 1.3.0
+Version: 1.5.0
 Summary: `matplotlib` binder with custom styles and routines for fast plotting
 Project-URL: Repository, https://github.com/haykh/myplotlib
 Author-email: Hayk <haykh.astro@gmail.com>
 Maintainer-email: Hayk <haykh.astro@gmail.com>
 License: BSD 3-Clause License
         
-        Copyright (c) 2023, Hayk Hakobyan
+        Copyright (c) 2024, Hayk Hakobyan
         
         Redistribution and use in source and binary forms, with or without
         modification, are permitted provided that the following conditions are met:
@@ -64,19 +64,37 @@ pip install myplotlib
 
 ### usage
 
+#### loading style, fonts & colormaps
+
 ```python
-# initialize style:
 import myplotlib
-myplotlib.load(style=..., flavor=...)
-# style can be [None | `fancy` | `mono` | `hershey`]
-# flavor can be [None | `light` | `dark`]
-# if not specified defaults to `style = None, flavor = None`
+import matplotlib.pyplot as plt
+
+plt.style.use(STYLE)
+# STYLE can be:
+# - fancy.dark, fancy.light
+# - hershey.dark, hershey.light
+# - mono.dark, mono.light
+# - latex
+
+# you may also combine the styles:
+plt.style.use([STYLE1, STYLE2])
+
+# and you can temporarily load the style:
+with plt.style.context(STYLE):
+    plt.plot(...)
+```
+
+#### auxiliary plotting functions
 
-# auxiliary functions for plotting:
+```python
 import myplotlib.plots as myplt
 # type for docstring:
 myplt?
 
+# for specific function:
+myplt.plot2d?
+
 # preview custom styles with built-in functions
 import myplotlib.tests as mypltest
 # type for docstring:
@@ -88,7 +106,7 @@ for more usage examples checkout the `tests/` submodule.
 ### requirements
 
 * `python >= 3.8`
-* `matplotlib >= 3.0.0`, `numpy`
+* `matplotlib >= 3.5.0`, `numpy`
 * `latex` (used for `style="fancy"` only)
 * `numba>=0.57.0`
 

{myplotlib-1.3.0 → myplotlib-1.5.0}/README.md

@@ -10,19 +10,37 @@ pip install myplotlib
 
 ### usage
 
+#### loading style, fonts & colormaps
+
 ```python
-# initialize style:
 import myplotlib
-myplotlib.load(style=..., flavor=...)
-# style can be [None | `fancy` | `mono` | `hershey`]
-# flavor can be [None | `light` | `dark`]
-# if not specified defaults to `style = None, flavor = None`
+import matplotlib.pyplot as plt
+
+plt.style.use(STYLE)
+# STYLE can be:
+# - fancy.dark, fancy.light
+# - hershey.dark, hershey.light
+# - mono.dark, mono.light
+# - latex
+
+# you may also combine the styles:
+plt.style.use([STYLE1, STYLE2])
+
+# and you can temporarily load the style:
+with plt.style.context(STYLE):
+    plt.plot(...)
+```
+
+#### auxiliary plotting functions
 
-# auxiliary functions for plotting:
+```python
 import myplotlib.plots as myplt
 # type for docstring:
 myplt?
 
+# for specific function:
+myplt.plot2d?
+
 # preview custom styles with built-in functions
 import myplotlib.tests as mypltest
 # type for docstring:
@@ -34,7 +52,7 @@ for more usage examples checkout the `tests/` submodule.
 ### requirements
 
 * `python >= 3.8`
-* `matplotlib >= 3.0.0`, `numpy`
+* `matplotlib >= 3.5.0`, `numpy`
 * `latex` (used for `style="fancy"` only)
 * `numba>=0.57.0`
 

{myplotlib-1.3.0 → myplotlib-1.5.0}/myplotlib/__init__.py

@@ -1,6 +1,11 @@
-__version__ = "1.3.0"
+__version__ = "1.5.0"
 
-CUSTOM_CMAPS = []
+
+import os
+import matplotlib.pyplot as plt
+from matplotlib import font_manager
+
+import myplotlib
 
 
 def __RGBToPyCmap(rgbdata):
@@ -22,6 +27,9 @@ def __RGBToPyCmap(rgbdata):
     return mpl_data
 
 
+CUSTOM_CMAPS = []
+
+
 def __InstallCmapFromCSV(csv):
     global CUSTOM_CMAPS
     import os
@@ -46,32 +54,23 @@ def __InstallCmapFromCSV(csv):
         )
 
 
-def load(style=None, flavor="light"):
-    """
-    `myplotlib.load`
+myplotlib_path = myplotlib.__path__[0]
+styles_path = os.path.join(myplotlib_path, "assets")
 
-    preload custom style
+stylesheets = {}
+for folder, _, _ in os.walk(styles_path):
+    new_stylesheets = plt.style.core.read_style_directory(folder)
+    stylesheets.update(new_stylesheets)
 
-    args
-    ----------
-    style [None] ............. : style to load (options: None, 'fancy', 'mono', 'hershey')
-    flavor ['light'] ............ : color flavor to load (options: 'light', 'dark')
-    """
-    import os
-    from matplotlib import font_manager
-    import matplotlib.pyplot as plt
-
-    CMAP_DIR = os.path.join(os.path.dirname(__file__), "assets/colormaps")
-    CMAPS = os.listdir(CMAP_DIR)
-    for cmap in CMAPS:
-        cmapname = os.path.join(CMAP_DIR, cmap)
-        __InstallCmapFromCSV(cmapname)
-    FONT_DIR = os.path.join(os.path.dirname(__file__), "assets/fonts")
-    font_files = font_manager.findSystemFonts(fontpaths=[FONT_DIR])
-    for font_file in font_files:
-        font_manager.fontManager.addfont(font_file)
-    if style is not None:
-        MPLSTYLE_FILE = os.path.join(
-            os.path.dirname(__file__), f"assets/{style}.{flavor}.mplstyle"
-        )
-        plt.style.use(MPLSTYLE_FILE)
+plt.style.core.update_nested_dict(plt.style.library, stylesheets)
+plt.style.core.available[:] = sorted(plt.style.library.keys())
+
+CMAP_DIR = os.path.join(myplotlib_path, "assets/colormaps")
+CMAPS = os.listdir(CMAP_DIR)
+for cmap in CMAPS:
+    cmapname = os.path.join(CMAP_DIR, cmap)
+    __InstallCmapFromCSV(cmapname)
+FONT_DIR = os.path.join(myplotlib_path, "assets/fonts")
+font_files = font_manager.findSystemFonts(fontpaths=[FONT_DIR])
+for font_file in font_files:
+    font_manager.fontManager.addfont(font_file)

myplotlib-1.5.0/myplotlib/assets/latex.mplstyle

@@ -0,0 +1,2 @@
+text.usetex: True
+text.latex.preamble: \usepackage{amsmath,bm,xcolor}

{myplotlib-1.3.0 → myplotlib-1.5.0}/myplotlib/plots.py

@@ -126,7 +126,7 @@ def dataPlot(
     xlog [False], ylog [False] .. : use log in x or y direction
     xlim [None], ylim [None] .... : tuples of x and y limits (None = determine from data)
     padx [0], pady [0] .......... : add whitespace to axes in each direction (0 = no additional space)
-    **kwargs .................... : standard matplotlib kwargs passed to `ax.scatter`
+    **kwargs .................... : standard matplotlib kwargs passed to `ax.<function>`
     """
     if padx != 0:
         ax.spines["top"].set_visible(False)
@@ -169,7 +169,7 @@ def plot(
     xlog [False], ylog [False] .. : use log in x or y direction
     xlim [None], ylim [None] .... : tuples of x and y limits (None = determine from data)
     padx [0], pady [0] .......... : add whitespace to axes in each direction (0 = no additional space)
-    **kwargs .................... : standard matplotlib kwargs passed to `ax.scatter`
+    **kwargs .................... : standard matplotlib kwargs passed to `ax.plot`
     """
     dataPlot(ax.plot, ax, x, y, xlog, ylog, xlim, ylim, padx, pady, **kwargs)
 
@@ -189,6 +189,7 @@ def plot2d(
     pady=0.0,
     cbar="5%",
     cbar_pad=0.05,
+    cbar_pos="right",
     **kwargs,
 ):
     """
@@ -206,7 +207,8 @@ def plot2d(
     padx [0], pady [0] .......... : add whitespace to axes in each direction (0 = no additional space)
     cbar ['5%'] ................. : size of the colorbar in percent of x-axis (None = no colorbar)
     cbar_pad [0.05] ............. : padding of the colorbar
-    **kwargs .................... : standard matplotlib kwargs passed to `ax.scatter`
+    cbar_pos ['right'] .......... : position of the colorbar ('left', 'right', 'top', 'bottom')
+    **kwargs .................... : standard matplotlib kwargs passed to `ax.imshow`
 
     returns
     ----------
@@ -217,6 +219,9 @@ def plot2d(
     import matplotlib.pyplot as plt
     import matplotlib as mpl
 
+    assert centering in ["edge", "center"], "invalid `centering`"
+    assert cbar_pos in ["left", "right", "top", "bottom"], "invalid `cbar_pos`"
+
     x, y, zz = __checkDimensions2d(x, y, zz)
     ax.grid(False)
     extent = __findExtent(x, y, centering)
@@ -241,8 +246,23 @@ def plot2d(
     __setAxLims(ax, np.linspace(extent[2], extent[3]), False, pady, ylim, "left")
     if cbar is not None:
         divider = make_axes_locatable(ax)
-        cax = divider.append_axes("right", size=cbar, pad=cbar_pad)
-        colorbar = plt.colorbar(ax.get_images()[0], cax=cax)
+        cax = divider.append_axes(cbar_pos, size=cbar, pad=cbar_pad)
+        colorbar = plt.colorbar(
+            ax.get_images()[0],
+            cax=cax,
+            orientation="vertical" if cbar_pos in ["left", "right"] else "horizontal",
+        )
+        if cbar_pos == "left":
+            cax.yaxis.set_ticks_position("left")
+            cax.yaxis.set_label_position("left")
+            ax.yaxis.set_ticks_position("right")
+            ax.yaxis.set_label_position("right")
+        if cbar_pos == "top":
+            cax.xaxis.set_ticks_position("top")
+            cax.xaxis.set_label_position("top")
+        if cbar_pos == "bottom":
+            ax.xaxis.set_ticks_position("top")
+            ax.xaxis.set_label_position("top")
         return colorbar
     else:
         return None
@@ -302,7 +322,7 @@ def plotVectorField(
     padx [0], pady [0] .......... : add whitespace to axes in each direction (0 = no additional space)
     cbar ['5%'] ................. : size of the colorbar in percent of x-axis (None = no colorbar)
     cbar_pad [0.05] ............. : padding of the colorbar
-    **kwargs .................... : standard matplotlib kwargs passed to `ax.scatter`
+    **kwargs .................... : standard matplotlib kwargs passed to `ax.imshow`
     """
     import myplotlib.tools.lic as lic
     import matplotlib
@@ -370,3 +390,111 @@ def plotVectorField(
         alpha=lic_opacity,
     )
     return colorbar
+
+
+def plot2dGrid(
+    x,
+    y,
+    fields,
+    panels,
+    label_pos="title",
+    label_args={},
+    width=10,
+    dpi=150,
+    wspace=0.05,
+    hspace=0.05,
+    **kwargs,
+):
+    """
+    add a grid of 2d plots with shared axes
+
+    args
+    ----------
+    x, y ........................ : 1d or 2d arrays of coordinates
+    fields ...................... : dictionary of all the fields
+    panels ...................... : array of array of dictionaries indicating the panels to plot (see note below)
+    label_pos ['title'] ......... : position of the label ('title', 'cbar', 'text', None)
+    label_args [{}] ............. : arguments for the label (color, fontsize, etc; passed to `ax.set_title`, )
+
+    arguments for the figure
+    ----------
+    width [10] .................. : width of the figure in inches
+    dpi [150] ................... : resolution of the figure [dots per inch]
+    wspace [0.05] ............... : width space between the panels (as fraction of the panel width)
+    hspace [0.05] ............... : height space between the panels (as fraction of the panel height)
+
+    the rest of the args are the same as for the `plot2d`
+    ----------
+    force_aspect [True] ......... : force equal aspect ratio according to axes
+    centering ['edge'] .......... : centering of x & y nodes for the data ('edge', 'center')
+    xlim [None], ylim [None] .... : tuples of x and y limits (None = determine from x & y)
+    padx [0], pady [0] .......... : add whitespace to axes in each direction (0 = no additional space)
+    cbar ['5%'] ................. : size of the colorbar in percent of x-axis (None = no colorbar)
+    cbar_pad [0.05] ............. : padding of the colorbar
+    **kwargs .................... : standard matplotlib kwargs passed to `ax.imshow`
+
+    note
+    ----------
+    the `panels` is an `n x m` array, where `n` is the number of rows and `m` is the number of columns.
+    each element of the array is a dictionary with the following keys:
+        - 'label' ............... : label for the field
+        - 'field' ............... : lambda function which takes the `fields` dictionary and returns the quantity to plot
+        - 'cmap' ................ : colormap of the panel
+        - 'norm' ................ : normalization object
+    """
+    import matplotlib.pyplot as plt
+
+    assert len(panels) > 0, "no panels to plot"
+    assert len(panels[0]) > 0, "no panels to plot"
+    assert all(
+        [len(row) == len(panels[0]) for row in panels]
+    ), "all rows must have the same number of panels"
+    assert label_pos in ["title", "cbar", "text", None], "invalid label position"
+
+    ncols = len(panels[0])
+    nrows = len(panels)
+
+    xlims = kwargs.get("xlim", (x.min(), x.max()))
+    ylims = kwargs.get("ylim", (y.min(), y.max()))
+    aspect = (xlims[1] - xlims[0]) / (ylims[1] - ylims[0])
+    height = (
+        width
+        * ((nrows + hspace * (nrows - 1)) / (ncols + wspace * (ncols - 1)))
+        / aspect
+    )
+
+    fig = plt.figure(figsize=(width, height), dpi=dpi)
+
+    gs = fig.add_gridspec(nrows, ncols, wspace=wspace, hspace=hspace)
+    axs = [[fig.add_subplot(gs[i, j]) for j in range(ncols)] for i in range(nrows)]
+
+    label_coords = label_args.pop("position", (0.05, 0.95))
+
+    for i in range(nrows):
+        for j in range(ncols):
+            ax = axs[i][j]
+            panel = panels[i][j]
+
+            cbar = plot2d(
+                ax,
+                x,
+                y,
+                panel["field"](fields),
+                norm=panel["norm"],
+                cmap=panel["cmap"],
+                **kwargs,
+            )
+
+            if j != 0:
+                ax.set(ylabel=None, yticklabels=[])
+            if i != nrows - 1:
+                ax.set(xlabel=None, xticklabels=[])
+
+            if label_pos == "title":
+                ax.set_title(panel["label"], **label_args)
+            elif label_pos == "cbar":
+                cbar.set_label(panel["label"], **label_args)
+            elif label_pos == "text":
+                ax.text(
+                    *label_coords, panel["label"], transform=ax.transAxes, **label_args
+                )

{myplotlib-1.3.0 → myplotlib-1.5.0}/previews/README.md

@@ -1,7 +1,3 @@
-# `fancy.light`
-
-![fancy_light](fancy_light.jpg)
-
 # `mono.dark`
 
 ![mono_dark](mono_dark.jpg)
@@ -10,10 +6,6 @@
 
 ![mono_light](mono_light.jpg)
 
-# `fancy.dark`
-
-![fancy_dark](fancy_dark.jpg)
-
 # `hershey.light`
 
 ![hershey_light](hershey_light.jpg)
@@ -22,7 +14,19 @@
 
 ![hershey_dark](hershey_dark.jpg)
 
-# `None`
+# `fancy.light`
+
+![fancy_light](fancy_light.jpg)
+
+# `fancy.dark`
+
+![fancy_dark](fancy_dark.jpg)
+
+# `Latex`
+
+![Latex](latex.jpg)
+
+# `Plain`
 
-![None](None.jpg)
+![Plain](plain.jpg)
 

myplotlib-1.5.0/previews/export_previews.py

@@ -0,0 +1,30 @@
+import os
+import matplotlib.pyplot as plt
+
+import myplotlib
+import myplotlib.tests as mypltests
+
+if __name__ == "__main__":
+    readme = ""
+
+    for st, fl in [
+        f.replace(".mplstyle", "").split(".")
+        for f in os.listdir("myplotlib/assets")
+        if f.endswith(".mplstyle") and f.count(".") == 2
+    ]:
+        with plt.style.context(f"{st}.{fl}"):
+            mypltests.testAll()
+            plt.savefig(f"previews/{st}_{fl}.jpg")
+            readme += f"# `{st}.{fl}`\n\n![{st}_{fl}]({st}_{fl}.jpg)\n\n"
+
+    with plt.style.context("latex"):
+        mypltests.testAll()
+        plt.savefig(f"previews/latex.jpg")
+        readme += f"# `Latex`\n\n![Latex](latex.jpg)\n\n"
+
+    mypltests.testAll()
+    plt.savefig(f"previews/plain.jpg")
+    readme += f"# `Plain`\n\n![Plain](plain.jpg)\n\n"
+
+    with open("previews/README.md", "w") as f:
+        f.write(readme)

myplotlib-1.3.0/previews/export_previews.py

@@ -1,29 +0,0 @@
-import os
-import matplotlib as mpl
-import matplotlib.pyplot as plt
-
-import myplotlib
-import myplotlib.tests as mypltests
-
-if __name__ == "__main__":
-    readme = ""
-
-    for st, fl in [
-        f.replace(".mplstyle", "").split(".")
-        for f in os.listdir("myplotlib/assets")
-        if f.endswith(".mplstyle")
-    ]:
-        mpl.rcParams.update(mpl.rcParamsDefault)
-        myplotlib.load(st, fl)
-        mypltests.testAll()
-        plt.savefig(f"previews/{st}_{fl}.jpg")
-        readme += f"# `{st}.{fl}`\n\n![{st}_{fl}]({st}_{fl}.jpg)\n\n"
-
-    mpl.rcParams.update(mpl.rcParamsDefault)
-    myplotlib.load(None, None)
-    mypltests.testAll()
-    plt.savefig(f"previews/None.jpg")
-    readme += f"# `None`\n\n![None](None.jpg)\n\n"
-
-    with open("previews/README.md", "w") as f:
-        f.write(readme)