Skip to main content

Reproducible matplotlib wrapper with mm-precision layouts

Project description

FigRecipe

Reproducible scientific figures as first-class objects

PyPI version Tests License: AGPL-3.0

FigRecipe is a framework for creating reproducible, editable, and publication-ready scientific figures.

Instead of treating figures as static images, FigRecipe treats them as structured objects — with explicit data, layout, and style — that can be reproduced, edited, and shared.

Part of SciTeX™.

FigRecipe GUI Editor

Why FigRecipe?

Most scientific figures are created by code, but cannot be reproduced once the code is lost or modified.

FigRecipe solves this by separating:

  • What is plotted (data & semantics)
  • How it is styled (layout, colors, typography)
  • How it is edited (GUI or code)

This makes figures: reproducible · inspectable · editable after publication

Quick Start

pip install figrecipe
import figrecipe as fr
import numpy as np

fig, ax = fr.subplots()
ax.plot(np.sin(np.linspace(0, 10, 100)), id="sine")

fr.save(fig, "figure.png")  # → figure.png + figure.yaml

Reopen and edit later:

fig, ax = fr.load("figure.png")
fr.edit(fig)  # Launch GUI editor

CLI:

figrecipe edit figure.png      # Launch GUI editor
figrecipe reproduce fig.yaml   # Recreate figure
figrecipe extract fig.yaml     # Extract plotted data

What Makes FigRecipe Different?

🔹 Figures are first-class objects — Figures are not just images — they are structured, versionable artifacts.

🔹 Declarative, not imperative — You describe what the figure is, not just how to draw it.

🔹 GUI + Code coexist — The GUI is a frontend, not a black box. Everything is backed by a reproducible spec.

🔹 Millimeter-precise layout — Designed for journal figures, not dashboards.

Core Features
  • Drop-in replacement for matplotlib.pyplot
  • Fully reproducible figure recipes (.yaml)
  • Publication-ready millimeter layout
  • Interactive GUI editor
  • Dark / light themes
  • Works with existing matplotlib code
Save / Load Formats
fr.save(fig, "fig.png")     # fig.png + fig.yaml
fr.save(fig, "bundle/")     # directory bundle
fr.save(fig, "fig.zip")     # zip bundle

fr.load("fig.png")
fr.load("bundle/")
fr.load("fig.zip")
Format Save Load
PNG / PDF / SVG
YAML
Directory / ZIP
Style Presets
fr.list_presets()
fr.load_style("SCITEX")
fr.load_style("SCITEX_DARK")
Millimeter-based Layout
fig, ax = fr.subplots(
    axes_width_mm=60,
    axes_height_mm=40,
    margin_left_mm=15,
)
Figure Captions
fig.set_caption("Main figure description")
ax.set_caption("Panel A description")

Who Is This For?

FigRecipe is designed for researchers who:

  • already use matplotlib or seaborn
  • care about reproducibility and traceability
  • want figures that survive revisions and collaboration
  • are tired of re-writing plotting code

It is not meant to replace exploratory notebooks or quick plotting — it is meant to formalize results.

Philosophy

A scientific figure is not an image. It is a structured representation of knowledge.

FigRecipe treats figures as first-class scientific objects.


SciTeX
AGPL-3.0 · ywatanabe@scitex.ai

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

figrecipe-0.14.0.tar.gz (4.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

figrecipe-0.14.0-py3-none-any.whl (574.0 kB view details)

Uploaded Python 3

File details

Details for the file figrecipe-0.14.0.tar.gz.

File metadata

  • Download URL: figrecipe-0.14.0.tar.gz
  • Upload date:
  • Size: 4.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for figrecipe-0.14.0.tar.gz
Algorithm Hash digest
SHA256 6058d2ab41399527c8e3311264d7c02db4e261006768a373b4d7ef6c0968f26d
MD5 576c84efc6c2fec8a306eb652a9d83e1
BLAKE2b-256 993cf31af55697c9093ff4fc965487ee0b185a4e524f36053df9241a4763c809

See more details on using hashes here.

File details

Details for the file figrecipe-0.14.0-py3-none-any.whl.

File metadata

  • Download URL: figrecipe-0.14.0-py3-none-any.whl
  • Upload date:
  • Size: 574.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for figrecipe-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 77858ea9f41d971c2fcfbb5bd36adf98d8bf8874668d62ec77ac35b00c0d4228
MD5 998cc5ac54d24272de1fe0fb9d94b31e
BLAKE2b-256 0c5b510bbfc65ee414e0127055a626aa949c425fce294a75c08e34666ab8d550

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page