FigRecipe

Getting Started

  • Installation
    • Basic Installation
    • Full Installation
    • Individual Extras
    • Development Installation
    • Requirements
  • Quick Start
    • Creating Your First Reproducible Figure
    • Bundle Format (Recommended for Sharing)
    • Saving Figures
    • Output Files
    • Reproducing a Figure
    • CLI Commands
    • MCP Server for AI Agents
    • Statistical Annotations
    • Multi-Panel Composition
    • Box-and-Arrow Diagrams
      • Auto-Fix & Save Options
      • Shapes & Anchors
      • Diagram Validation Rules

User Guide

  • Terminology
    • Core Hierarchy
      • Figure
      • Axes
      • Axis
      • Plot
      • Panel
      • Canvas
      • Style
      • Recipe
    • Editor-Specific Terms
    • Common Confusions
  • Plot Gallery
    • Basic Plots
      • Line Plot
      • Scatter Plot
      • Bar Plot
    • Statistical Plots
      • Histogram
      • Box Plot
      • Violin Plot
    • 2D Plots
      • Heatmap / Imshow
      • Contour Plot
    • Supported Plot Types (47)
    • CSV Column Workflow
    • Statistical Annotations
  • Style Reference
    • Style Anatomy
    • Style Parameters
      • Figure Settings
      • Axes Settings
      • Labels and Title
      • Ticks
      • Lines and Markers
      • Legend
      • Spines
      • Grid
    • Loading Styles
      • Python API
      • Available Presets
      • Custom Styles
  • CLI Reference
    • Usage
    • Figure Creation
      • plot
      • reproduce
      • compose
      • gui
    • Image Processing
      • convert
      • crop
      • diff
      • hitmap
    • Data & Validation
      • extract
      • validate
      • info
    • Diagram
      • diagram
    • Style & Appearance
      • style
      • fonts
    • Integration
      • mcp
      • list-python-apis
    • Utility
      • completion
      • version
  • MCP Specification Format
    • Starting the MCP Server
    • Basic Specification Structure
    • Plot Types
      • Line Plot
      • Scatter Plot
      • Bar Plot
      • Histogram
      • Box Plot
      • Violin Plot
      • Image/Heatmap
      • Contour Plot
      • Fill Between
      • Error Bar
    • CSV Data Input
    • Statistical Annotations
    • Multi-Panel Figures
      • Using Axes Array
    • MCP Tool Reference
      • plt_plot
      • plt_reproduce
      • plt_compose
      • plt_info
      • plt_validate
      • plt_crop
      • plt_extract_data
      • plt_list_styles
      • plt_get_plot_types
    • Diagram Tools
      • diagram_create
      • diagram_render
      • diagram_compile_mermaid
      • diagram_compile_graphviz
      • diagram_list_presets
      • diagram_get_backends
    • All MCP Tools Summary

