figrecipe 0.5.0__py3-none-any.whl

figrecipe-0.5.0.dist-info/METADATA

@@ -0,0 +1,336 @@
+Metadata-Version: 2.4
+Name: figrecipe
+Version: 0.5.0
+Summary: Reproducible matplotlib wrapper with mm-precision layouts
+Project-URL: Homepage, https://github.com/ywatanabe1989/figrecipe
+Project-URL: Documentation, https://github.com/ywatanabe1989/figrecipe#readme
+Project-URL: Repository, https://github.com/ywatanabe1989/figrecipe.git
+Project-URL: Issues, https://github.com/ywatanabe1989/figrecipe/issues
+Author-email: Yusuke Watanabe <ywatanabe@scitex.ai>
+License-Expression: AGPL-3.0
+License-File: LICENSE
+Keywords: matplotlib,millimeter,plotting,publication,recipe,reproducibility,scientific,visualization,yaml
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.9
+Requires-Dist: matplotlib>=3.5.0
+Requires-Dist: numpy>=1.20.0
+Requires-Dist: ruamel-yaml>=0.17.0
+Provides-Extra: all
+Requires-Dist: pandas>=1.3.0; extra == 'all'
+Requires-Dist: pillow>=9.0.0; extra == 'all'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'all'
+Requires-Dist: pytest>=7.0.0; extra == 'all'
+Requires-Dist: seaborn>=0.12.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Provides-Extra: imaging
+Requires-Dist: pillow>=9.0.0; extra == 'imaging'
+Provides-Extra: seaborn
+Requires-Dist: pandas>=1.3.0; extra == 'seaborn'
+Requires-Dist: seaborn>=0.12.0; extra == 'seaborn'
+Description-Content-Type: text/markdown
+
+<!-- ---
+!-- Timestamp: 2025-12-22 13:01:11
+!-- Author: ywatanabe
+!-- File: /home/ywatanabe/proj/figrecipe/README.md
+!-- --- -->
+
+<p align="center">
+  <img src="docs/figrecipe_logo.png" alt="figrecipe logo" width="200"/>
+</p>
+
+# FigRecipe
+
+**Reproducible matplotlib figures with mm-precision layouts.**  
+FigRecipe is a lightweight recording & reproduction layer for matplotlib,
+designed for scientific figures that must remain **editable, inspectable,
+and reproducible**.
+
+Part of **SciTeX™ – Research OS for reproducible science**  
+https://scitex.ai
+
+[![PyPI version](https://badge.fury.io/py/figrecipe.svg)](https://badge.fury.io/py/figrecipe)
+[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
+
+---
+
+## Why FigRecipe?
+
+In scientific workflows, figures are often:
+- hard to reproduce once scripts change,
+- resized manually in pixels or inches,
+- impossible to partially reuse or inspect later.
+
+**FigRecipe solves this by recording plotting calls as a structured “recipe”**,
+allowing figures to be:
+- faithfully reproduced,
+- partially re-rendered,
+- inspected for underlying data,
+- laid out in **exact millimeters** for publication.
+
+---
+
+## Key Features
+
+- ✅ Drop-in replacement for `matplotlib.pyplot` (use `fr.subplots()` to enable recording)
+- ✅ Automatic recording of plotting calls
+- ✅ Reproduce figures from a YAML recipe
+- ✅ Extract plotted data programmatically
+- ✅ Selective reproduction of specific plots
+- ✅ Millimeter-based layout (journal-ready)
+- ✅ Publication-quality style presets
+- ✅ Dark theme support (data colors preserved)
+- ✅ Seamless seaborn integration
+- ✅ Crop figures to content with mm margins
+
+---
+
+## Installation
+
+```bash
+pip install figrecipe
+
+# Optional extras
+pip install figrecipe[seaborn]   # seaborn + pandas support
+pip install figrecipe[imaging]   # image cropping (Pillow)
+pip install figrecipe[all]       # all extras
+
+# Optional: for PDF export from notebooks (SVG → PDF)
+sudo apt install inkscape  # Linux
+brew install inkscape      # macOS
+```
+
+**Requirements:** Python >= 3.9
+
+## Basic Usage
+
+### Recording & Saving
+
+``` python
+import figrecipe as fr
+import numpy as np
+
+x = np.linspace(0, 10, 100)
+y = np.sin(x)
+
+fig, ax = fr.subplots()
+ax.plot(x, y, color='red', linewidth=2, id='sine_wave')
+ax.set_xlabel('Time (s)')
+ax.set_ylabel('Amplitude')
+
+# Save image + recipe
+img_path, yaml_path, result = fr.save(fig, 'figure.png')
+# → creates: figure.png + figure.yaml
+```
+
+### Reproducing a Figure
+
+``` python
+import figrecipe as fr
+
+fig, ax = fr.reproduce('figure.yaml')
+```
+
+### Extracting Plotted Data
+
+``` python
+import figrecipe as fr
+
+data = fr.extract_data('figure.yaml')
+# {'sine_wave': {'x': array([...]), 'y': array([...])}}
+```
+
+### Millimeter-Based Layout (Publication-Ready)
+
+``` python
+fig, ax = fr.subplots(
+    axes_width_mm=60,
+    axes_height_mm=40,
+    margin_left_mm=15,
+    margin_bottom_mm=12,
+)
+```
+This guarantees consistent sizing across editors, exports, and journals.
+
+### Style Presets
+
+``` python
+fr.list_presets()
+# ['MATPLOTLIB', 'SCITEX']
+
+# Publication-quality preset (applied globally)
+fr.load_style('SCITEX')
+fig, ax = fr.subplots()
+
+# Dark theme (UI-only, data colors preserved)
+fr.load_style('SCITEX_DARK')
+# or: fr.load_style('SCITEX', dark=True)
+
+# Custom style
+fr.load_style('/path/to/my_style.yaml')
+```
+
+See docs/EXAMPLE_RECIPE.yaml for a full style template.
+
+### Recipe Format (YAML)
+
+``` yaml
+# Timestamp: "2025-12-22 11:53:14 (ywatanabe)"
+# File: ./docs/EXAMPLE_RECIPE.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: 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: "#3c3c3c"
+    tick: "#d4d4d4"
+    grid: "#3a3a3a"
+  light:
+    figure_bg: "white"
+    axes_bg: "white"
+    legend_bg: "white"
+    text: "black"
+    spine: "black"
+    tick: "black"
+    grid: "#cccccc"
+
+# Standard matplotlib color cycle (tab10)
+colors:
+  palette:
+    - [31, 119, 180]     # tab:blue
+    - [255, 127, 14]     # tab:orange
+    - [44, 160, 44]      # tab:green
+    - [214, 39, 40]      # tab:red
+    - [148, 103, 189]    # tab:purple
+    - [140, 86, 75]      # tab:brown
+    - [227, 119, 194]    # tab:pink
+    - [127, 127, 127]    # tab:gray
+    - [188, 189, 34]     # tab:olive
+    - [23, 190, 207]     # tab:cyan
+
+# EOF
+```
+
+The recipe is human-readable, version-controllable, and inspectable.
+
+
+### API Overview
+
+| Function                      | Description                       |
+| ----------------------------- | --------------------------------- |
+| `fr.subplots()`               | Create a recording-enabled figure |
+| `fr.save(fig, 'fig.png')`     | Save image + recipe               |
+| `fr.reproduce('fig.yaml')`    | Reproduce figure from recipe      |
+| `fr.extract_data('fig.yaml')` | Extract plotted data              |
+| `fr.info('fig.yaml')`         | Inspect recipe metadata           |
+| `fr.load_style()`             | Load style preset (global)        |
+| `fr.list_presets()`           | List available presets            |
+| `fr.crop('fig.png')`          | Crop to content with mm margin    |
+
+
+### Examples
+- 📓 Interactive demo notebook:
+  examples/figrecipe_demo.ipynb
+
+- 🌐 View on nbviewer:
+  https://nbviewer.org/github/ywatanabe1989/figrecipe/blob/main/examples/figrecipe_demo.ipynb
+
+The notebook includes side-by-side comparisons of original and reproduced figures.
+
+## Positioning
+
+FigRecipe is intentionally minimal.
+It focuses on recording, reproduction, and layout fidelity.
+
+Higher-level workflows (figures, tables, statistics, GUIs) are handled in:
+
+FTS (Figure-Table-Statistics Bundle) in SciTeX ecosystem (https://scitex.ai/vis/)
+
+
+## License
+
+AGPL-3.0 See [LICENSE](LICENSE)
+.
+
+<!-- EOF -->

figrecipe-0.5.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+figrecipe/__init__.py,sha256=X9RnSndUi5ZC_JW6ReBjvYD84kjK8D4FNvB5QjekFg4,35296
+figrecipe/_recorder.py,sha256=mPjhc6ZaUWrzW3lBxeB_epf-ESHLj05sKs_zeHkZ9_Y,14290
+figrecipe/_reproducer.py,sha256=IQNYJ8OcvGRKNRLe561yqtmWgIJtzkx6okCes1xIHsk,9683
+figrecipe/_seaborn.py,sha256=dRQgIbJG9Xeh1DYCDNrgaXgQe4MsnukEXFeEolWnfeo,8348
+figrecipe/_serializer.py,sha256=OpWbCRSlhMuA2KInRXvze-g9V_d5ToLUIEmTj-jquYs,6267
+figrecipe/_validator.py,sha256=dFZez0J4f8V9wUnrMaz_CV-TlndBDcHHbZO4mRDC6Po,5567
+figrecipe/plt.py,sha256=GkURHdcupAVvpWKgTCC23jn3OjmKQmTY09A9wGMUdDQ,308
+figrecipe/pyplot.py,sha256=xw-wFa6N7wJ-A3ThLbQvhafwySNIqD05u9UupksY7S4,5685
+figrecipe/_signatures/__init__.py,sha256=twHKZ8o_9Ho4k0SD-cff72_aaWevK0noGlWav5fauHg,244
+figrecipe/_signatures/_loader.py,sha256=HCrVzQNWqqt6qSr13G_A1461-v94g65usfIRJ4_zmJk,4744
+figrecipe/_utils/__init__.py,sha256=usLkRQJ6oZJSUSzZWkb1x-lkAdHO9I1g7VinLf2kz24,815
+figrecipe/_utils/_crop.py,sha256=YQgaYGI3gAFRF0zkQeUOlTRs9vsBmAK_24vooPPcPPc,8385
+figrecipe/_utils/_diff.py,sha256=cjRXjMrfXFKz6uZQOZ-XYifc0mzmHZyRXn_LY13K1SY,2354
+figrecipe/_utils/_image_diff.py,sha256=9648vx2f_K628YjCB-bhCOsRws4qqWuUk2l4uJlpdrc,5406
+figrecipe/_utils/_numpy_io.py,sha256=leckngCnZKTvceM3RfUq1P9TA6z1SibfzWqlhKtOaxY,4533
+figrecipe/_utils/_units.py,sha256=94e0MaJ27WkF7zDqNL-P7adbve3qWitPzWrCYOuDBe8,4628
+figrecipe/_wrappers/__init__.py,sha256=CcBUID5G6Mo_bNGpCaz5vbfB8CG7XtF-9lOm7kShQPw,214
+figrecipe/_wrappers/_axes.py,sha256=gLymbk5WYBdaJ8pVnSJH4X8SMs_foNJIDRN4pDeP6To,10659
+figrecipe/_wrappers/_figure.py,sha256=ZSCH5jVgZbb9kgXyj_LumV52v5vspmRQ3N1KzY37CaQ,6491
+figrecipe/styles/__init__.py,sha256=vGKtlJkUi06i0QC4qEw3ebUwpxTgablFUlyABSYr1Co,976
+figrecipe/styles/_style_applier.py,sha256=f0iPzV5IF2yy94yirVYD9hd7op1EDYQqo8xcL2qBZVU,14238
+figrecipe/styles/_style_loader.py,sha256=4LazXQzZRmRsWj3TvtDgCXP_Mp5nJca9bXmMH7LnsHw,13342
+figrecipe-0.5.0.dist-info/METADATA,sha256=WbJp4fSSIse1uB_1c1ar2KL3ktYBVznKA_78fYFusFk,8924
+figrecipe-0.5.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+figrecipe-0.5.0.dist-info/licenses/LICENSE,sha256=TfPDBt3ar0uv_f9cqCDMZ5rIzW3CY8anRRd4PkL6ejs,34522
+figrecipe-0.5.0.dist-info/RECORD,,

figrecipe-0.5.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any