myplotlib 1.2.0__tar.gz → 1.4.0__tar.gz

{myplotlib-1.2.0 → myplotlib-1.4.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.2.0 → myplotlib-1.4.0}/PKG-INFO

@@ -1,13 +1,13 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: myplotlib
-Version: 1.2.0
+Version: 1.4.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:
@@ -47,7 +47,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering :: Visualization
 Requires-Python: >=3.8
-Requires-Dist: matplotlib>=3.0.0
+Requires-Dist: matplotlib>=3.5.0
 Requires-Dist: numba>=0.57.0
 Requires-Dist: numpy
 Description-Content-Type: text/markdown
@@ -67,10 +67,11 @@ pip install myplotlib
 ```python
 # initialize style:
 import myplotlib
-myplotlib.load(style=..., flavor=...)
+myplotlib.load(style=..., flavor=..., usetex=...)
 # style can be [None | `fancy` | `mono` | `hershey`]
 # flavor can be [None | `light` | `dark`]
-# if not specified defaults to `style = None, flavor = None`
+# usetex can be [True | False]
+# if not specified defaults to `style = None, flavor = None, usetex = True`
 
 # auxiliary functions for plotting:
 import myplotlib.plots as myplt
@@ -88,7 +89,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.2.0 → myplotlib-1.4.0}/README.md

@@ -13,10 +13,11 @@ pip install myplotlib
 ```python
 # initialize style:
 import myplotlib
-myplotlib.load(style=..., flavor=...)
+myplotlib.load(style=..., flavor=..., usetex=...)
 # style can be [None | `fancy` | `mono` | `hershey`]
 # flavor can be [None | `light` | `dark`]
-# if not specified defaults to `style = None, flavor = None`
+# usetex can be [True | False]
+# if not specified defaults to `style = None, flavor = None, usetex = True`
 
 # auxiliary functions for plotting:
 import myplotlib.plots as myplt
@@ -34,7 +35,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.2.0 → myplotlib-1.4.0}/myplotlib/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.2.0"
+__version__ = "1.4.0"
 
 CUSTOM_CMAPS = []
 
@@ -27,27 +27,26 @@ def __InstallCmapFromCSV(csv):
     import os
     import numpy as np
     import matplotlib as mpl
-    import matplotlib.pyplot as plt
 
     cmap = os.path.splitext(os.path.basename(csv))[0]
     cmap_data = np.loadtxt(csv, delimiter=",")
-    if cmap not in plt.colormaps():
+    if cmap not in mpl.colormaps.keys():
         CUSTOM_CMAPS.append(cmap)
         mpl_data = __RGBToPyCmap(cmap_data)
-        plt.register_cmap(
+        mpl.colormaps.register(
             cmap=mpl.colors.LinearSegmentedColormap(cmap, mpl_data, cmap_data.shape[0])
         )
     cmap = f"{cmap}_r"
-    if cmap not in plt.colormaps():
+    if cmap not in mpl.colormaps.keys():
         mpl_data_r = __RGBToPyCmap(cmap_data[::-1, :])
-        plt.register_cmap(
+        mpl.colormaps.register(
             cmap=mpl.colors.LinearSegmentedColormap(
                 cmap, mpl_data_r, cmap_data.shape[0]
             )
         )
 
 
-def load(style=None, flavor="light"):
+def load(style=None, flavor="light", usetex=True):
     """
     `myplotlib.load`
 
@@ -56,12 +55,15 @@ def load(style=None, flavor="light"):
     args
     ----------
     style [None] ............. : style to load (options: None, 'fancy', 'mono', 'hershey')
-    flavor ['light'] ............ : color flavor to load (options: 'light', 'dark')
+    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:
@@ -76,3 +78,8 @@ def load(style=None, flavor="light"):
             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)

myplotlib-1.4.0/myplotlib/assets/latex.mplstyle

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

{myplotlib-1.2.0 → myplotlib-1.4.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,20 @@ 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 +319,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
@@ -336,7 +353,7 @@ def plotVectorField(
         * np.abs(weights - np.average(weights)) ** lic_contrast
     )
     colors = matplotlib.colors.Normalize(None, None)(_)
-    colors = plt.cm.get_cmap(lic_cmap)(colors)
+    colors = matplotlib.colormaps[lic_cmap](colors)
     colors[..., -1] = alphas
 
     colorbar = plot2d(

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

@@ -11,7 +11,7 @@ if __name__ == "__main__":
     for st, fl in [
         f.replace(".mplstyle", "").split(".")
         for f in os.listdir("myplotlib/assets")
-        if f.endswith(".mplstyle")
+        if f.endswith(".mplstyle") and f.count(".") == 2
     ]:
         mpl.rcParams.update(mpl.rcParamsDefault)
         myplotlib.load(st, fl)

{myplotlib-1.2.0 → myplotlib-1.4.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "myplotlib"
 dynamic = ["version"]
-dependencies = ["matplotlib>=3.0.0", "numpy", "numba>=0.57.0"]
+dependencies = ["matplotlib>=3.5.0", "numpy", "numba>=0.57.0"]
 requires-python = ">=3.8"
 authors = [{ name = "Hayk", email = "haykh.astro@gmail.com" }]
 maintainers = [{ name = "Hayk", email = "haykh.astro@gmail.com" }]

{myplotlib-1.2.0 → myplotlib-1.4.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,6 +14,14 @@
 
 ![hershey_dark](hershey_dark.jpg)
 
+# `fancy.light`
+
+![fancy_light](fancy_light.jpg)
+
+# `fancy.dark`
+
+![fancy_dark](fancy_dark.jpg)
+
 # `None`
 
 ![None](None.jpg)