wedme-plots 2.0__tar.gz → 2.0.5__tar.gz

{wedme-plots-2.0 → wedme_plots-2.0.5}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Real Python
+Copyright (c) 2023 Martijn Ruijzendaal
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

wedme_plots-2.0.5/MANIFEST.in

@@ -0,0 +1 @@
+include src/wedme/stylesheets/*.mplstyle

wedme_plots-2.0.5/PKG-INFO

@@ -0,0 +1,186 @@
+Metadata-Version: 2.2
+Name: wedme-plots
+Version: 2.0.5
+Summary: We Don't Make Embarrassing Plots. Matplotlib styles for papers, posters, presentations and theses.
+Author-email: Martijn Ruijzendaal <martijn.ruijzendaal@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2023 Martijn Ruijzendaal
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: repository, https://github.com/mruijzendaal/wedme-plots
+Project-URL: documentation, https://github.com/mruijzendaal/wedme-plots
+Keywords: matplotlib
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib
+Requires-Dist: importlib_resources
+Provides-Extra: build
+Requires-Dist: build; extra == "build"
+Requires-Dist: twine; extra == "build"
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+
+# 👗 wedme-plots: We Don't Make Embarrassing Plots
+
+Matplotlib styles for papers, posters, presentations and theses. Tailored for academic use.
+
+## Too long; didn't read
+1. Pick a style from `paper`, `slide`, `a0`, `thesis`.
+2. Decide the final size of the figure on the chosen medium. 
+For example, the column width (`cw`) and default height (`dh`) for the `paper` style.
+3. Import `wedme`
+4. Before using matplotlib, apply the style using `wedme.apply.[style]_[width]_[height]()`. In the above example, `wedme.apply.paper_cw_dh()`.
+
+
+## Installation
+Install from [PyPI](https://pypi.org/project/wedme-plots/) using PIP:
+```
+pip install wedme-plots
+```
+
+For Anaconda users:
+- Open an Anaconda Prompt
+- Optional: if you use an environment other than `base`, open it using `conda activate [my environment]`
+- Install pip using `conda install pip`
+- Install wedme-plots using `pip install wedme-plots`
+
+## Styling
+Wedme offers multiple styles:
+- `paper`: compatible with most journals (Nature, Science, Elsevier). 
+- `slide`: compatible with a (16:9) Microsoft Powerpoint presentation. 
+- `a0`: A0 poster.
+- `thesis`: (work-in-progress) similar to `paper` but for a single-column B5 page.
+
+## Usage
+There are two ways of applying a wedme style. 
+
+### 1. Global styling and sizing
+
+Import the `wedme` module and apply the desired style, e.g. `wedme.apply.paper()`. 
+This applies the specified style and its default size to every subsequent figure.
+
+Example:
+```python
+import wedme
+
+# These commands apply a style to subsequent Matplotlib figures.
+
+# Pick one:
+wedme.apply.paper()  # For Elsevier-compatible paper styles
+wedme.apply.slide()  # For a 16:9 Powerpoint slide
+wedme.apply.a0()     # For A0 posters
+wedme.apply.thesis() # For B5-paper thesis
+
+# Optionally, change the default size:
+wedme.apply.slide_tw_hh()
+
+# Proceed with plotting as usual
+import matplotlib.pyplot as plt
+
+plt.figure()
+plt.plot([1, 2, 3, 4])
+plt.show()
+```
+
+### 2. Local styling and sizing
+
+Alternatively, one can open figures in a specified style and size using the `wedme` drop-in replacements for `plt.figure()` and `plt.subplots()` as follows:
+
+```python
+import wedme
+import matplotlib.pyplot as plt
+
+# Open a figure in the `a0` style, 
+# with a size corresponding to half-width and half-height
+wedme.figure.a0_hw_hh()
+plt.plot([1, 2, 3, 4])
+
+# Open a figure with two subplots in the `slide` style,
+# with the figure size corresponding to half-width and half-height
+fig, (ax1, ax2) = wedme.subplots.slide_hw_hh(1, 2)
+
+ax1.plot([1, 2, 3, 4])
+ax2.plot([1, 2, 3, 4])
+```
+
+Any arguments passed to `wedme.figure.[style]()` and `wedme.subplots.[style]()` are passed on to the equivalent matplotlib functions.
+
+## Sizing
+Matching the matplotlib figure size to the final display size of the figure is critically important: scaling to a different height will change font sizes and line widths.
+
+We include the following breakpoints, with respect to the available width and height (`H`) of the chosen medium:
+| Breakpoint | Ratio |
+| -- | -- |
+| `F` | 100% _("full")_ |
+| `TT` | 2/3 _("two-thirds")_ |
+| `H` | 1/2 _("half")_ |
+| `FT` | 5/12 _("five-twelfth")_ |
+| `T` | 1/3 _("third")_ |
+| `Q` | 1/4 _("quarter")_ |
+| `R` | 1/5 |
+| `S` | 1/6 |
+
+To specify the size using a breakpoint, append `W` (width) or `H` (height). For example, `wedme.figure.a0_hw_hh()` specifies the `a0` style, with a size of half the A0 width and height.
+
+In addition to the breakpoints, some styles include custom sizes:
+- `paper`: `CW` (column width) for two-column papers. `GH` is the height that corresponds to the golden-ratio of `CW`.
+- `thesis`: `LFW` and `LFH` for the landscape full-width and full-height.
+The default width and height `DW` and `DH` correspond to `CW` and `GH` of the `paper` style
+
+</br>
+
+When no size is specified, the following defaults sizes are used:
+- `paper`: `(wedme.PAPER_CW, wedme.paper_GH)`
+- `slide`: `(wedme.SLIDE_TTW, wedme.slide_TTH)`
+- `a0`:  `(wedme.A0_TW, ...)`
+- `thesis`: `(wedme.THESIS_DW, wedme.paper_DH)`
+
+
+## Powerpoint
+Powerpoint automatically resizes artwork to a size that is different from the export size. To undo this:
+- Insert the figure in Powerpoint.
+- Picture Format > Reset Picture > Reset Picture & Size.
+
+## Fonts
+Sans-serif fonts are the standards for figures because they remain readable even when small or pixelated. Helvetica or Arial fonts are preferred by Nature, Science and Elsevier. 
+
+We try to find Helvetica, Arial, Verdana, Inter, Nimbus Sans on your system, in that order. The first font found will be applied to the figures.
+
+## Exporting
+`wedme` sets the `pdf.fonttype` parameter to `42` as recommended by Nature. This ensures that the text is editable even after exporting a pdf. `wedme` also changes the parameters `figure.autolayout` and `savefig.bbox` such that the specified sizes are respected.
+
+For saving figures, consider using [pypdfplot](https://github.com/dcmvdbekerom/pypdfplot) to maintain the ability to later change how data is displayed. Of course, we don't make embarassing plots to begin with.
+
+## Examples
+<img src="https://github.com/mruijzendaal/wedme-plots/blob/main/img/calibration_curve_rot.png?raw=true" width="512">
+
+## Utilities
+Other than style sheets, wedme also includes utilities for commonly used operations.
+- Creating animated GIF images from multiple plots. See `wedme.gif`
+- Creating a legend only for unique entries. See `wedme.util.unique_legend()`
+- Specifying the colorbar label easily. See `wedme.util.colorbar()`
+- Specifying the minimum and maximum of the colorbar as a function of percentiles of the shown field. See `wedme.util.imshow()`
+- Making plot colors dependent on some variable. See `weme.util.get_colormap_norm()`

wedme_plots-2.0.5/README.md

@@ -0,0 +1,141 @@
+# 👗 wedme-plots: We Don't Make Embarrassing Plots
+
+Matplotlib styles for papers, posters, presentations and theses. Tailored for academic use.
+
+## Too long; didn't read
+1. Pick a style from `paper`, `slide`, `a0`, `thesis`.
+2. Decide the final size of the figure on the chosen medium. 
+For example, the column width (`cw`) and default height (`dh`) for the `paper` style.
+3. Import `wedme`
+4. Before using matplotlib, apply the style using `wedme.apply.[style]_[width]_[height]()`. In the above example, `wedme.apply.paper_cw_dh()`.
+
+
+## Installation
+Install from [PyPI](https://pypi.org/project/wedme-plots/) using PIP:
+```
+pip install wedme-plots
+```
+
+For Anaconda users:
+- Open an Anaconda Prompt
+- Optional: if you use an environment other than `base`, open it using `conda activate [my environment]`
+- Install pip using `conda install pip`
+- Install wedme-plots using `pip install wedme-plots`
+
+## Styling
+Wedme offers multiple styles:
+- `paper`: compatible with most journals (Nature, Science, Elsevier). 
+- `slide`: compatible with a (16:9) Microsoft Powerpoint presentation. 
+- `a0`: A0 poster.
+- `thesis`: (work-in-progress) similar to `paper` but for a single-column B5 page.
+
+## Usage
+There are two ways of applying a wedme style. 
+
+### 1. Global styling and sizing
+
+Import the `wedme` module and apply the desired style, e.g. `wedme.apply.paper()`. 
+This applies the specified style and its default size to every subsequent figure.
+
+Example:
+```python
+import wedme
+
+# These commands apply a style to subsequent Matplotlib figures.
+
+# Pick one:
+wedme.apply.paper()  # For Elsevier-compatible paper styles
+wedme.apply.slide()  # For a 16:9 Powerpoint slide
+wedme.apply.a0()     # For A0 posters
+wedme.apply.thesis() # For B5-paper thesis
+
+# Optionally, change the default size:
+wedme.apply.slide_tw_hh()
+
+# Proceed with plotting as usual
+import matplotlib.pyplot as plt
+
+plt.figure()
+plt.plot([1, 2, 3, 4])
+plt.show()
+```
+
+### 2. Local styling and sizing
+
+Alternatively, one can open figures in a specified style and size using the `wedme` drop-in replacements for `plt.figure()` and `plt.subplots()` as follows:
+
+```python
+import wedme
+import matplotlib.pyplot as plt
+
+# Open a figure in the `a0` style, 
+# with a size corresponding to half-width and half-height
+wedme.figure.a0_hw_hh()
+plt.plot([1, 2, 3, 4])
+
+# Open a figure with two subplots in the `slide` style,
+# with the figure size corresponding to half-width and half-height
+fig, (ax1, ax2) = wedme.subplots.slide_hw_hh(1, 2)
+
+ax1.plot([1, 2, 3, 4])
+ax2.plot([1, 2, 3, 4])
+```
+
+Any arguments passed to `wedme.figure.[style]()` and `wedme.subplots.[style]()` are passed on to the equivalent matplotlib functions.
+
+## Sizing
+Matching the matplotlib figure size to the final display size of the figure is critically important: scaling to a different height will change font sizes and line widths.
+
+We include the following breakpoints, with respect to the available width and height (`H`) of the chosen medium:
+| Breakpoint | Ratio |
+| -- | -- |
+| `F` | 100% _("full")_ |
+| `TT` | 2/3 _("two-thirds")_ |
+| `H` | 1/2 _("half")_ |
+| `FT` | 5/12 _("five-twelfth")_ |
+| `T` | 1/3 _("third")_ |
+| `Q` | 1/4 _("quarter")_ |
+| `R` | 1/5 |
+| `S` | 1/6 |
+
+To specify the size using a breakpoint, append `W` (width) or `H` (height). For example, `wedme.figure.a0_hw_hh()` specifies the `a0` style, with a size of half the A0 width and height.
+
+In addition to the breakpoints, some styles include custom sizes:
+- `paper`: `CW` (column width) for two-column papers. `GH` is the height that corresponds to the golden-ratio of `CW`.
+- `thesis`: `LFW` and `LFH` for the landscape full-width and full-height.
+The default width and height `DW` and `DH` correspond to `CW` and `GH` of the `paper` style
+
+</br>
+
+When no size is specified, the following defaults sizes are used:
+- `paper`: `(wedme.PAPER_CW, wedme.paper_GH)`
+- `slide`: `(wedme.SLIDE_TTW, wedme.slide_TTH)`
+- `a0`:  `(wedme.A0_TW, ...)`
+- `thesis`: `(wedme.THESIS_DW, wedme.paper_DH)`
+
+
+## Powerpoint
+Powerpoint automatically resizes artwork to a size that is different from the export size. To undo this:
+- Insert the figure in Powerpoint.
+- Picture Format > Reset Picture > Reset Picture & Size.
+
+## Fonts
+Sans-serif fonts are the standards for figures because they remain readable even when small or pixelated. Helvetica or Arial fonts are preferred by Nature, Science and Elsevier. 
+
+We try to find Helvetica, Arial, Verdana, Inter, Nimbus Sans on your system, in that order. The first font found will be applied to the figures.
+
+## Exporting
+`wedme` sets the `pdf.fonttype` parameter to `42` as recommended by Nature. This ensures that the text is editable even after exporting a pdf. `wedme` also changes the parameters `figure.autolayout` and `savefig.bbox` such that the specified sizes are respected.
+
+For saving figures, consider using [pypdfplot](https://github.com/dcmvdbekerom/pypdfplot) to maintain the ability to later change how data is displayed. Of course, we don't make embarassing plots to begin with.
+
+## Examples
+<img src="https://github.com/mruijzendaal/wedme-plots/blob/main/img/calibration_curve_rot.png?raw=true" width="512">
+
+## Utilities
+Other than style sheets, wedme also includes utilities for commonly used operations.
+- Creating animated GIF images from multiple plots. See `wedme.gif`
+- Creating a legend only for unique entries. See `wedme.util.unique_legend()`
+- Specifying the colorbar label easily. See `wedme.util.colorbar()`
+- Specifying the minimum and maximum of the colorbar as a function of percentiles of the shown field. See `wedme.util.imshow()`
+- Making plot colors dependent on some variable. See `weme.util.get_colormap_norm()`

{wedme-plots-2.0 → wedme_plots-2.0.5}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "wedme-plots"
-version = "2.0"
-description = "We Don't Make Embarrassing Plots. Matplotlib styles for papers, posters and presentations."
+version = "2.0.5"
+description = "We Don't Make Embarrassing Plots. Matplotlib styles for papers, posters, presentations and theses."
 readme = "README.md"
 authors = [{ name = "Martijn Ruijzendaal", email = "martijn.ruijzendaal@gmail.com" }]
 license = { file = "LICENSE" }
@@ -15,7 +15,7 @@ classifiers = [
     "Programming Language :: Python :: 3",
 ]
 keywords = ["matplotlib"]
-dependencies = ["matplotlib"]
+dependencies = ["matplotlib", "importlib_resources"]
 requires-python = ">=3.7"
 
     [project.optional-dependencies]

{wedme-plots-2.0 → wedme_plots-2.0.5}/src/wedme/__init__.py

@@ -8,6 +8,11 @@ Import the `wedme` module to apply styles:
 """
 
 # Standard library imports
+import wedme.util as util
 from wedme.util import imshow, colorbar, get_colormap_norm, unique_legend
-from wedme.styledefs import dev, paper, poster, slide, figure, reset
+from wedme.styledefs import reset, dev, paper, poster, slide, thesis, a0
+from wedme.shorthands import figure, subplots, apply
 from wedme.const import *
+from wedme.gif import GifMaker
+from wedme import scale
+from wedme.saving import savefig

wedme_plots-2.0.5/src/wedme/apply/a0.py

@@ -0,0 +1,3 @@
+import wedme
+
+wedme.a0()

wedme_plots-2.0.5/src/wedme/apply/dev.py

@@ -0,0 +1,3 @@
+import wedme
+
+wedme.dev()

wedme_plots-2.0.5/src/wedme/apply/paper.py

@@ -0,0 +1,3 @@
+import wedme
+
+wedme.paper()

wedme_plots-2.0.5/src/wedme/apply/slides.py

@@ -0,0 +1,3 @@
+import wedme
+
+wedme.slides()

wedme_plots-2.0.5/src/wedme/apply/thesis.py

@@ -0,0 +1,3 @@
+import wedme
+
+wedme.thesis()

wedme_plots-2.0.5/src/wedme/const.py

@@ -0,0 +1,68 @@
+## Size definitions
+_MM_TO_INCH = 0.0393700787
+_PT_TO_MM = 0.3515
+_PT_TO_INCH = _PT_TO_MM * _MM_TO_INCH
+GOLDEN_RATIO = 1.61803398875
+
+SIZE_SM = 30 * _MM_TO_INCH
+SIZE_10 = 90 * _MM_TO_INCH
+SIZE_15 = 140 * _MM_TO_INCH
+SIZE_20 = 190 * _MM_TO_INCH
+
+# Papers (Science, Nature, Elsevier) # TODO: split
+# Width
+PAPER_SCW = 121.095 * _MM_TO_INCH
+PAPER_HSCW = PAPER_SCW / 2
+PAPER_CW = 90 * _MM_TO_INCH
+PAPER_FW = 190 * _MM_TO_INCH
+# Height
+PAPER_DH = PAPER_CW / GOLDEN_RATIO
+PAPER_GH = PAPER_CW / GOLDEN_RATIO
+PAPER_PH = 550 * _PT_TO_INCH
+PAPER_PW = 345 * _PT_TO_INCH
+
+# Thesis
+THESIS_PW = 6.9  # page width
+THESIS_PH = 9.8  # page height
+THESIS_DW = 90 * _MM_TO_INCH  # approximately half the page
+THESIS_DH = THESIS_DW / GOLDEN_RATIO
+# Landscape
+THESIS_LFW = THESIS_PH  # TODO: subtract margins
+THESIS_LFH = THESIS_PW
+
+# 16:9 slides
+# Width
+SLIDE_FW = 10
+SLIDE_TTW = SLIDE_FW * 2 / 3
+SLIDE_HW = SLIDE_FW / 2
+SLIDE_FTW = SLIDE_FW * 5 / 12
+SLIDE_TW = SLIDE_FW / 3
+SLIDE_QW = SLIDE_FW / 4
+SLIDE_RW = SLIDE_FW / 5
+SLIDE_SW = SLIDE_FW / 6
+# Height
+SLIDE_FH = SLIDE_FW * 9 / 16
+SLIDE_HH = SLIDE_FH / 2
+SLIDE_TTH = SLIDE_FH * 2 / 3
+SLIDE_FTH = SLIDE_FH * 5 / 12
+SLIDE_TH = SLIDE_FH / 3
+SLIDE_QH = SLIDE_FH / 4
+SLIDE_RH = SLIDE_FH / 5
+SLIDE_SH = SLIDE_FH / 6
+
+
+# A0 poster
+# Height
+A0_FH = 46.8
+A0_HH = A0_FH / 2
+A0_TH = A0_FH / 3
+A0_QH = A0_FH / 4
+A0_RH = A0_FH / 5
+A0_SH = A0_FH / 6
+# Width
+A0_FW = 33.1
+A0_HW = A0_FW / 2
+A0_TW = A0_FW / 3
+A0_QW = A0_FW / 4
+A0_RW = A0_FW / 5
+A0_SW = A0_FW / 6

wedme_plots-2.0.5/src/wedme/gif.py

@@ -0,0 +1,155 @@
+import tempfile
+import subprocess
+import matplotlib.pyplot as plt
+
+
+def _run_command(command, silent=False, **kwargs):
+    """Run a command while printing the live output"""
+    try:
+        process = subprocess.Popen(
+            command,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.STDOUT,
+            **kwargs,
+        )
+        while True:
+            line = process.stdout.readline()
+            if not line and process.poll() is not None:
+                break
+            if not silent:
+                print(line.decode(), end="")
+    except Exception as e:
+        return None
+    return process.returncode
+
+
+def create_gif(frames, outname, resize_fac=1.0, frametime_ms=800):
+    """
+    Create a GIF from a list of frames.
+
+    Args:
+        frames (str): The path to the frames to be included in the GIF.
+        outname (str): The path and filename of the output GIF.
+        resize_fac (float, optional): The resize factor for the frames. Defaults to 1.0.
+        frametime_ms (int, optional): The time (in milliseconds) between frames. Defaults to 800.
+
+    Returns:
+        None
+    """
+
+    delay_ms = round(frametime_ms / 10)
+    _run_command(
+        [
+            "convert",
+            "-resize",
+            f"{resize_fac*100:.0f}%",
+            "-delay",
+            f"{delay_ms:.0f}",
+            "-loop",
+            "0",
+            frames,
+            outname,
+        ]
+    )
+
+
+def _check_imagemagick():
+    return _run_command(["convert", "-version"], silent=True) == 0
+
+
+class GifMaker(object):
+    """Class for creating GIFs from matplotlib figures using ImageMagick.
+
+    Example usage:
+    ```python
+    import wedme
+    import matplotlib.pyplot as plt
+
+    gif = wedme.GifMaker()
+    for i in range(10):
+        plt.plot(range(10), [i]*10)
+        gif.save_frame()
+
+    gif.close("test.gif")
+    ```
+    """
+
+    _is_open = False
+    _frames = []
+    _tempdir = None
+
+    def __init__(self):
+        self.clean()
+        if not _check_imagemagick():
+            raise RuntimeError(
+                "Cannot create GIFs without ImageMagick installed. Download from https://imagemagick.org/script/download.php"
+            )
+
+    def clean(self):
+        """Removes any currently saved frames and resets the object to a clean state"""
+        if self._tempdir:
+            self._tempdir.cleanup()
+        else:
+            self._tempdir = tempfile.TemporaryDirectory()
+
+        self._frames = []
+        self._is_open = True
+
+    def save_frame(self, fig=None, name=None):
+        """
+        Save a frame of the given figure as a PNG image.
+
+        Args:
+            fig (matplotlib.figure.Figure, optional): The figure to save. If not provided, the current figure will be used.
+            name (str, optional): The name of the saved image file. This will be used for ordering the frames in the GIF. If not provided, the order in which the frames are saved will be used.
+
+        Returns:
+            None
+
+        Raises:
+            None
+        """
+        if fig is None:
+            fig = plt.gcf()
+
+        if name is None:
+            name = f"{len(self._frames):06d}"
+        name += ".png"
+        fig.savefig(f"{self._tempdir.name}/{name}")
+        self._frames.append(f"{self._tempdir.name}/{name}")
+
+    def save(self, outname, frametime_ms=800, resize_fac=1.0):
+        """
+        Save the GIF animation. NB: This does not close the object, so you can continue adding frames after saving.
+        If this behaviour is not desired, call `close` instead.
+
+        Args:
+            outname (str): The output filename for the GIF.
+            frametime_ms (int, optional): The time in milliseconds between frames. Defaults to 800.
+            resize_fac (float, optional): The factor by which to resize the frames. Defaults to 1.0.
+        """
+        create_gif(f"{self._tempdir.name}/*.png", outname, resize_fac, frametime_ms)
+
+    def close(self, outname):
+        """
+        Closes the GIF file by saving it and performing any necessary cleanup.
+
+        Args:
+            outname (str): The name of the output file.
+
+        Returns:
+            None
+        """
+        self.save(outname)
+        self.clean()
+
+
+if __name__ == "__main__":
+    import matplotlib.pyplot as plt
+
+    gif = GifMaker()
+    for i in range(10):
+        plt.plot(range(10), [i] * 10)
+        gif.save_frame(plt)
+
+    gif.close("test.gif")

wedme_plots-2.0.5/src/wedme/saving.py

@@ -0,0 +1,41 @@
+from typing import Union
+import matplotlib.pyplot as plt
+from matplotlib.figure import Figure
+from pathlib import Path
+from datetime import datetime
+
+
+def savefig(
+    pathstub,
+    fig: Union[Figure, None] = None,
+    format=[".png", ".pdf"],
+    dpi=1000,
+    history=False,
+):
+    # If multiple formats are given, recursively call this function for each
+    if type(format) == list:
+        for f in format:
+            savefig(pathstub, fig, f, dpi, history)
+        return
+
+    # If a figure handle is given, make sure it is displayed
+    if fig is not None:
+        fig.show()
+
+    path = Path(pathstub).with_suffix(format)
+    path.parent.mkdir(exist_ok=True)
+
+    # If history is enabled, save a copy of the figure in the history directory
+    if history:
+        dir_history = path.parent / "history"
+
+        savefig(
+            dir_history / f"{path.stem}_{datetime.now().strftime(r'%Y%m%d-%H%M%S')}",
+            fig,
+            format,
+            dpi,
+            history=False,
+        )
+
+    # Save the figure
+    plt.savefig(path, dpi=dpi, facecolor="#00f0", pad_inches=0)

wedme_plots-2.0.5/src/wedme/scale/__init__.py

@@ -0,0 +1 @@
+from wedme.scale.custom_func_scale import CustomFuncScale