figures#
The figures package renders the analysis artefacts as Matplotlib figures. Each figure is built by a
function that takes a dataframe and returns a figure; a CLI subcommand resolves a cached analysis
run (the latest of its stage unless --run names one), builds the figure, and writes a PDF and a
PNG under artefacts/figures/<stage>/<run-hash>/ beside a JSON sidecar that records the source run
and the package version.
Figures by page#
Each figure belongs to a hypothesis article or a foundational page and is drawn by one builder module. The table maps a documentation page to its figures, the module that builds them, and the command that renders them.
Page |
Figures |
Module |
Command |
|---|---|---|---|
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
Publishing#
artefacts/ is gitignored, so the figures do not reach the published site on their own. figures publish copies the rendered PNGs into docs/source/_figures/, the committed directory the pages
embed, and writes a provenance sidecar beside each recording the source stage, run hash, and commit;
a figure not yet rendered is skipped. Only the PNGs cross into the committed tree: they are
aggregate, non-disclosive summaries, so committing them stays within the data governance that keeps
the rest of artefacts/ out of the history.
Reference