myplotlib 1.4.0__tar.gz → 1.6.0__tar.gz

{myplotlib-1.4.0 → myplotlib-1.6.0}/.gitignore

@@ -11,7 +11,6 @@ build/
 
 *.ipynb
 
-.vscode
 *.drawio
 *.ipynb
 

myplotlib-1.6.0/.taplo.toml

@@ -0,0 +1,6 @@
+[formatting]
+  align_entries    = true
+  indent_tables    = true
+  indent_entries   = true
+  trailing_newline = true
+  align_comments   = true

myplotlib-1.6.0/.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "tamasfe.even-better-toml",
+    "yy0931.mplstyle",
+    "ms-python.black-formatter",
+    "ms-python.python"
+  ]
+}

myplotlib-1.6.0/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "[toml]": {
+    "editor.defaultFormatter": "tamasfe.even-better-toml"
+  },
+  "evenBetterToml.taplo.configFile.enabled": true,
+  "evenBetterToml.taplo.configFile.path": ".taplo.toml",
+}

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: myplotlib
-Version: 1.4.0
+Version: 1.6.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>
@@ -56,28 +56,45 @@ Description-Content-Type: text/markdown
 
 `matplotlib` binder with custom styles and routines for fast plotting. see [previews of available styles](https://github.com/haykh/myplotlib/tree/master/previews#readme).
 
-### installation
+## installation
 
 ```shell
 pip install myplotlib
 ```
 
-### usage
+## 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
+# - classic.dark, classic.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 functions for plotting:
+### auxiliary plotting functions
+
+```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:
@@ -86,22 +103,28 @@ mypltest?
 
 for more usage examples checkout the `tests/` submodule.
 
-### requirements
+## requirements
 
 * `python >= 3.8`
 * `matplotlib >= 3.5.0`, `numpy`
-* `latex` (used for `style="fancy"` only)
+* `latex` (used for `fancy` and `latex` only)
 * `numba>=0.57.0`
 
-### development
+## development
 
-Building tarballs in the `dist` directory:
+when deploying a new version, there are three necessary steps to take.
 
-```sh
-python -m build --sdist --outdir dist .
-```
+1. increase the version string in `myplotlib/__init__.py`.
+2. generate the previews:
+    ```sh
+    python3 previews/export_previews.py
+    ```
+3. build the new tarballs in the `dist` directory:
+    ```sh
+    python -m build --sdist --outdir dist .
+    ```
 
-### To-do
+## To-do
 
 - [ ] isocontour plotting
 - [x] add streamplot for fieldline plotting

myplotlib-1.6.0/README.md

@@ -0,0 +1,81 @@
+# `myplotlib`
+
+`matplotlib` binder with custom styles and routines for fast plotting. see [previews of available styles](https://github.com/haykh/myplotlib/tree/master/previews#readme).
+
+## installation
+
+```shell
+pip install myplotlib
+```
+
+## usage
+
+### loading style, fonts & colormaps
+
+```python
+import myplotlib
+import matplotlib.pyplot as plt
+
+plt.style.use(STYLE)
+# STYLE can be:
+# - fancy.dark, fancy.light
+# - classic.dark, classic.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
+
+```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:
+mypltest?
+```
+
+for more usage examples checkout the `tests/` submodule.
+
+## requirements
+
+* `python >= 3.8`
+* `matplotlib >= 3.5.0`, `numpy`
+* `latex` (used for `fancy` and `latex` only)
+* `numba>=0.57.0`
+
+## development
+
+when deploying a new version, there are three necessary steps to take.
+
+1. increase the version string in `myplotlib/__init__.py`.
+2. generate the previews:
+    ```sh
+    python3 previews/export_previews.py
+    ```
+3. build the new tarballs in the `dist` directory:
+    ```sh
+    python -m build --sdist --outdir dist .
+    ```
+
+## To-do
+
+- [ ] isocontour plotting
+- [x] add streamplot for fieldline plotting
+- [x] print all the newly added colormaps and the default color sequence
+- [x] add a test plot for the demo
+- [x] add image to readme
+- [x] dark mode
+- [x] monotype non-Latex mode

myplotlib-1.6.0/myplotlib/__init__.py

@@ -0,0 +1,76 @@
+__version__ = "1.6.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.6.0/myplotlib/assets/classic.dark.mplstyle

@@ -0,0 +1,69 @@
+axes.prop_cycle: cycler("color", ["FFFFFF", "FF5555", "5555FF", "55FF55", "FF55FF", "55FFFF", "FFFF55", "AAAAAA"])
+figure.dpi: 150
+
+# Set x axis
+xtick.direction: in
+xtick.major.size: 6.0
+# xtick.major.width: 1.5
+xtick.major.pad: 5
+xtick.minor.size: 4
+xtick.minor.visible: True
+xtick.top: True
+
+# Set y axis
+ytick.direction: in
+ytick.major.size: 6.0
+# ytick.major.width: 1.5
+ytick.major.pad: 5
+# ytick.minor.size: 4
+ytick.minor.visible: True
+ytick.right: True
+
+# Remove legend frame
+legend.frameon: False
+
+# Always save as 'tight'
+savefig.bbox: tight
+savefig.pad_inches: 0.05
+
+#axes.labelweight  : normal
+axes.labelsize: 16
+
+grid.alpha: 0.2
+
+# tex
+text.usetex: False
+
+# fonts
+font.weight: 500
+font.size: 16
+
+font.serif: AVHershey Complex 
+font.sans-serif: AVHershey Duplex 
+font.monospace: AVHershey Complex 
+
+font.family: serif
+
+mathtext.fontset: custom
+mathtext.default: it
+mathtext.rm: AVHershey Complex:medium
+mathtext.it: AVHershey Complex:medium:italic
+mathtext.bf: AVHershey Complex:heavy
+mathtext.sf: AVHershey Duplex:medium
+mathtext.tt: AVHershey Complex:light
+
+mathtext.fallback: None
+
+axes.formatter.use_mathtext: True
+
+ps.fonttype: 42
+pdf.fonttype: 42
+
+figure.facecolor: 0d1117
+axes.facecolor: none
+axes.edgecolor: white
+axes.labelcolor: white
+xtick.color: white
+ytick.color: white
+patch.edgecolor: white
+text.color: white

myplotlib-1.6.0/myplotlib/assets/classic.light.mplstyle

@@ -0,0 +1,60 @@
+axes.prop_cycle: cycler("color", ["000000", "AA0000", "0000AA", "00AA00", "AA00AA", "00AAAA", "AA5500", "AAAAAA"])
+figure.dpi: 150
+
+# Set x axis
+xtick.direction: in
+xtick.major.size: 6.0
+# xtick.major.width: 1.5
+xtick.major.pad: 5
+xtick.minor.size: 4
+xtick.minor.visible: True
+xtick.top: True
+
+# Set y axis
+ytick.direction: in
+ytick.major.size: 6.0
+# ytick.major.width: 1.5
+ytick.major.pad: 5
+# ytick.minor.size: 4
+ytick.minor.visible: True
+ytick.right: True
+
+# Remove legend frame
+legend.frameon: False
+
+# Always save as 'tight'
+savefig.bbox: tight
+savefig.pad_inches: 0.05
+
+#axes.labelweight  : normal
+axes.labelsize: 14
+
+grid.alpha: 0.2
+
+# tex
+text.usetex: False
+
+# fonts
+font.weight: 500
+font.size: 16
+
+font.serif: AVHershey Complex 
+font.sans-serif: AVHershey Duplex 
+font.monospace: AVHershey Complex 
+
+font.family: serif
+
+mathtext.fontset: custom
+mathtext.default: it
+mathtext.rm: AVHershey Complex:medium
+mathtext.it: AVHershey Complex:medium:italic
+mathtext.bf: AVHershey Complex:heavy
+mathtext.sf: AVHershey Duplex:medium
+mathtext.tt: AVHershey Complex:light
+
+mathtext.fallback: None
+
+axes.formatter.use_mathtext: True
+
+ps.fonttype: 42
+pdf.fonttype: 42

{myplotlib-1.4.0 → myplotlib-1.6.0}/myplotlib/assets/fancy.dark.mplstyle

@@ -1,4 +1,6 @@
+axes.prop_cycle: cycler('color', ["8bc6e4","f48a7c","3af899","fccd88","be9ac1","7d8c80","e95d7c","2688e3"])
 figure.dpi: 150
+
 axes.axisbelow: True
 axes.grid: False
 grid.linewidth: 0.2
@@ -6,20 +8,33 @@ xtick.direction: out
 ytick.direction: out
 grid.alpha: 0.2
 
+axes.labelsize: 16
+
+# tex
 text.usetex: True
 text.latex.preamble: \usepackage{amsmath,bm,xcolor,ebgaramond-maths}
 
-font.family: EB Garamond
+#fonts
+font.size: 14
+
+font.serif: EB Garamond
+font.sans-serif: EB Garamond
+font.monospace: EB Garamond
+
+font.family: serif
+
+# font.family: EB Garamond
 mathtext.fontset: custom
+mathtext.default: it
 mathtext.rm: EB Garamond
 mathtext.it: EB Garamond:italic
 mathtext.bf: EB Garamond:bold
-
-axes.prop_cycle: cycler('color', ["8bc6e4","f48a7c","3af899","fccd88","be9ac1","7d8c80","e95d7c","2688e3"])
+mathtext.sf: EB Garamond:medium
+mathtext.tt: EB Garamond:light
 
 # dark properties
-figure.facecolor: 2a2727
-axes.facecolor: 453f3d
+figure.facecolor: 0d1117
+axes.facecolor: none
 axes.edgecolor: white
 axes.labelcolor: white
 xtick.color: white

{myplotlib-1.4.0 → myplotlib-1.6.0}/myplotlib/assets/fancy.light.mplstyle

@@ -1,4 +1,5 @@
-figure.dpi: 150
+axes.prop_cycle: cycler('color', ["389ed0","ef5946","06b15c","fab54e","9d67a2","545e56","e22850","0d3b66"])
+
 axes.axisbelow: True
 axes.grid: False
 grid.linewidth: 0.2
@@ -6,13 +7,26 @@ xtick.direction: out
 ytick.direction: out
 grid.alpha: 0.2
 
+axes.labelsize: 16
+
+# tex
 text.usetex: True
 text.latex.preamble: \usepackage{amsmath,bm,xcolor,ebgaramond-maths}
 
-font.family: EB Garamond
+#fonts
+font.size: 14
+
+font.serif: EB Garamond
+font.sans-serif: EB Garamond
+font.monospace: EB Garamond
+
+font.family: serif
+
+# font.family: EB Garamond
 mathtext.fontset: custom
+mathtext.default: it
 mathtext.rm: EB Garamond
 mathtext.it: EB Garamond:italic
 mathtext.bf: EB Garamond:bold
-
-axes.prop_cycle: cycler('color', ["389ed0","ef5946","06b15c","fab54e","9d67a2","545e56","e22850","0d3b66"])
+mathtext.sf: EB Garamond:medium
+mathtext.tt: EB Garamond:light

{myplotlib-1.4.0 → myplotlib-1.6.0}/myplotlib/assets/mono.dark.mplstyle

@@ -1,3 +1,5 @@
+axes.prop_cycle: cycler('color', ["8bc6e4","f48a7c","3af899","fccd88","be9ac1","7d8c80","e95d7c","2688e3"])
+
 figure.dpi: 150
 axes.axisbelow: True
 axes.grid: False
@@ -8,11 +10,9 @@ grid.alpha: 0.2
 
 font.family: monospace
 
-axes.prop_cycle: cycler('color', ["8bc6e4","f48a7c","3af899","fccd88","be9ac1","7d8c80","e95d7c","2688e3"])
-
 # dark properties
-figure.facecolor: 2a2727
-axes.facecolor: 453f3d
+figure.facecolor: 0d1117
+axes.facecolor: none
 axes.edgecolor: white
 axes.labelcolor: white
 xtick.color: white

{myplotlib-1.4.0 → myplotlib-1.6.0}/myplotlib/assets/mono.light.mplstyle

@@ -1,3 +1,5 @@
+axes.prop_cycle: cycler('color', ["8bc6e4","f48a7c","3af899","fccd88","be9ac1","7d8c80","e95d7c","2688e3"])
+
 figure.dpi: 150
 axes.axisbelow: True
 axes.grid: False
@@ -6,6 +8,4 @@ xtick.direction: out
 ytick.direction: out
 grid.alpha: 0.2
 
-font.family: monospace
-
-axes.prop_cycle: cycler('color', ["389ed0","ef5946","06b15c","fab54e","9d67a2","545e56","e22850","0d3b66"])
+font.family: monospace