charite-plot 0.1.1__tar.gz → 0.2.0__tar.gz

{charite_plot-0.1.1 → charite_plot-0.2.0}/CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2026-07-01
+
+### Added
+
+- `theme_charite` (matplotlib) gained `interactive` and `tiny_margins` parameters.
+- `theme_charite` (Altair) gained `thickness` and `tiny_margins` parameters, bringing it to parity with the matplotlib backend.
+
+### Changed
+
+- Font-size ramp is now shared between both backends: labels scale at 1× and legend text at 0.8× the base size. Altair legend labels are slightly smaller and axis labels slightly larger as a result.
+
 ## [0.1.1] - 2026-06-13
 
 ### Fixed

charite_plot-0.2.0/CITATION.cff

@@ -0,0 +1,19 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+type: software
+title: "charite-plot: Matplotlib and Altair Themes for Charité – Universitätsmedizin Berlin"
+authors:
+  - family-names: Ramezani
+    given-names: Pedram
+    email: pedram.ramezani@charite.de
+version: 0.2.0
+date-released: 2026-07-01
+license: MIT
+url: "https://github.com/pedramezani/charite-plot"
+repository-code: "https://github.com/pedramezani/charite-plot"
+keywords:
+  - matplotlib
+  - altair
+  - theme
+  - visualization
+  - charite

{charite_plot-0.1.1 → charite_plot-0.2.0}/LICENSE.md