API Reference

  • FigRecipe API Reference
    • Usage
    • subplots()
    • save()
    • reproduce()
    • load()
    • compose()
    • align_panels()
    • distribute_panels()
    • align_smart()
    • gui()
    • crop()
    • info()
    • validate()
    • extract_data()
    • Figz
      • Figz.__init__()
      • Figz.add_panel()
      • Figz.add_panel_from_png()
      • Figz.create()
      • Figz.get_panel()
      • Figz.get_panel_data()
      • Figz.get_panel_pltz()
      • Figz.list_panel_ids()
      • Figz.remove_panel()
      • Figz.render_preview()
      • Figz.save()
    • Pltz
      • Pltz.__init__()
      • Pltz.create()
      • Pltz.from_png()
      • Pltz.get_preview()
      • Pltz.render_preview()
      • Pltz.reproduce()
      • Pltz.save()
      • Pltz.update_preview()
    • save_bundle()
    • load_bundle()
    • reproduce_bundle()
    • load_style()
    • unload_style()
    • list_presets()
    • Diagram
      • Diagram.__init__()
      • Diagram._auto_anchor()
      • Diagram._auto_box_height()
      • Diagram._finalize_canvas_size()
      • Diagram._get_anchor()
      • Diagram.add_arrow()
      • Diagram.add_box()
      • Diagram.add_container()
      • Diagram.add_icon()
      • Diagram.auto_layout()
      • Diagram.from_dict()
      • Diagram.render()
      • Diagram.render_to_file()
      • Diagram.save()
      • Diagram.to_dict()
      • Diagram.validate_containers()
      • Diagram.validate_no_overlap()
    • signature()
    • caption_with_signature()
    • _Graphviz
    • _Mermaid
    • _get_version()
    • _rebrand_text()
    • Core Functions
      • subplots()
      • save()
      • reproduce()
      • compose()
      • validate()
      • crop()
      • info()
      • extract_data()
    • Recording Classes
      • RecordingFigure
        • RecordingFigure.__init__()
        • RecordingFigure.fig
        • RecordingFigure.axes
        • RecordingFigure.dpi
        • RecordingFigure.draw()
        • RecordingFigure.flat
        • RecordingFigure.record
        • RecordingFigure._get_style_fontsize()
        • RecordingFigure._get_theme_text_color()
        • RecordingFigure.suptitle()
        • RecordingFigure.supxlabel()
        • RecordingFigure.supylabel()
        • RecordingFigure.colorbar()
        • RecordingFigure.add_panel_labels()
        • RecordingFigure.set_title_metadata()
        • RecordingFigure.set_caption()
        • RecordingFigure.title_metadata
        • RecordingFigure.caption
        • RecordingFigure.set_stats()
        • RecordingFigure.stats
        • RecordingFigure.generate_caption()
        • RecordingFigure.__getattr__()
        • RecordingFigure.savefig()
        • RecordingFigure.set_supxyt()
        • RecordingFigure.set_supxytc()
        • RecordingFigure.save_recipe()
      • RecordingAxes
        • RecordingAxes.__init__()
        • RecordingAxes.ax
        • RecordingAxes.position
        • RecordingAxes.__getattr__()
        • RecordingAxes.__dir__()
        • RecordingAxes._create_recording_wrapper()
        • RecordingAxes._create_bar_wrapper()
        • RecordingAxes._create_boxplot_wrapper()
        • RecordingAxes._create_stem_wrapper()
        • RecordingAxes._create_legend_wrapper()
        • RecordingAxes.set_caption()
        • RecordingAxes.panel_caption
        • RecordingAxes.set_stats()
        • RecordingAxes.stats
        • RecordingAxes._no_record()
        • RecordingAxes._record_seaborn_call()
        • RecordingAxes.figure
        • RecordingAxes.xaxis
        • RecordingAxes.yaxis
        • RecordingAxes.get_xlim()
        • RecordingAxes.get_ylim()
        • RecordingAxes.get_xlabel()
        • RecordingAxes.get_ylabel()
        • RecordingAxes.get_title()
        • RecordingAxes.caption
        • RecordingAxes.generate_panel_caption()
    • Style Management
      • load_style()
      • unload_style()
      • list_presets()
    • Alignment Functions
      • align_panels()
      • align_smart()
      • distribute_panels()
    • GUI Editor
      • gui()
    • Diagram Class
      • Diagram
        • Diagram.__init__()
        • Diagram.add_box()
        • Diagram.add_container()
        • Diagram.add_arrow()
        • Diagram.add_icon()
        • Diagram.validate_containers()
        • Diagram.validate_no_overlap()
        • Diagram.auto_layout()
        • Diagram._auto_box_height()
        • Diagram._finalize_canvas_size()
        • Diagram._get_anchor()
        • Diagram._auto_anchor()
        • Diagram.render()
        • Diagram.save()
        • Diagram.render_to_file()
        • Diagram.to_dict()
        • Diagram.from_dict()
FigRecipe
  • Overview: module code

All modules for which code is available

  • figrecipe._api._public
  • figrecipe._api._signature
  • figrecipe._api._style_manager
  • figrecipe._bundle._figz
  • figrecipe._bundle._load
  • figrecipe._bundle._pltz
  • figrecipe._bundle._save
  • figrecipe._composition._alignment
  • figrecipe._composition._compose
  • figrecipe._diagram._diagram._core
  • figrecipe._wrappers._axes
  • figrecipe._wrappers._figure

© Copyright 2026, Yusuke Watanabe.

Built with Sphinx using a theme provided by Read the Docs.