figrecipe 0.5.0__py3-none-any.whl → 0.7.4__py3-none-any.whl

figrecipe/styles/_themes.py

@@ -0,0 +1,151 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""Theme color utilities for figrecipe styles."""
+
+from typing import Dict, Optional
+
+from matplotlib.axes import Axes
+
+# Default theme color palettes (Monaco/VS Code style for dark)
+THEME_COLORS = {
+    "dark": {
+        "figure_bg": "#1e1e1e",  # VS Code main background
+        "axes_bg": "#252526",  # VS Code panel background
+        "legend_bg": "#252526",  # Same as axes
+        "text": "#d4d4d4",  # VS Code default text
+        "spine": "#3c3c3c",  # Subtle border color
+        "tick": "#d4d4d4",  # Match text
+        "grid": "#3a3a3a",  # Subtle grid
+    },
+    "light": {
+        "figure_bg": "none",  # Transparent
+        "axes_bg": "none",  # Transparent
+        "legend_bg": "none",  # Transparent
+        "text": "black",
+        "spine": "black",
+        "tick": "black",
+        "grid": "#cccccc",
+    },
+}
+
+
+def apply_theme_colors(
+    ax: Axes,
+    theme: str = "light",
+    custom_colors: Optional[Dict[str, str]] = None,
+) -> None:
+    """Apply theme colors to axes for dark/light mode support.
+
+    Parameters
+    ----------
+    ax : matplotlib.axes.Axes
+        Target axes to apply theme to
+    theme : str or dict
+        Color theme: "light" or "dark" (default: "light")
+        If dict, extracts 'mode' key (for YAML-style theme dicts)
+    custom_colors : dict, optional
+        Custom color overrides. Keys: figure_bg, axes_bg, legend_bg, text, spine, tick, grid
+
+    Examples
+    --------
+    >>> fig, ax = plt.subplots()
+    >>> apply_theme_colors(ax, theme="dark")  # Eye-friendly dark mode
+    """
+    # Handle dict-style theme (from YAML: {mode: "light", dark: {...}})
+    if isinstance(theme, dict):
+        theme = theme.get("mode", "light")
+
+    # Ensure theme is a string
+    if not isinstance(theme, str):
+        theme = "light"
+
+    # Get base theme colors
+    colors = THEME_COLORS.get(theme, THEME_COLORS["light"]).copy()
+
+    # Apply custom overrides
+    if custom_colors:
+        # Handle legacy key name (background -> figure_bg)
+        if "background" in custom_colors and "figure_bg" not in custom_colors:
+            custom_colors["figure_bg"] = custom_colors.pop("background")
+        colors.update(custom_colors)
+
+    # Helper to check for transparent/none
+    def is_transparent(color):
+        if color is None:
+            return False
+        return str(color).lower() in ("none", "transparent")
+
+    # Apply axes background (handle "none"/"transparent" for transparency)
+    axes_bg = colors.get("axes_bg", "none")
+    if is_transparent(axes_bg):
+        ax.set_facecolor("none")
+        ax.patch.set_alpha(0)
+    else:
+        ax.set_facecolor(axes_bg)
+
+    # Apply figure background if accessible
+    fig = ax.get_figure()
+    if fig is not None:
+        fig_bg = colors.get("figure_bg", "none")
+        if is_transparent(fig_bg):
+            fig.patch.set_facecolor("none")
+            fig.patch.set_alpha(0)
+        else:
+            fig.patch.set_facecolor(fig_bg)
+
+        # Apply text colors to figure-level text elements
+        if hasattr(fig, "_suptitle") and fig._suptitle is not None:
+            fig._suptitle.set_color(colors["text"])
+        if hasattr(fig, "_supxlabel") and fig._supxlabel is not None:
+            fig._supxlabel.set_color(colors["text"])
+        if hasattr(fig, "_supylabel") and fig._supylabel is not None:
+            fig._supylabel.set_color(colors["text"])
+
+    # Apply text colors (labels, titles)
+    ax.xaxis.label.set_color(colors["text"])
+    ax.yaxis.label.set_color(colors["text"])
+    ax.title.set_color(colors["text"])
+
+    # Update rcParams for dark mode support (pie charts, panel labels)
+    import matplotlib as mpl
+
+    mpl.rcParams["text.color"] = colors["text"]
+    mpl.rcParams["axes.labelcolor"] = colors["text"]
+    mpl.rcParams["xtick.color"] = colors["tick"]
+    mpl.rcParams["ytick.color"] = colors["tick"]
+
+    # Apply spine colors
+    for spine in ax.spines.values():
+        spine.set_color(colors["spine"])
+
+    # Apply tick colors (both marks and labels)
+    ax.tick_params(colors=colors["tick"], which="both")
+    for label in ax.get_xticklabels() + ax.get_yticklabels():
+        label.set_color(colors["tick"])
+
+    # Apply text colors to all text objects (panel labels, pie labels, annotations)
+    for text in ax.texts:
+        text.set_color(colors["text"])
+
+    # Apply legend colors if legend exists
+    legend = ax.get_legend()
+    if legend is not None:
+        for text in legend.get_texts():
+            text.set_color(colors["text"])
+        title = legend.get_title()
+        if title:
+            title.set_color(colors["text"])
+        frame = legend.get_frame()
+        if frame:
+            legend_bg = colors.get("legend_bg", colors.get("axes_bg", "none"))
+            if is_transparent(legend_bg):
+                frame.set_facecolor("none")
+                frame.set_alpha(0)
+            else:
+                frame.set_facecolor(legend_bg)
+            frame.set_edgecolor(colors["spine"])
+
+
+__all__ = ["THEME_COLORS", "apply_theme_colors"]
+
+# EOF

figrecipe/styles/presets/MATPLOTLIB.yaml

@@ -0,0 +1,95 @@
+# Timestamp: "2025-12-22 13:49:42 (ywatanabe)"
+# File: ./src/figrecipe/styles/presets/MATPLOTLIB.yaml
+# MATPLOTLIB Style Preset
+# =======================
+# Vanilla matplotlib defaults - minimal customization.
+# Use this to reset to standard matplotlib behavior.
+
+axes:
+  width_mm: null   # Use matplotlib default (auto)
+  height_mm: null  # Use matplotlib default (auto)
+  thickness_mm: null  # Use matplotlib default
+
+margins:
+  left_mm: null
+  right_mm: null
+  bottom_mm: null
+  top_mm: null
+
+spacing:
+  horizontal_mm: null
+  vertical_mm: null
+
+fonts:
+  family: null  # matplotlib default (DejaVu Sans)
+  axis_label_pt: null
+  tick_label_pt: null
+  title_pt: null
+  suptitle_pt: null
+  legend_pt: null
+  annotation_pt: null
+
+padding:
+  label_pt: null
+  tick_pt: null
+  title_pt: null
+
+lines:
+  trace_mm: null
+  errorbar_mm: null
+  errorbar_cap_mm: null
+
+ticks:
+  length_mm: null
+  thickness_mm: null
+  direction: null
+  n_ticks_min: null
+  n_ticks_max: null
+
+markers:
+  size_mm: null
+  scatter_mm: null
+  edge_width_mm: null
+
+legend:
+  frameon: null          # matplotlib default (True)
+  bg: null               # matplotlib default
+  edgecolor: null        # matplotlib default
+  alpha: null            # matplotlib default
+  loc: null              # matplotlib default
+
+output:
+  dpi: 300
+  transparent: false
+  format: "png"
+
+behavior:
+  auto_scale_axes: false
+  hide_top_spine: false
+  hide_right_spine: false
+  grid: false
+
+theme:
+  mode: "light"
+  dark:
+    figure_bg: "#1e1e1e"
+    axes_bg: "#1e1e1e"
+    legend_bg: "#1e1e1e"
+    text: "#d4d4d4"
+    spine: "#d4d4d4"
+    tick: "#d4d4d4"
+    grid: "#3a3a3a"
+  light:
+    figure_bg: "white"
+    axes_bg: "white"
+    legend_bg: "white"
+    text: "black"
+    spine: "black"
+    tick: "black"
+    grid: "#cccccc"
+
+# Colors: Use matplotlib default (tab10)
+colors:
+  palette: null
+
+# EOF

figrecipe/styles/presets/SCITEX.yaml

@@ -0,0 +1,181 @@
+# Timestamp: "2025-12-24 14:11:46 (ywatanabe)"
+# File: ./src/figrecipe/styles/presets/SCITEX.yaml
+# FIGRECIPE Style Preset
+# ======================
+# Publication-quality settings for scientific figures.
+# Optimized for scientific journals with Arial font.
+
+axes:
+  width_mm: 40
+  height_mm: 28
+  thickness_mm: 0.2
+
+margins:
+  left_mm: 6      # Room for supylabel
+  right_mm: 1
+  bottom_mm: 5    # Room for supxlabel
+  top_mm: 5       # Room for suptitle
+
+spacing:
+  horizontal_mm: 10   # Between columns
+  vertical_mm: 15     # Between rows (includes title + xlabel space)
+  suptitle_mm: 5      # Space reserved for figure suptitle
+  supxlabel_mm: 3     # Space reserved for figure super x-label
+  supylabel_mm: 3     # Space reserved for figure super y-label
+
+fonts:
+  family: "Arial"
+  axis_label_pt: 7
+  tick_label_pt: 7
+  title_pt: 8
+  suptitle_pt: 9      # Figure suptitle (slightly larger than subplot titles)
+  supxlabel_pt: 7     # Figure-level x-label (same as axis labels)
+  supylabel_pt: 7     # Figure-level y-label (same as axis labels)
+  panel_label_pt: 10  # Panel labels (A, B, C, ...) - bold, prominent
+  legend_pt: 6
+  annotation_pt: 6
+
+padding:
+  label_pt: 2.0
+  tick_pt: 2.0
+  title_pt: 4.0
+
+lines:
+  trace_mm: 0.2
+  errorbar_mm: 0.2
+  errorbar_cap_mm: 0.8
+
+ticks:
+  length_mm: 0.8
+  thickness_mm: 0.2
+  direction: "out"
+  n_ticks_min: 3
+  n_ticks_max: 4
+
+markers:
+  size_mm: 0.8
+  scatter_mm: 0.8
+  flier_mm: 0.8        # Boxplot outlier marker size
+  edge_width_mm: null  # None = no border (cleaner than 0)
+
+boxplot:
+  line_mm: 0.2           # Box outline thickness
+  whisker_mm: 0.2        # Whisker line thickness
+  cap_mm: 0.2            # Cap line thickness
+  median_mm: 0.2         # Median line thickness
+  median_color: "black"  # Median line color
+  flier_edge_mm: 0.2     # Outlier marker edge thickness
+
+violinplot:
+  line_mm: 0.2           # Violin outline thickness
+  inner: "box"           # Inner display: "box", "quartile", "point", "stick", or "swarm"
+  box_width_mm: 1.5      # Inner box width
+  whisker_mm: 0.2        # Whisker line thickness
+  median_mm: 0.8         # Median marker size
+  alpha: 0.7             # Violin fill transparency (modern: semi-transparent)
+  showmeans: false       # Show mean line
+  showmedians: true      # Show median line
+  showextrema: false     # Hide min/max lines for cleaner look
+
+barplot:
+  edge_mm: 0.2           # Bar edge/border thickness
+
+histogram:
+  edge_mm: 0.2           # Histogram bar edge thickness
+
+pie:
+  text_pt: 6             # Pie chart text size (labels, autopct)
+  show_axes: false       # Hide axes for pie charts
+  edge_color: "black"    # Wedge edge color (black for contrast)
+  edge_mm: 0.2           # Wedge edge thickness
+
+imshow:
+  show_axes: false       # Hide ticks, ticklabels, spines for imshow
+  show_labels: false     # Hide x/y labels for imshow
+
+eventplot:
+  linewidth_mm: 0.2      # Event line thickness
+  linelength: 0.8        # Event line length (fraction of spacing)
+
+matshow:
+  show_axes: false       # Hide axes for matrix display
+  xticklabel_position: "bottom"  # Put xlabels at bottom (not top)
+
+spy:
+  show_axes: false       # Hide axes for spy plots
+  xticklabel_position: "bottom"  # Put xlabels at bottom
+
+legend:
+  frameon: false         # No frame for clean look
+  bg: null               # Background (null = use theme.legend_bg)
+  edgecolor: null        # Frame edge color
+  alpha: 1.0             # Transparency
+  loc: "best"
+
+output:
+  dpi: 300
+  transparent: true
+  format: "pdf"
+
+behavior:
+  auto_scale_axes: true
+  hide_top_spine: true
+  hide_right_spine: true
+  grid: false
+  constrained_layout: true  # Auto-spacing for suptitle/supxlabel/supylabel
+  panel_labels: true        # Auto-add A, B, C labels to multi-panel figures
+
+theme:
+  mode: "light"
+  dark:
+    figure_bg: "transparent"
+    axes_bg: "transparent"
+    legend_bg: "transparent"
+    text: "#d4d4d4"
+    spine: "#d4d4d4"
+    tick: "#d4d4d4"
+    grid: "#3a3a3a"
+  light:
+    figure_bg: "transparent"
+    axes_bg: "transparent"
+    legend_bg: "transparent"
+    text: "black"
+    spine: "black"
+    tick: "black"
+    grid: "#cccccc"
+
+# SciTeX Color Palette (RGB format)
+colors:
+  palette:
+    - [0, 128, 192]      # blue
+    - [255, 70, 50]      # red
+    - [20, 180, 20]      # green
+    - [230, 160, 20]     # yellow
+    - [200, 50, 255]     # purple
+    - [20, 200, 200]     # lightblue
+    - [228, 94, 50]      # orange
+    - [255, 150, 200]    # pink
+
+  rgb:
+    # Named colors
+    - white: [255, 255, 255]
+    - black: [0, 0, 0]
+    - blue: [0, 128, 192]
+    - red: [255, 70, 50]
+    - pink: [255, 150, 200]
+    - green: [20, 180, 20]
+    - yellow: [230, 160, 20]
+    - gray: [128, 128, 128]
+    - grey: [128, 128, 128]
+    - purple: [200, 50, 255]
+    - lightblue: [20, 200, 200]
+    - brown: [128, 0, 0]
+    - navy: [0, 0, 100]
+    - orange: [228, 94, 50]
+
+    # Semantic
+    - primary: [0, 128, 192]
+    - secondary: [255, 70, 50]
+    - accent: [20, 180, 20]
+
+# EOF