@@ -7,3 +7,7 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 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.
+
+---
+
+This package is based on the original `charite` R package developed by Johannes Julius Mohn (https://github.com/johannesjuliusm/charite), which is also distributed under the MIT License.

{charite_plot-0.1.1 → charite_plot-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: charite-plot
-Version: 0.1.1
+Version: 0.2.0
 Summary: Matplotlib and Altair themes for Charité – Universitätsmedizin Berlin
 Project-URL: Homepage, https://github.com/pedramezani/charite-plot
 Project-URL: Documentation, https://pedramezani.github.io/charite-plot
@@ -17,6 +17,10 @@ License: # MIT License
         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.
+        
+        ---
+        
+        This package is based on the original `charite` R package developed by Johannes Julius Mohn (https://github.com/johannesjuliusm/charite), which is also distributed under the MIT License.
 License-File: LICENSE.md
 Keywords: altair,charite,matplotlib,theme,visualization
 Classifier: Development Status :: 3 - Alpha
@@ -140,6 +144,27 @@ The fallback chain follows the official Charité brand guidelines:
 apply_theme(theme_charite(font="Arial"))
 ```
 
+## How to cite
+
+If you use charite-plot in your work, please cite it as:
+
+```bibtex
+@software{ramezani2026chariteplot,
+  author    = {Ramezani, Pedram},
+  title     = {charite-plot: Matplotlib and Altair Themes for Charité – Universitätsmedizin Berlin},
+  year      = {2026},
+  version   = {0.2.0},
+  url       = {https://github.com/pedramezani/charite-plot},
+  license   = {MIT},
+}
+```
+
+## Acknowledgements
+
+This package is based on the original [`charite` R package](https://github.com/johannesjuliusm/charite) developed by Johannes Julius Mohn.
+
 ## License
 
 MIT © 2026 Pedram Ramezani
+
+The original `charite` R package by Johannes Julius Mohn is likewise MIT licensed.

{charite_plot-0.1.1 → charite_plot-0.2.0}/README.md

@@ -91,6 +91,27 @@ The fallback chain follows the official Charité brand guidelines:
 apply_theme(theme_charite(font="Arial"))
 ```
 
+## How to cite
+
+If you use charite-plot in your work, please cite it as:
+
+```bibtex
+@software{ramezani2026chariteplot,
+  author    = {Ramezani, Pedram},
+  title     = {charite-plot: Matplotlib and Altair Themes for Charité – Universitätsmedizin Berlin},
+  year      = {2026},
+  version   = {0.2.0},
+  url       = {https://github.com/pedramezani/charite-plot},
+  license   = {MIT},
+}
+```
+
+## Acknowledgements
+
+This package is based on the original [`charite` R package](https://github.com/johannesjuliusm/charite) developed by Johannes Julius Mohn.
+
 ## License
 
 MIT © 2026 Pedram Ramezani
+
+The original `charite` R package by Johannes Julius Mohn is likewise MIT licensed.

{charite_plot-0.1.1 → charite_plot-0.2.0}/charite_plot/__init__.py

@@ -26,5 +26,5 @@ from .palettes import PALETTES, make_palette  # noqa: F401
 from . import mpl_themes  # noqa: F401
 from . import altair_themes  # noqa: F401
 
-__version__ = "0.1.1"
+__version__ = "0.2.0"
 __author__ = "Pedram Ramezani"

charite_plot-0.2.0/charite_plot/_theme_common.py

@@ -0,0 +1,55 @@
+"""Shared theme primitives for the matplotlib and Altair backends.
+
+These small ``NamedTuple`` structures keep the per-backend theme builders
+readable by giving names to the derived size/margin values. The font-size
+ratios are shared so both backends scale identically from their base size
+(matplotlib works in points, Altair in pixels, but the ratios are the same).
+"""
+
+from typing import NamedTuple
+
+
+class FontSizes(NamedTuple):
+    """Derived font sizes, all scaled from the base ``font_size``."""
+    title: float
+    subtitle: float
+    label: float
+    legend: float
+
+
+class Margins(NamedTuple):
+    """Derived margins/paddings around the plot panel.
+
+    ``wspace`` / ``hspace`` are subplot-spacing fractions used only by the
+    matplotlib backend; they default to ``0`` so the Altair backend can build
+    a ``Margins`` without supplying them.
+    """
+    title: float
+    label: float
+    legend: float
+    wspace: float = 0.0
+    hspace: float = 0.0
+
+
+class Thickness(NamedTuple):
+    """Derived line widths, scaled from the base ``thickness``.
+
+    ``lines`` / ``patches`` are matplotlib-specific defaults; they carry
+    defaults so the Altair backend can build a ``Thickness`` from just the
+    axis-related widths.
+    """
+    axes: float
+    grid: float
+    ticks: float
+    lines: float = 1.5
+    patches: float = 0.0
+
+
+def resolve_font_sizes(font_size: float) -> FontSizes:
+    """Return the standard Charité font-size ramp derived from *font_size*."""
+    return FontSizes(
+        title=round(font_size * 1.2),
+        subtitle=font_size,
+        label=font_size,
+        legend=round(font_size * 0.8),
+    )

{charite_plot-0.1.1 → charite_plot-0.2.0}/charite_plot/altair_themes.py

@@ -8,17 +8,20 @@ Register and enable with::
     enable(font="Arial", font_size=13)    # font override
 """
 
+from __future__ import annotations
+
 from .colors import (
     BLACK, WHITE, TEXT_GREY, PRIME_BLUE, PRIME_LGREY,
     SECOND_DBLUE, KORALL,
 )
 from .palettes import PALETTES
 from .fonts import build_font_stack
+from ._theme_common import Margins, Thickness, resolve_font_sizes
 
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from altair.theme import ThemeConfig
+    from altair.theme import AxisConfigKwds, ThemeConfig
 
 
 def _css_font_stack(preferred: str | None) -> str:
@@ -32,10 +35,12 @@ def _css_font_stack(preferred: str | None) -> str:
 def theme_charite(
     font: str | None = None,
     font_size: int = 12,
+    thickness: float = 0.5,
     grid: bool = False,
     palette: str | list[str] = "primary",
     background: str = "white",
-) -> "ThemeConfig":
+    tiny_margins: bool = False,
+) -> ThemeConfig:
     """Return an Altair theme config dict for the Charité corporate theme.
 
     Parameters
@@ -44,78 +49,95 @@ def theme_charite(
         Preferred font. Falls back through Charité Text Office → Charit? Text Office → Calibri → DejaVu Sans → sans-serif.
     font_size:
         Base font size in pixels.
+    thickness:
+        Axis line and tick width.
     grid:
         Show axis grid lines.
     palette:
         Built-in palette name or list of hex colors for the categorical range.
     background:
         Chart background color.
+    tiny_margins:
+        Minimise all paddings around the chart.
     """
     colors = PALETTES[palette] if isinstance(palette, str) else list(palette)
-    font_str = _css_font_stack(preferred=font)
-    label_size = font_size - 1
-    title_size = round(font_size * 1.2)
-
-    axis = {
-        "labelFont":     font_str,
-        "titleFont":     font_str,
-        "labelFontSize": label_size,
-        "titleFontSize": font_size,
+    font_stack = _css_font_stack(preferred=font)
+
+    FONT_SIZES = resolve_font_sizes(font_size)
+    MARGINS = Margins(
+        title=8 if tiny_margins else 12,   # chart title offset
+        label=3 if tiny_margins else 6,    # axis / legend title padding
+        legend=2 if tiny_margins else 4,   # legend inner padding
+    )
+    THICKNESS = Thickness(
+        axes=thickness,          # domain line width
+        grid=thickness * 0.8,    # grid line width
+        ticks=thickness,         # tick mark width
+        lines=2,                 # line-mark stroke width (independent of thickness)
+        patches=0.4,             # geoshape stroke width
+    )
+    CHART_PAD = 6 if tiny_margins else 10
+
+    axis: AxisConfigKwds = {
+        "labelFont":     font_stack,
+        "titleFont":     font_stack,
+        "labelFontSize": FONT_SIZES.label,
+        "titleFontSize": FONT_SIZES.subtitle,
         "labelColor":    TEXT_GREY,
         "titleColor":    TEXT_GREY,
-        "titlePadding":  6,
+        "titlePadding":  MARGINS.label,
         "domain":        True,
         "domainColor":   BLACK,
-        "domainWidth":   0.5,
+        "domainWidth":   THICKNESS.axes,
         "ticks":         True,
         "tickColor":     BLACK,
-        "tickWidth":     0.5,
+        "tickWidth":     THICKNESS.ticks,
         "tickSize":      4,
         "grid":          grid,
         "gridColor":     PRIME_LGREY,
-        "gridWidth":     0.4,
-        "gridOpacity":   0.8,
+        "gridWidth":     THICKNESS.grid,
+        "gridOpacity":   0.85,
     }
 
     return {
         "config": {
             "background": background,
-            "font":       font_str,
-            "padding":    {"top": 10, "bottom": 10, "left": 10, "right": 10},
+            "font":       font_stack,
+            "padding":    {"top": CHART_PAD, "bottom": CHART_PAD, "left": CHART_PAD, "right": CHART_PAD},
             "view":  {"stroke": None},
             "axis":  axis,
             "axisX": axis,
             "axisY": axis,
             "legend": {
-                "labelFont":     font_str,
-                "titleFont":     font_str,
-                "labelFontSize": label_size,
-                "titleFontSize": font_size,
+                "labelFont":     font_stack,
+                "titleFont":     font_stack,
+                "labelFontSize": FONT_SIZES.legend,
+                "titleFontSize": FONT_SIZES.subtitle,
                 "labelColor":    TEXT_GREY,
                 "titleColor":    TEXT_GREY,
-                "titlePadding":  6,
-                "padding":       4,
-                "rowPadding":    3,
+                "titlePadding":  MARGINS.label,
+                "padding":       MARGINS.legend,
+                "rowPadding":    FONT_SIZES.legend / 4,
                 "symbolSize":    100,
             },
             "header": {
-                "labelFont":       font_str,
-                "titleFont":       font_str,
-                "labelFontSize":   label_size,
-                "titleFontSize":   font_size,
+                "labelFont":       font_stack,
+                "titleFont":       font_stack,
+                "labelFontSize":   FONT_SIZES.label,
+                "titleFontSize":   FONT_SIZES.subtitle,
                 "labelColor":      WHITE,
                 "titleColor":      PRIME_BLUE,
                 "labelBackground": PRIME_BLUE,
             },
             "title": {
-                "font":             font_str,
-                "subtitleFont":     font_str,
-                "fontSize":         title_size,
-                "subtitleFontSize": font_size,
+                "font":             font_stack,
+                "subtitleFont":     font_stack,
+                "fontSize":         FONT_SIZES.title,
+                "subtitleFontSize": FONT_SIZES.subtitle,
                 "color":            PRIME_BLUE,
                 "subtitleColor":    TEXT_GREY,
                 "anchor":           "middle",
-                "offset":           12,
+                "offset":           MARGINS.title,
             },
             "range": {
                 "category":  colors,
@@ -125,13 +147,13 @@ def theme_charite(
                 "ramp":      ["#ffffff", PRIME_BLUE],
             },
             "bar":      {"color": colors[0], "binSpacing": 1},
-            "line":     {"color": colors[0], "strokeWidth": 2},
+            "line":     {"color": colors[0], "strokeWidth": THICKNESS.lines},
             "point":    {"color": colors[0], "size": 60, "opacity": 0.85, "filled": True},
             "area":     {"color": colors[0], "opacity": 0.8},
             "arc":      {"color": colors[0]},
             "rect":     {"color": colors[0]},
-            "geoshape": {"stroke": WHITE, "strokeWidth": 0.4},
-            "text":     {"font": font_str, "fontSize": label_size, "color": TEXT_GREY},
+            "geoshape": {"stroke": WHITE, "strokeWidth": THICKNESS.patches},
+            "text":     {"font": font_stack, "fontSize": FONT_SIZES.label, "color": TEXT_GREY},
         }
     }
 
@@ -149,7 +171,8 @@ def enable(**kwargs) -> None:
     ----------
     **kwargs:
         Any parameter accepted by ``theme_charite``
-        (``font``, ``font_size``, ``grid``, ``palette``, ``background``).
+        (``font``, ``font_size``, ``thickness``, ``grid``, ``palette``,
+        ``background``, ``tiny_margins``).
 
     Examples
     --------

charite_plot-0.2.0/charite_plot/mpl_themes.py

@@ -0,0 +1,188 @@
+"""Matplotlib theme for Charité – Universitätsmedizin Berlin."""
+
+from contextlib import contextmanager
+
+from cycler import cycler
+
+from .colors import TEXT_GREY, PRIME_BLUE, PRIME_LGREY, BLACK, WHITE
+from .palettes import PALETTES
+from .fonts import build_font_stack
+from ._theme_common import Margins, Thickness, resolve_font_sizes
+
+
+def theme_charite(
+    font: str | None = None,
+    font_size: int = 10,
+    thickness: float = 0.5,
+    grid: bool = False,
+    palette: str | list[str] = "primary",
+    interactive: bool = False,
+    tiny_margins: bool = False,
+) -> dict:
+    """Return matplotlib rcParams dict for the Charité corporate identity theme.
+
+    Parameters
+    ----------
+    font:
+        Preferred font family. Falls back through Charité Text Office →
+        Charit? Text Office → Calibri → DejaVu Sans → sans-serif if the requested font is not installed.
+    font_size:
+        Base font size in points. Defaults to 10 for screen; use 8 for print.
+    thickness:
+        Axis line and tick width. Mirrors the R ``thickness`` parameter.
+    grid:
+        Show major grid lines. Disabled by default.
+    palette:
+        Name of a built-in palette or a list of hex color strings used for the
+        ``axes.prop_cycle``.
+    interactive:
+        Enable matplotlib interactive mode (equivalent to ``plt.ion()``).
+        Useful in notebooks or scripts where you want plots to display
+        without blocking.
+    tiny_margins:
+        Minimise all margins around the plot panel. Useful for dense layouts or 
+        when saving figures with little surrounding whitespace.
+    """
+    sans_font_stack = build_font_stack(preferred=font)
+    monospace_font_stack = ["Andale Mono", "Nimbus Mono L", "Courier New", "Courier", "Fixed", "Terminal", "monospace"]
+    colors = PALETTES[palette] if isinstance(palette, str) else list(palette)
+
+    FONT_SIZES = resolve_font_sizes(font_size)
+    MARGINS = Margins(
+        title=4 if tiny_margins else 8,
+        label=2 if tiny_margins else 4,
+        legend=2 if tiny_margins else 4,
+        wspace=0.1 if tiny_margins else 0.2,
+        hspace=0.125 if tiny_margins else 0.25
+    )
+    THICKNESS = Thickness(
+        axes=thickness,
+        grid=thickness * 0.6,
+        ticks=thickness,
+        lines=1.5,
+        patches=0
+    )
+
+    return {
+        # Font — monospace is a fallback for latex mathtt, code blocks, etc.
+        "font.family":     "sans-serif",
+        "font.sans-serif": sans_font_stack,
+        "font.monospace":  monospace_font_stack,
+        "font.size":       FONT_SIZES.label,
+
+        # Axes
+        "axes.linewidth":  THICKNESS.axes,
+        "axes.titlelocation": "center",
+        "xaxis.labellocation": "center",
+        "yaxis.labellocation": "center",
+        "axes.titlesize":  FONT_SIZES.title,
+        "axes.titlecolor": PRIME_BLUE,
+        "axes.titlepad":   MARGINS.title,
+        "axes.labelsize":  FONT_SIZES.label,
+        "axes.labelcolor": TEXT_GREY,
+        "axes.labelpad":   MARGINS.label,
+        "axes.edgecolor":  BLACK,
+        "axes.facecolor":  WHITE,
+        "axes.grid":       grid,
+        "axes.axisbelow":  True,
+        "axes.spines.top":   False,
+        "axes.spines.right": False,
+
+        # Axes 3D (only visible when projection='3d')
+        "axes3d.grid":            grid,
+        "axes3d.xaxis.panecolor": WHITE,
+        "axes3d.yaxis.panecolor": WHITE,
+        "axes3d.zaxis.panecolor": WHITE,
+
+        # Polar axes (only visible when projection='polar')
+        "polaraxes.grid":         grid,
+
+        # Grid (only visible when grid=True)
+        "grid.color":       PRIME_LGREY,
+        "grid.linewidth":   THICKNESS.grid,
+        # "grid.minor.alpha": 0.48,
+
+        # Ticks
+        "xtick.color":         BLACK,
+        "ytick.color":         BLACK,
+        "xtick.labelsize":     FONT_SIZES.label,
+        "ytick.labelsize":     FONT_SIZES.label,
+        "xtick.labelcolor":    TEXT_GREY,
+        "ytick.labelcolor":    TEXT_GREY,
+        "xtick.major.size":    2,
+        "ytick.major.size":    2,
+        "xtick.major.pad":     2,
+        "ytick.major.pad":     2,
+        "xtick.major.width":   THICKNESS.ticks,
+        "ytick.major.width":   THICKNESS.ticks,
+        "xtick.minor.visible": False,
+        "ytick.minor.visible": False,
+
+        # Text
+        "text.color": TEXT_GREY,
+        "text.antialiased": True,
+
+        # Figure
+        "figure.facecolor":      WHITE,
+        "figure.edgecolor":      WHITE,
+        "figure.dpi":            100,
+        "figure.figsize":        (11, 8),
+        "figure.subplot.hspace": MARGINS.hspace,
+        "figure.subplot.wspace": MARGINS.wspace,
+        "figure.titlesize":      FONT_SIZES.title,
+        "figure.labelsize":      FONT_SIZES.label,
+
+        # Lines / markers
+        "lines.linewidth":   THICKNESS.lines,
+        "lines.markersize":  6,
+        "lines.antialiased": True,
+
+        # Patches (bars, etc.)
+        "patch.linewidth":       THICKNESS.patches,
+        "patch.force_edgecolor": False,
+        "patch.antialiased":     True,
+
+        # Histograms
+        "hist.bins": "auto",
+
+        # Legend
+        "legend.fancybox":       True,
+        "legend.frameon":        False,
+        "legend.fontsize":       FONT_SIZES.legend,
+        "legend.title_fontsize": FONT_SIZES.title,
+        "legend.labelcolor":     TEXT_GREY,
+
+        # Interactive mode
+        "interactive": interactive,
+
+        # Save
+        "savefig.dpi":         300,
+        "savefig.bbox":        "tight",
+        "savefig.transparent": True,
+
+        # Color cycle
+        "axes.prop_cycle": cycler("color", colors),
+    }
+
+
+def apply_theme(params: dict) -> None:
+    """Apply a theme dict as the active matplotlib rcParams (permanent until reset)."""
+    import matplotlib as mpl
+    mpl.rcParams.update(params)
+
+
+@contextmanager
+def using(params: dict):
+    """Context manager: temporarily apply *params* then restore previous rcParams.
+
+    Examples
+    --------
+    ```python
+    with using(theme_charite(palette="goldelse")):
+        fig, ax = plt.subplots()
+        ax.plot([1, 2, 3])
+    ```
+    """
+    import matplotlib as mpl
+    with mpl.rc_context(params):
+        yield

{charite_plot-0.1.1 → charite_plot-0.2.0}/docs/altair.md

@@ -44,9 +44,11 @@ alt.theme.enable("charite")   # enable later
 |-----------|------|---------|-------------|
 | `font` | `str | None` | `None` | Preferred font. CSS fallback: Charité Text Office → Charit? Text Office → Calibri → DejaVu Sans → sans-serif. |
 | `font_size` | `int` | `12` | Base font size in pixels. |
+| `thickness` | `float` | `0.5` | Axis line and tick width. |
 | `grid` | `bool` | `False` | Show axis grid lines. |
 | `palette` | `str | list[str]` | `"primary"` | Named palette or list of hex strings for the categorical color range. |
 | `background` | `str` | `"white"` | Chart background color. |
+| `tiny_margins` | `bool` | `False` | Minimise all paddings around the chart. Useful for dense layouts. |
 
 ---
 
@@ -95,3 +97,15 @@ alt.Chart(df).mark_point().encode(
 ```python
 enable(background="transparent")
 ```
+
+### Dense layout with minimal margins
+
+```python
+enable(tiny_margins=True)
+```
+
+### Thicker axis lines
+
+```python
+enable(thickness=1.0)
+```

charite_plot-0.2.0/docs/citing.md

@@ -0,0 +1,20 @@
+# Citing charite-plot
+
+If you use charite-plot in your research or work, please cite it. A `CITATION.cff` file is included in the repository and GitHub will surface a **Cite this repository** button on the sidebar automatically.
+
+## BibTeX
+
+```bibtex
+@software{ramezani2026chariteplot,
+  author    = {Ramezani, Pedram},
+  title     = {charite-plot: Matplotlib and Altair Themes for Charité – Universitätsmedizin Berlin},
+  year      = {2026},
+  version   = {0.2.0},
+  url       = {https://github.com/pedramezani/charite-plot},
+  license   = {MIT},
+}
+```
+
+## Acknowledgements
+
+charite-plot is based on the original [`charite` R package](https://github.com/johannesjuliusm/charite) developed by Johannes Julius Mohn.

{charite_plot-0.1.1 → charite_plot-0.2.0}/docs/matplotlib.md

@@ -57,6 +57,8 @@ mpl.rcParams.update(params)
 | `thickness` | `float` | `0.5` | Axis line and tick width. |
 | `grid` | `bool` | `False` | Show major grid lines. |
 | `palette` | `str | list[str]` | `"primary"` | Named palette or list of hex strings for `axes.prop_cycle`. |
+| `interactive` | `bool` | `False` | Enable interactive mode (equivalent to `plt.ion()`). Useful in notebooks or scripts where plots should display without blocking. |
+| `tiny_margins` | `bool` | `False` | Minimise all margins and paddings around the plot panel. Useful for dense layouts. |
 
 ---
 
@@ -87,3 +89,15 @@ apply_theme(theme_charite(palette=["#004d9b", "#ea5451", "#fab600"]))
 ```python
 apply_theme(theme_charite(grid=True))
 ```
+
+### Dense layout with minimal margins
+
+```python
+apply_theme(theme_charite(tiny_margins=True))
+```
+
+### Interactive mode (notebooks / REPL)
+
+```python
+apply_theme(theme_charite(interactive=True))   # equivalent to plt.ion()
+```

{charite_plot-0.1.1 → charite_plot-0.2.0}/examples/mpl_showcase.py

@@ -41,7 +41,7 @@ fig.suptitle(
     fontsize=16,
     y=1.01,
 )
-sub = fig.add_gridspec(3, 3, hspace=0.45, wspace=0.35)
+sub = fig.add_gridspec(3, 3, hspace=0.125, wspace=0.1)
 
 cats = ["A", "B", "C"]
 
@@ -178,7 +178,9 @@ ax9.set_yticks([n_rows - i - 0.6 for i in range(n_rows)])
 ax9.set_yticklabels(palette_names, fontsize=7)
 ax9.set_xticks([])
 ax9.spines["left"].set_visible(False)
+ax9.spines["bottom"].set_visible(False)
 ax9.tick_params(left=False)
+ax9.tick_params(bottom=False)
 ax9.set_title("Color Palettes")
 
 

charite_plot-0.2.0/examples/palette_preview.py

@@ -0,0 +1,61 @@
+"""Palette preview — generates swatch strips for every built-in palette.
+
+Produces one asset in docs/assets/:
+    palette_preview.png
+
+Run with:
+    python examples/palette_preview.py
+"""
+
+import sys
+import pathlib
+sys.path.insert(0, str(pathlib.Path(__file__).parent.parent))
+
+import matplotlib.pyplot as plt
+import matplotlib.patches as mpatches
+
+from charite_plot.mpl_themes import theme_charite, apply_theme
+from charite_plot.palettes import PALETTES
+
+apply_theme(theme_charite())
+
+MAX_COLS = max(len(p) for p in PALETTES.values())
+names = list(PALETTES.keys())
+LABEL_PAD = 0.4
+ROW_H = 0.58
+FIG_W = 7.5
+
+ASSETS = pathlib.Path(__file__).parent.parent / "docs" / "assets"
+ASSETS.mkdir(parents=True, exist_ok=True)
+OUT = ASSETS / "palette_preview.png"
+SAVE_KW = dict(dpi=300, bbox_inches="tight", facecolor="white", transparent=False)
+
+
+def _draw_row(ax: plt.Axes, name: str) -> None:
+    for i, color in enumerate(PALETTES[name]):
+        ax.add_patch(
+            mpatches.Rectangle(
+                (i, 0),
+                1.0,
+                0.82,
+                facecolor=color,
+                edgecolor="none",
+            )
+        )
+    ax.set_xlim(-LABEL_PAD, MAX_COLS)
+    ax.set_ylim(-0.1, 1.0)
+    ax.text(-LABEL_PAD, 0.41, name, ha="right", va="center", fontsize=12)
+    ax.axis("off")
+
+
+fig, axes = plt.subplots(
+    len(names),
+    1,
+    figsize=(FIG_W, len(names) * ROW_H + 0.3),
+    gridspec_kw={"hspace": 0},
+)
+for ax, name in zip(axes, names):
+    _draw_row(ax, name)
+fig.savefig(OUT, **SAVE_KW)
+print(f"Saved → {OUT}")
+plt.show()

charite_plot-0.2.0/examples/poly_showcase.py

@@ -0,0 +1,107 @@
+"""Synthetic time-series showcase — generates the charite-plot theme example image.
+
+Replicates the curves from ``tools/data/simulate_timeseries_data.R`` in the
+charite R package: three conditions (wiggly normal, cubic polynomial, square
+root) z-scored and plotted with uniform ±SE bands.
+
+Produces one asset in docs/assets/:
+    theme_example.png
+
+Run with:
+    python examples/poly_showcase.py
+"""
+
+import sys
+import pathlib
+sys.path.insert(0, str(pathlib.Path(__file__).parent.parent))
+
+import numpy as np
+import matplotlib.pyplot as plt
+
+from charite_plot.mpl_themes import theme_charite, apply_theme
+from charite_plot.colors import PRIME_BLUE, PRIME_DGREY, KORALL, TEXT_GREY
+
+COLORS = [KORALL, PRIME_BLUE, PRIME_DGREY]   # C1, C2, C3
+ASSETS = pathlib.Path(__file__).parent.parent / "docs" / "assets"
+ASSETS.mkdir(parents=True, exist_ok=True)
+OUT = ASSETS / "theme_example.png"
+SAVE_KW = dict(dpi=300, bbox_inches="tight", facecolor="white")
+
+
+# ── data helpers ────────────────────────────────────────────────────────────
+
+def _dnorm(x: np.ndarray, mean: float, sd: float) -> np.ndarray:
+    return np.exp(-0.5 * ((x - mean) / sd) ** 2) / (sd * np.sqrt(2 * np.pi))
+
+
+def _scale(x: np.ndarray) -> np.ndarray:
+    return (x - x.mean()) / x.std(ddof=1)
+
+
+def _generate_data():
+    # R and numpy use different RNGs so the tiny noise terms differ slightly,
+    # but they are visually negligible after z-scoring (sd ≤ 0.01).
+    rng = np.random.default_rng(42)
+    n = 100
+    time   = np.linspace(0, 1, n)
+    t_axis = np.arange(1, n + 1)
+
+    c1_core = _dnorm(time, mean=0.5, sd=0.15)
+    c1 = (c1_core
+          + 0.1  * np.sin(25 * time)
+          + 0.05 * np.cos(40 * time)
+          + rng.normal(0, 0.005, n))
+    c2 = 3.9 * time**3 - 6 * time**2 + 3 * time + rng.normal(0, 0.01, n)
+    c3 = time**0.5 + rng.normal(0, 0.005, n)
+
+    means = {"C1": _scale(c1) + 2.2, "C2": _scale(c2) + 2.8, "C3": _scale(c3) + 2.8}
+    se_all = rng.uniform(0.4, 0.6, n * 3)
+    ses = {"C1": se_all[:n], "C2": se_all[n:2*n], "C3": se_all[2*n:]}
+    return t_axis, means, ses
+
+
+# ── plot helpers ────────────────────────────────────────────────────────────
+
+def _plot_curves(ax: plt.Axes, t_axis, means, ses, frameon: bool = False) -> None:
+    for (label, mean), se, color in zip(means.items(), ses.values(), COLORS):
+        ax.fill_between(t_axis, mean - se, mean + se, alpha=0.25, color=color, linewidth=0)
+        ax.plot(t_axis, mean, lw=2, label=label, color=color)
+    ax.set_xlim(left=0)
+    ax.set_ylim(bottom=0)
+    ax.set_xlabel("Time")
+    ax.set_ylabel("Signal")
+    ax.legend(frameon=frameon)
+
+
+def _despine(ax: plt.Axes) -> None:
+    """Seaborn-style despine: trim spines to tick extent."""
+    for side in ("top", "right"):
+        ax.spines[side].set_visible(False)
+    for side in ("left", "bottom"):
+        ax.spines[side].set_position(("outward", 0))
+    xt = np.asarray(ax.get_xticks())
+    xt = xt[(xt >= ax.get_xlim()[0]) & (xt <= ax.get_xlim()[1])]
+    if xt.size:
+        ax.spines["bottom"].set_bounds(xt[0], xt[-1])
+    yt = np.asarray(ax.get_yticks())
+    yt = yt[(yt >= ax.get_ylim()[0]) & (yt <= ax.get_ylim()[1])]
+    if yt.size:
+        ax.spines["left"].set_bounds(yt[0], yt[-1])
+
+
+# ── generate data once ──────────────────────────────────────────────────────
+t_axis, means, ses = _generate_data()
+
+
+# ── single: Charité theme ───────────────────────────────────────────────────
+apply_theme(theme_charite(font_size=14, thickness=1))
+
+fig, ax = plt.subplots(figsize=(6, 4.5))
+fig.subplots_adjust(top=0.88)
+fig.suptitle("Charité", fontsize=16, y=0.95, color=PRIME_BLUE)
+fig.text(0.5, 0.90, "mpl Theme", ha="center", va="top", fontsize=9.5, color=TEXT_GREY)
+_plot_curves(ax, t_axis, means, ses)
+_despine(ax)
+fig.savefig(OUT, **SAVE_KW)
+print(f"Saved → {OUT}")
+plt.show()

{charite_plot-0.1.1 → charite_plot-0.2.0}/mkdocs.yml

@@ -50,6 +50,7 @@ nav:
     - Palettes: palettes.md
     - Matplotlib: matplotlib.md
     - Altair: altair.md
+  - Citing: citing.md
   - API Reference:
     - colors: api/colors.md
     - palettes: api/palettes.md

charite_plot-0.1.1/charite_plot/mpl_themes.py

@@ -1,129 +0,0 @@
-"""Matplotlib theme for Charité – Universitätsmedizin Berlin."""
-
-from contextlib import contextmanager
-
-from cycler import cycler
-
-from .colors import TEXT_GREY, PRIME_BLUE, PRIME_LGREY, BLACK
-from .palettes import PALETTES
-from .fonts import build_font_stack
-
-
-def theme_charite(
-    font: str | None = None,
-    font_size: float = 10,
-    thickness: float = 0.5,
-    grid: bool = False,
-    palette: str | list[str] = "primary",
-) -> dict:
-    """Return matplotlib rcParams dict for the Charité corporate identity theme.
-
-    Parameters
-    ----------
-    font:
-        Preferred font family. Falls back through Charité Text Office →
-        Charit? Text Office → Calibri → DejaVu Sans → sans-serif if the requested font is not installed.
-    font_size:
-        Base font size in points. Defaults to 10 for screen; use 8 for print.
-    thickness:
-        Axis line and tick width. Mirrors the R ``thickness`` parameter.
-    grid:
-        Show major grid lines. Disabled by default.
-    palette:
-        Name of a built-in palette or a list of hex color strings used for the
-        ``axes.prop_cycle``.
-    """
-    colors = PALETTES[palette] if isinstance(palette, str) else list(palette)
-
-    return {
-        # Font
-        "font.family":     "sans-serif",
-        "font.sans-serif": build_font_stack(preferred=font),
-        "font.size":       font_size,
-
-        # Spines — only bottom and left visible (mirrors theme_classic in R)
-        "axes.spines.top":   False,
-        "axes.spines.right": False,
-
-        # Axes
-        "axes.linewidth":  thickness,
-        "axes.titlesize":  round(font_size * 1.2),
-        "axes.titlecolor": PRIME_BLUE,
-        "axes.titlepad":   8,
-        "axes.labelsize":  font_size,
-        "axes.labelcolor": TEXT_GREY,
-        "axes.edgecolor":  BLACK,
-        "axes.facecolor":  "white",
-        "axes.grid":       grid,
-
-        # Grid (only visible when grid=True)
-        "grid.color":     PRIME_LGREY,
-        "grid.linewidth": thickness * 0.6,
-        "grid.alpha":     0.8,
-
-        # Ticks
-        "xtick.color":         BLACK,
-        "ytick.color":         BLACK,
-        "xtick.labelsize":     font_size - 1,
-        "ytick.labelsize":     font_size - 1,
-        "xtick.labelcolor":    TEXT_GREY,
-        "ytick.labelcolor":    TEXT_GREY,
-        "xtick.major.size":    3,
-        "ytick.major.size":    3,
-        "xtick.major.width":   thickness,
-        "ytick.major.width":   thickness,
-        "xtick.minor.visible": False,
-        "ytick.minor.visible": False,
-
-        # Text
-        "text.color": TEXT_GREY,
-
-        # Figure
-        "figure.facecolor": "white",
-        "figure.edgecolor": "white",
-        "figure.dpi":       100,
-
-        # Lines / markers
-        "lines.linewidth":  1.5,
-        "lines.markersize": 6,
-
-        # Patches (bars, etc.)
-        "patch.linewidth": 0,
-
-        # Legend
-        "legend.frameon":        False,
-        "legend.fontsize":       round(font_size * 0.9),
-        "legend.title_fontsize": font_size,
-        "legend.labelcolor":     TEXT_GREY,
-
-        # Save
-        "savefig.dpi":         300,
-        "savefig.bbox":        "tight",
-        "savefig.transparent": True,
-
-        # Color cycle
-        "axes.prop_cycle": cycler("color", colors),
-    }
-
-
-def apply_theme(params: dict) -> None:
-    """Apply a theme dict as the active matplotlib rcParams (permanent until reset)."""
-    import matplotlib as mpl
-    mpl.rcParams.update(params)
-
-
-@contextmanager
-def using(params: dict):
-    """Context manager: temporarily apply *params* then restore previous rcParams.
-
-    Examples
-    --------
-    ```python
-    with using(theme_charite(palette="goldelse")):
-        fig, ax = plt.subplots()
-        ax.plot([1, 2, 3])
-    ```
-    """
-    import matplotlib as mpl
-    with mpl.rc_context(params):
-        yield

charite_plot-0.1.1/examples/palette_preview.py

@@ -1,47 +0,0 @@
-"""Palette preview — generates a swatch strip for every built-in palette.
-
-Run with:
-    python examples/palette_preview.py
-"""
-
-import sys
-import pathlib
-sys.path.insert(0, str(pathlib.Path(__file__).parent.parent))
-
-import matplotlib.pyplot as plt
-import matplotlib.patches as mpatches
-
-from charite_plot.mpl_themes import theme_charite, apply_theme
-from charite_plot.palettes import PALETTES
-
-apply_theme(theme_charite())
-
-MAX_COLS = max(len(p) for p in PALETTES.values())
-names    = list(PALETTES.keys())
-
-LABEL_PAD = 0.4   # data-units reserved to the left for labels at font size 12
-
-fig, axes = plt.subplots(
-    len(names), 1,
-    figsize=(7.5, len(names) * 0.58 + 0.3),
-    gridspec_kw={"hspace": 0},
-)
-
-for ax, name in zip(axes, names):
-    palette = PALETTES[name]
-    for i, color in enumerate(palette):
-        ax.add_patch(mpatches.Rectangle(
-            (i, 0), 1.0, 0.82,
-            facecolor=color, edgecolor="none",
-        ))
-    ax.set_xlim(-LABEL_PAD, MAX_COLS)
-    ax.set_ylim(-0.1, 1.0)
-    ax.text(-LABEL_PAD, 0.41, name, ha="right", va="center", fontsize=12)
-    ax.axis("off")
-
-
-out = pathlib.Path(__file__).parent.parent / "docs" / "assets" / "palette_preview.png"
-out.parent.mkdir(parents=True, exist_ok=True)
-fig.savefig(out, dpi=300, bbox_inches="tight", facecolor="white")
-print(f"Saved → {out}")
-plt.show()

charite_plot-0.1.1/examples/poly_showcase.py

@@ -1,108 +0,0 @@
-"""Synthetic time-series showcase — generates the charite-plot theme example image.
-
-Replicates the curves from ``tools/data/simulate_timeseries_data.R`` in the
-charite R package: three conditions (wiggly normal, cubic polynomial, square
-root) z-scored and plotted with uniform ±SE bands.
-
-Run with:
-    python examples/poly_showcase.py
-"""
-
-import sys
-import pathlib
-sys.path.insert(0, str(pathlib.Path(__file__).parent.parent))
-
-import numpy as np
-import matplotlib.pyplot as plt
-
-from charite_plot.mpl_themes import theme_charite, apply_theme
-from charite_plot.colors import PRIME_BLUE, PRIME_DGREY, KORALL, TEXT_GREY
-
-apply_theme(theme_charite(font_size=10))
-
-# ── reproduce R's simulate_timeseries_data.R (set.seed(42)) ────────────────
-# R and numpy use different RNGs so the tiny noise terms differ slightly,
-# but they are visually negligible after z-scoring (sd ≤ 0.01).
-rng = np.random.default_rng(42)
-
-n_time = 100
-time   = np.linspace(0, 1, n_time)   # seq(0, 1, length.out = 100)
-t_axis = np.arange(1, n_time + 1)    # seq(1, 100) — x-axis
-
-
-def _dnorm(x: np.ndarray, mean: float, sd: float) -> np.ndarray:
-    """Normal PDF — equivalent to R's dnorm()."""
-    return np.exp(-0.5 * ((x - mean) / sd) ** 2) / (sd * np.sqrt(2 * np.pi))
-
-
-def _scale(x: np.ndarray) -> np.ndarray:
-    """Center and unit-scale — equivalent to R's scale()."""
-    return (x - x.mean()) / x.std(ddof=1)
-
-
-# C1: wiggly normal
-c1_core = _dnorm(time, mean=0.5, sd=0.15)
-c1 = (c1_core
-      + 0.1  * np.sin(25 * time)
-      + 0.05 * np.cos(40 * time)
-      + rng.normal(0, 0.005, n_time))
-
-# C2: 3rd-order polynomial
-c2 = 3.9 * time**3 - 6 * time**2 + 3 * time + rng.normal(0, 0.01, n_time)
-
-# C3: square root
-c3 = time**0.5 + rng.normal(0, 0.005, n_time)
-
-# z-score and shift (matching the R data frame construction)
-means = {
-    "C1": _scale(c1) + 2.2,
-    "C2": _scale(c2) + 2.8,
-    "C3": _scale(c3) + 2.8,
-}
-
-# SE: runif(n_time * 3, min = 0.4, max = 0.6), sliced per condition
-se_all = rng.uniform(0.4, 0.6, n_time * 3)
-ses = {
-    "C1": se_all[0          : n_time],
-    "C2": se_all[n_time     : 2 * n_time],
-    "C3": se_all[2 * n_time :],
-}
-
-# ── plot ───────────────────────────────────────────────────────────────────
-colors = [KORALL, PRIME_BLUE, PRIME_DGREY]   # C1, C2, C3
-
-fig, ax = plt.subplots(figsize=(6, 4.5))     # 4:3
-fig.subplots_adjust(top=0.88)
-fig.suptitle("Charité", fontsize=16, y=0.95, color=PRIME_BLUE)
-fig.text(0.5, 0.90, "mpl Theme", ha="center", va="top", fontsize=9.5, color=TEXT_GREY)
-
-for (label, mean), se, color in zip(means.items(), ses.values(), colors):
-    ax.fill_between(t_axis, mean - se, mean + se, alpha=0.25, color=color, linewidth=0)
-    ax.plot(t_axis, mean, lw=2, label=label, color=color)
-
-ax.set_xlim(left=0)
-ax.set_ylim(bottom=0)
-ax.set_xlabel("Time")
-ax.set_ylabel("Signal")
-ax.legend(frameon=False)
-
-# despine: offset spines outward and trim to tick extent (seaborn-style)
-for side in ("left", "bottom"):
-    ax.spines[side].set_position(("outward", 0))
-for side in ("top", "right"):
-    ax.spines[side].set_visible(False)
-xt = np.asarray(ax.get_xticks())
-xt = xt[(xt >= ax.get_xlim()[0]) & (xt <= ax.get_xlim()[1])]
-if xt.size:
-    ax.spines["bottom"].set_bounds(xt[0], xt[-1])
-yt = np.asarray(ax.get_yticks())
-yt = yt[(yt >= ax.get_ylim()[0]) & (yt <= ax.get_ylim()[1])]
-if yt.size:
-    ax.spines["left"].set_bounds(yt[0], yt[-1])
-
-# ── save ───────────────────────────────────────────────────────────────────
-out = pathlib.Path(__file__).parent.parent / "docs" / "assets" / "theme_example.png"
-out.parent.mkdir(parents=True, exist_ok=True)
-fig.savefig(out, dpi=300, bbox_inches="tight", facecolor="white")
-print(f"Saved → {out}")
-plt.show()