figquilt 0.1.0

figquilt is a small, language-agnostic CLI tool that composes multiple figures (PDF/SVG/PNG) into a single publication-ready figure, based on a simple layout file (YAML/JSON). The key function is creating a PDF by composing multiple PDFs and adding subfigure labels and minimal annotations.

figquilt

Figure quilter: A CLI tool to compositing multiple figures (PDF, SVG, PNG) into a publication-ready figure layout.

figquilt takes a simple layout file (YAML) describing panels and their positions, composed of various inputs (plots from R/Python, diagrams, photos), and stitches them into a single output file (PDF, SVG) with precise dimension control and automatic labeling.

Features

• Precise Layout: Define exact physical dimensions (mm) for the page and panels.
• Mixed Media: Combine PDF, SVG, and PNG inputs in one figure.
• Automated Labeling: Automatically add subfigure labels (A, B, C...) with consistent styling.
• Reproducible: Layouts are defined in version-controllable text files (YAML).
• Language Agnostic: It is a CLI tool, so it works with outputs from any tool (R, Python, Julia, Inkscape, etc.).

Installation

This project uses uv for dependency management.

# Clone the repository
git clone https://github.com/yy/figquilt.git
cd figquilt

# Install dependencies and set up the environment
uv sync

# Install the package in editable mode
uv pip install -e .

Usage

Define a layout in a YAML file (e.g., figure1.yaml):

page:
  width: 180  # mm
  height: 120 # mm
  
panels:
  - id: A
    file: "plots/scatter.pdf"
    width: 80
    x: 0
    y: 0
  - id: B
    file: "diagrams/schematic.svg"
    width: 80
    x: 90
    y: 0

Run figquilt to generate the figure:

figquilt figure1.yaml figure1.pdf