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.11.0.tar.gz (9.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.11.0-py3-none-any.whl (546.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: figrecipe-0.11.0.tar.gz
  • Upload date:
  • Size: 9.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.11.0.tar.gz
Algorithm Hash digest
SHA256 e54d37e5681714da8e9f8fe3c558a66fc6b3f3599d09241464569720c7892d5a
MD5 26eb5c9ef1c05ed2e7b50f4f0c2a7803
BLAKE2b-256 23bc8146266e32aba44f0fca80a85209a26f117c66453ab92ea58fb32f5531ab

See more details on using hashes here.

File details

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

File metadata

  • Download URL: figrecipe-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 546.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.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7efaeae90dcaa4e64bbfa87b28dfef018d796532b5b9fbd643c62b4be1fb8679
MD5 693253185152601aa4017b264b22c34f
BLAKE2b-256 610c07642016a1c133ff21af9b96b1260d6767e7eda2061bda32a65698c7a002

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