Install figure-gate¶
Three routes put the checkers on your machine. The two package routes carry a
release; a clone of main carries the development version.
Choose a route:
- Vendored if you want to read and edit the rules beside the figures they gate. The tutorial and the how-to guides use this route.
- Installed if you want to pin a version.
- conda-forge if your environment is managed by conda.
For the version each route needs, see Compatibility.
git clone https://github.com/narenp12/figure-gate
cp figure-gate/skill/assets/figure.mplstyle your-project/diagrams/
cp figure-gate/skill/scripts/check_palette.py your-project/diagrams/
cp figure-gate/skill/scripts/check_figure.py your-project/diagrams/
cp figure-gate/skill/scripts/suggest_fixes.py your-project/diagrams/ # optional
Copy check_palette.py even if you only want to check figures
check_figure.py imports it, and that import is what the series-color
and colormap rows travel on. Without it, neither row can judge a color:
both warn, naming the missing file. A warn cannot fail a build, so a
copy that leaves it out audits with the only color checks in the file
switched off.
uv add figure-gate # the library, and the two commands
uv tool install figure-gate # the two commands only, no import
Installing puts the two checkers on your PATH as check-palette and
check-figure. Only this route gives your type checker the annotations; see
Type annotations.
conda-forge follows PyPI through the feedstock's autotick bot, which opens the version bump some hours after a release. Until that merges, the conda package is the previous release. The badges on the repository show what each index is serving now.
To check what you got:
Choose your import line¶
The import line depends on your route and, if you installed, on your version. Import lines by version says why.
The same line a vendored copy uses:
Configure it for your document¶
Two settings take values only you know. Both are optional, and both change what the checks measure against.
- Set
font.serifinfigure.mplstyleto your document's body typeface. - Set
CONTENT_WIDTH_PTat the top ofcheck_figure.pyto the usable width of your page, in points.
Left as None, CONTENT_WIDTH_PT gives a scale of 1.0 and the page calculation
does nothing. That is correct if you author every figure at the width it is
placed at. To override it for one call, pass venue= instead. See
Place a figure at a venue's width.
If your style sheet lives somewhere other than beside check_figure.py, set
STYLE_SHEET at the top of that file to the path. Left as None, the checker
looks beside the script, then in an assets/ directory next to it.
CONTENT_WIDTH_PT, STYLE_SHEET and the thresholds can be written in a file
instead:
figure-gate.toml at the project root, or a [tool.figure-gate] table in
pyproject.toml. That is the route to take when more than one person authors
the figures. See
Agree on thresholds across a project.
If you install the package rather than vendoring it, figure.mplstyle ships
inside it, beside the module that reads it. That is where the style-sheet gate
looks.
The style-sheet gate warns when it finds no sheet
Without a sheet to compare against, the gate cannot judge the figure it
exists to catch: one drawn with plt.style.use forgotten entirely. It
warns rather than passing, and the warn is advisory, so it names the
problem without failing a build.
Install it as a Claude Code skill¶
This repository is also a plugin marketplace, so Claude Code can install the skill and track updates against the tags the project already cuts:
Then run /plugin install figure-gate@figure-gate. The skill is invoked as
figure-gate:research-figures.
To edit the thresholds in place, copy the skill instead:
Claude then runs these checks when you ask for a figure for a paper or a deck.
Next steps¶
- Gate your first figure if you have not run the checkers before.
- How-to guides for a task you already have in mind.