myplotlib 1.4.0__tar.gz → 1.5.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: myplotlib
-Version: 1.4.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>
@@ -64,20 +64,37 @@ pip install myplotlib
 
 ### usage
 
+#### loading style, fonts & colormaps
+
 ```python
-# initialize style:
 import myplotlib
-myplotlib.load(style=..., flavor=..., usetex=...)
-# style can be [None | `fancy` | `mono` | `hershey`]
-# flavor can be [None | `light` | `dark`]
-# usetex can be [True | False]
-# if not specified defaults to `style = None, flavor = None, usetex = True`
+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:

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

@@ -10,20 +10,37 @@ pip install myplotlib
 
 ### usage
 
+#### loading style, fonts & colormaps
+
 ```python
-# initialize style:
 import myplotlib
-myplotlib.load(style=..., flavor=..., usetex=...)
-# style can be [None | `fancy` | `mono` | `hershey`]
-# flavor can be [None | `light` | `dark`]
-# usetex can be [True | False]
-# if not specified defaults to `style = None, flavor = None, usetex = True`
+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:

myplotlib-1.5.0/myplotlib/__init__.py

@@ -0,0 +1,76 @@
+__version__ = "1.5.0"
+
+
+import os
+import matplotlib.pyplot as plt
+from matplotlib import font_manager
+
+import myplotlib
+
+
+def __RGBToPyCmap(rgbdata):
+    import numpy as np
+
+    nsteps = rgbdata.shape[0]
+    stepaxis = np.linspace(0, 1, nsteps)
+    rdata = []
+    gdata = []
+    bdata = []
+    for istep in range(nsteps):
+        r = rgbdata[istep, 0]
+        g = rgbdata[istep, 1]
+        b = rgbdata[istep, 2]
+        rdata.append((stepaxis[istep], r, r))
+        gdata.append((stepaxis[istep], g, g))
+        bdata.append((stepaxis[istep], b, b))
+    mpl_data = {"red": rdata, "green": gdata, "blue": bdata}
+    return mpl_data
+
+
+CUSTOM_CMAPS = []
+
+
+def __InstallCmapFromCSV(csv):
+    global CUSTOM_CMAPS
+    import os
+    import numpy as np
+    import matplotlib as mpl
+
+    cmap = os.path.splitext(os.path.basename(csv))[0]
+    cmap_data = np.loadtxt(csv, delimiter=",")
+    if cmap not in mpl.colormaps.keys():
+        CUSTOM_CMAPS.append(cmap)
+        mpl_data = __RGBToPyCmap(cmap_data)
+        mpl.colormaps.register(
+            cmap=mpl.colors.LinearSegmentedColormap(cmap, mpl_data, cmap_data.shape[0])
+        )
+    cmap = f"{cmap}_r"
+    if cmap not in mpl.colormaps.keys():
+        mpl_data_r = __RGBToPyCmap(cmap_data[::-1, :])
+        mpl.colormaps.register(
+            cmap=mpl.colors.LinearSegmentedColormap(
+                cmap, mpl_data_r, cmap_data.shape[0]
+            )
+        )
+
+
+myplotlib_path = myplotlib.__path__[0]
+styles_path = os.path.join(myplotlib_path, "assets")
+
+stylesheets = {}
+for folder, _, _ in os.walk(styles_path):
+    new_stylesheets = plt.style.core.read_style_directory(folder)
+    stylesheets.update(new_stylesheets)
+
+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.4.0 → myplotlib-1.5.0}/myplotlib/plots.py

@@ -247,8 +247,11 @@ def plot2d(
     if cbar is not None:
         divider = make_axes_locatable(ax)
         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")
+        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")
@@ -387,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.4.0 → myplotlib-1.5.0}/previews/README.md

@@ -22,7 +22,11 @@
 
 ![fancy_dark](fancy_dark.jpg)
 
-# `None`
+# `Latex`
 
-![None](None.jpg)
+![Latex](latex.jpg)
+
+# `Plain`
+
+![Plain](plain.jpg)
 

{myplotlib-1.4.0 → myplotlib-1.5.0}/previews/export_previews.py

@@ -1,5 +1,4 @@
 import os
-import matplotlib as mpl
 import matplotlib.pyplot as plt
 
 import myplotlib
@@ -13,17 +12,19 @@ if __name__ == "__main__":
         for f in os.listdir("myplotlib/assets")
         if f.endswith(".mplstyle") and f.count(".") == 2
     ]:
-        mpl.rcParams.update(mpl.rcParamsDefault)
-        myplotlib.load(st, fl)
+        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/{st}_{fl}.jpg")
-        readme += f"# `{st}.{fl}`\n\n![{st}_{fl}]({st}_{fl}.jpg)\n\n"
+        plt.savefig(f"previews/latex.jpg")
+        readme += f"# `Latex`\n\n![Latex](latex.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"
+    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.4.0/myplotlib/__init__.py

@@ -1,85 +0,0 @@
-__version__ = "1.4.0"
-
-CUSTOM_CMAPS = []
-
-
-def __RGBToPyCmap(rgbdata):
-    import numpy as np
-
-    nsteps = rgbdata.shape[0]
-    stepaxis = np.linspace(0, 1, nsteps)
-    rdata = []
-    gdata = []
-    bdata = []
-    for istep in range(nsteps):
-        r = rgbdata[istep, 0]
-        g = rgbdata[istep, 1]
-        b = rgbdata[istep, 2]
-        rdata.append((stepaxis[istep], r, r))
-        gdata.append((stepaxis[istep], g, g))
-        bdata.append((stepaxis[istep], b, b))
-    mpl_data = {"red": rdata, "green": gdata, "blue": bdata}
-    return mpl_data
-
-
-def __InstallCmapFromCSV(csv):
-    global CUSTOM_CMAPS
-    import os
-    import numpy as np
-    import matplotlib as mpl
-
-    cmap = os.path.splitext(os.path.basename(csv))[0]
-    cmap_data = np.loadtxt(csv, delimiter=",")
-    if cmap not in mpl.colormaps.keys():
-        CUSTOM_CMAPS.append(cmap)
-        mpl_data = __RGBToPyCmap(cmap_data)
-        mpl.colormaps.register(
-            cmap=mpl.colors.LinearSegmentedColormap(cmap, mpl_data, cmap_data.shape[0])
-        )
-    cmap = f"{cmap}_r"
-    if cmap not in mpl.colormaps.keys():
-        mpl_data_r = __RGBToPyCmap(cmap_data[::-1, :])
-        mpl.colormaps.register(
-            cmap=mpl.colors.LinearSegmentedColormap(
-                cmap, mpl_data_r, cmap_data.shape[0]
-            )
-        )
-
-
-def load(style=None, flavor="light", usetex=True):
-    """
-    `myplotlib.load`
-
-    preload custom style
-
-    args
-    ----------
-    style [None] ............. : style to load (options: None, 'fancy', 'mono', 'hershey')
-    flavor ['light'] ......... : color flavor to load (options: 'light', 'dark')
-    usetex [True] ............ : whether to use LaTeX (True/False)
-    """
-    import os
-    from matplotlib import font_manager
-    import matplotlib.pyplot as plt
-
-    assert usetex or style != "fancy", "fancy style requires usetex=True"
-
-    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)
-    if usetex and not style == "fancy":
-        LATEXSTILE_FILE = os.path.join(
-            os.path.dirname(__file__), f"assets/latex.mplstyle"
-        )
-        plt.style.use(LATEXSTILE_FILE)