pub-ready-plots 0.1.0__tar.gz

pub_ready_plots-0.1.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.1
+Name: pub-ready-plots
+Version: 0.1.0
+Summary: Easy publication-ready matplotlib plots for ML papers and posters.
+Author-Email: Agustinus Kristiadi <agustinus@kristia.de>
+License: MIT
+Requires-Python: >=3.10
+Requires-Dist: matplotlib>=3.9.0
+Description-Content-Type: text/markdown
+
+# Agustinus' _Very_ Opiniated Publication-Ready Plotting Library
+
+I love TikZ. I love [tikzplotlib](https://github.com/nschloe/tikzplotlib). I've been an
+advocate for the latter ([proof](https://agustinus.kristia.de/techblog/2022/05/01/plotting/)). However, tikzplotlib is [as good as dead](https://github.com/nschloe/tikzplotlib/commits/main/). I need to move on.
+
+> [!IMPORTANT]
+> Here's what I use now for all my publication needs. This library is designed to be
+> _*very*_ opiniated. Beauty is in the eye of the beholder. Also, it is _very_ simple,
+> just a single file and that's it.
+
+> [!NOTE]
+> Of course I still use TikZ whenever possible (e.g. Fig. 1 in a paper, diagrams, etc.)
+
+## Installation
+
+Still with me? Still want to use this library? Here's how:
+
+```bash
+pip install pub-ready-plots
+```
+
+## Usage
+
+```python
+rc_params, fig_width_in, fig_height_in = pub_ready_plots.get_mpl_rcParams(
+    width=1,  # between 0 and 1
+    height=0.1,  # between 0 and 1
+    layout="icml"  # or "iclr", "neurips", "poster-portrait", "poster-landscape"
+)
+plt.rcParams.update(rc_params)
+
+fig, axs = plt.subplots(
+    nrows,
+    ncols,
+    constrained_layout=True, # Important!
+)
+fig.set_size_inches(fig_width_in, fig_height_in)
+
+# Your plot here!
+
+plt.savefig("filename.pdf")
+```
+
+Then in your LaTeX file, include the plot as follows:
+
+```tex
+\includegraphics[width=\linewidth]{filename.pdf}
+```
+
+The argument `width=\linewidth` is important!
+
+> [!TIP]
+> That's it!
+
+## Using your own styles
+
+Two options:
+
+1. For this repo and modify things as you wish.
+2. Use this library and update the resulting `rc_params` dict with your styles.
+
+## Other libraries
+
+Check out [tueplots](https://github.com/pnkraemer/tueplots) if you want a more complex
+library. My library is designed to achieve what I want in publication-ready papers and
+posters, with as little code as possible (minimalism FTW!).

pub_ready_plots-0.1.0/README.md

@@ -0,0 +1,66 @@
+# Agustinus' _Very_ Opiniated Publication-Ready Plotting Library
+
+I love TikZ. I love [tikzplotlib](https://github.com/nschloe/tikzplotlib). I've been an
+advocate for the latter ([proof](https://agustinus.kristia.de/techblog/2022/05/01/plotting/)). However, tikzplotlib is [as good as dead](https://github.com/nschloe/tikzplotlib/commits/main/). I need to move on.
+
+> [!IMPORTANT]
+> Here's what I use now for all my publication needs. This library is designed to be
+> _*very*_ opiniated. Beauty is in the eye of the beholder. Also, it is _very_ simple,
+> just a single file and that's it.
+
+> [!NOTE]
+> Of course I still use TikZ whenever possible (e.g. Fig. 1 in a paper, diagrams, etc.)
+
+## Installation
+
+Still with me? Still want to use this library? Here's how:
+
+```bash
+pip install pub-ready-plots
+```
+
+## Usage
+
+```python
+rc_params, fig_width_in, fig_height_in = pub_ready_plots.get_mpl_rcParams(
+    width=1,  # between 0 and 1
+    height=0.1,  # between 0 and 1
+    layout="icml"  # or "iclr", "neurips", "poster-portrait", "poster-landscape"
+)
+plt.rcParams.update(rc_params)
+
+fig, axs = plt.subplots(
+    nrows,
+    ncols,
+    constrained_layout=True, # Important!
+)
+fig.set_size_inches(fig_width_in, fig_height_in)
+
+# Your plot here!
+
+plt.savefig("filename.pdf")
+```
+
+Then in your LaTeX file, include the plot as follows:
+
+```tex
+\includegraphics[width=\linewidth]{filename.pdf}
+```
+
+The argument `width=\linewidth` is important!
+
+> [!TIP]
+> That's it!
+
+## Using your own styles
+
+Two options:
+
+1. For this repo and modify things as you wish.
+2. Use this library and update the resulting `rc_params` dict with your styles.
+
+## Other libraries
+
+Check out [tueplots](https://github.com/pnkraemer/tueplots) if you want a more complex
+library. My library is designed to achieve what I want in publication-ready papers and
+posters, with as little code as possible (minimalism FTW!).

pub_ready_plots-0.1.0/pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = "pub-ready-plots"
+version = "0.1.0"
+description = "Easy publication-ready matplotlib plots for ML papers and posters."
+authors = [
+    { name = "Agustinus Kristiadi", email = "agustinus@kristia.de" },
+]
+dependencies = [
+    "matplotlib>=3.9.0",
+]
+requires-python = ">=3.10"
+readme = "README.md"
+
+[project.license]
+text = "MIT"
+
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[tool.pdm]
+distribution = true
+
+[tool.pytest.ini_options]
+pythonpath = [
+    "src",
+]

pub_ready_plots-0.1.0/src/pub_ready_plots/__init__.py

@@ -0,0 +1,3 @@
+from pub_ready_plots.pub_ready_plots import get_mpl_rcParams
+
+__all__ = ["get_mpl_rcParams"]

pub_ready_plots-0.1.0/src/pub_ready_plots/pub_ready_plots.py

@@ -0,0 +1,167 @@
+from typing import Any
+
+import matplotlib as mpl
+import matplotlib.font_manager as font_manager
+
+cmfont = font_manager.FontProperties(fname=mpl.get_data_path() + "/fonts/ttf/cmr10.ttf")
+FONT_NAME_CM = cmfont.get_name()
+FONT_NAME_TNR = "Times New Roman"
+FONT_NAME_AVENIR = "Avenir Next Condensed"
+
+PAPER_FORMATS = {
+    "icml": {
+        "text_width": 6.00117,
+        "col_width": 3.25063,
+        "text_height": 8.50166,
+        "font_name": FONT_NAME_TNR,
+        "footnote_size": 8,
+        "script_size": 7,
+        "linewidth": 1.25,
+        "tick_size": 1,
+        "tick_width": 1,
+    },
+    "neurips": {
+        "text_width": 5.50107,
+        "col_width": 5.50107,
+        "text_height": 9.00177,
+        "font_name": FONT_NAME_TNR,
+        "footnote_size": 8,
+        "script_size": 7,
+        "linewidth": 1.25,
+        "tick_size": 1,
+        "tick_width": 1,
+    },
+    "iclr": {
+        "text_width": 5.50107,
+        "col_width": 5.50107,
+        "text_height": 9.00177,
+        "font_name": FONT_NAME_TNR,
+        "footnote_size": 8,
+        "script_size": 7,
+        "linewidth": 1.25,
+        "tick_size": 1,
+        "tick_width": 1,
+    },
+    "jmlr": {
+        "text_width": 6.00117,
+        "col_width": 6.00117,
+        "text_height": 8.50166,
+        "font_name": FONT_NAME_CM,
+        "footnote_size": 8,
+        "script_size": 7,
+        "linewidth": 1.25,
+        "tick_size": 1,
+        "tick_width": 1,
+    },
+    "poster-landscape": {
+        "text_width": 6.00117,
+        "col_width": 6.00117,
+        "text_height": 8.50166,
+        "font_name": FONT_NAME_AVENIR,
+        "footnote_size": 30,
+        "script_size": 23,
+        "linewidth": 3,
+        "tick_size": 4,
+        "tick_width": 2,
+    },
+    "poster-portrait": {
+        "text_width": 6.00117,
+        "col_width": 6.00117,
+        "text_height": 8.50166,
+        "font_name": FONT_NAME_AVENIR,
+        "footnote_size": 10,
+        "script_size": 8,
+        "linewidth": 1,
+        "tick_size": 1,
+        "tick_width": 1,
+    },
+}
+
+
+def get_mpl_rcParams(
+    width_frac: float,
+    height_frac: float,
+    layout: str = "neurips",
+    single_col: bool = False,
+) -> tuple[dict[str, Any], float, float]:
+    """Get matplotlib rcParams dict and fig width & height in inches, depending on the
+    chosen layout and fractional width and height. Fractional here in the sense that
+    The resulting fig width/height in inches is calculated as `width_frac\\linewidth` and
+    `height_frac\\textheight` in LaTeX. Usage:
+
+    ```python
+        rc_params, fig_width_in, fig_height_in = pub_ready_plots.get_mpl_rcParams(
+            width=fig_width_frac, height=fig_height_frac, layout="icml"
+        )
+        plt.rcParams.update(rc_params)
+
+        fig, axs = plt.subplots(
+            nrows,
+            ncols,
+            constrained_layout=True, # Important!
+        )
+        fig.set_size_inches(fig_width_in, fig_height_in)
+
+        # Your plot here!
+
+        plt.savefig("filename.pdf")
+    ```
+
+    Then in your LaTeX file, include the plot as follows:
+
+    ```tex
+        \\includegraphics[width=\\linewidth]{filename.pdf}
+    ```
+
+    The arg. `width=\\linewidth` is important!
+
+    Args:
+        width_frac: Fraction of `\\linewidth` as the figure width. Usually set to 1.
+        height_frac: Fraction of `\\textheight` as the figure height. Try 0.175.
+        layout: The LaTeX template used. Possible values are "icml", "iclr", "neurips",
+            "jmlr", "poster-portrait" (A1, 2-column), and "poster-landscape" (A0, 3-col).
+        single_col: Whether the plot is single column in a layout that has two columns
+            (e.g. ICML). Not supported for any other layout.
+
+    Returns:
+        rc_params: Matplotlib key-value rc-params. Use it via
+            `plt.rcParams.update(rc_params)`. Note that you can always override/add
+            key-values to this dict before applying it.
+        fig_width_in: figure width in inches.
+        fig_height_in: figure height in inches.
+    """
+    if (width_frac <= 0 or width_frac > 1) or (height_frac <= 0 or height_frac > 1):
+        raise ValueError("Both `width_frac` and `height_frac` must be between 0 and 1.")
+
+    if layout not in PAPER_FORMATS.keys():
+        raise ValueError(f"Layout must be in {list(PAPER_FORMATS.keys())}.")
+
+    if layout not in ["icml"] and single_col:
+        raise ValueError("Double-column is only supported for ICML.")
+
+    format = PAPER_FORMATS[layout]
+    is_poster = "poster" in layout
+
+    rc_params = {
+        "text.usetex": False,
+        "font.size": format["footnote_size"],
+        "font.family": "serif",
+        "font.serif": format["font_name"],
+        "mathtext.fontset": "stixsans" if is_poster else "cm",
+        "lines.linewidth": format["linewidth"],
+        "axes.linewidth": 1,
+        "axes.titlesize": format["footnote_size"],
+        "axes.labelsize": format["script_size"],
+        "axes.unicode_minus": False,
+        "axes.formatter.use_mathtext": True,
+        "legend.fontsize": format["script_size"],
+        "xtick.major.size": format["tick_size"],
+        "ytick.major.size": format["tick_size"],
+        "xtick.major.width": format["tick_width"],
+        "ytick.major.width": format["tick_width"],
+    }
+
+    w = width_frac * (format["col_width"] if single_col else format["text_width"])
+    h = height_frac * format["text_height"]
+
+    return rc_params, w, h

pub_ready_plots-0.1.0/tests/test_core_func.py

@@ -0,0 +1,39 @@
+import matplotlib as plt
+import pytest
+
+from pub_ready_plots import get_mpl_rcParams
+
+LAYOUTS = ["icml", "iclr", "neurips", "jmlr", "poster-portrait", "poster-landscape"]
+
+
+@pytest.mark.parametrize("layout", LAYOUTS)
+def test_correct_func(layout):
+    rc_params, width_in, height_in = get_mpl_rcParams(1, 0.15, layout)
+    plt.rcParams.update(rc_params)
+
+
+def test_incorrect_width():
+    with pytest.raises(ValueError):
+        _, _, _ = get_mpl_rcParams(12, 0.1, "iclr")
+
+    with pytest.raises(ValueError):
+        _, _, _ = get_mpl_rcParams(0, 0.1, "iclr")
+
+    with pytest.raises(ValueError):
+        _, _, _ = get_mpl_rcParams(-3.2, 0.1, "iclr")
+
+
+def test_incorrect_height():
+    with pytest.raises(ValueError):
+        _, _, _ = get_mpl_rcParams(0.15, 12, "iclr")
+
+    with pytest.raises(ValueError):
+        _, _, _ = get_mpl_rcParams(0.15, 0, "iclr")
+
+    with pytest.raises(ValueError):
+        _, _, _ = get_mpl_rcParams(0.15, -1.2, "iclr")
+
+
+def test_incorrect_layout():
+    with pytest.raises(ValueError):
+        _, _, _ = get_mpl_rcParams(1, 1, "predatory_journal")