Skip to main content

Python library for reproducible, multi-panel scientific figures, with byte-identical output across machines and an extension API for custom plot types.

Project description

plotlet

plotlet is a Python library for reproducible, multi-panel scientific figures. Byte-identical output across machines, a standard plotting vocabulary, and a first-class extension story for custom plot types.

Documentation

Hands-on tour with executable examples:

Reference docs in docs/:

  • API reference — mark methods, frame options, scales, tick overrides
  • Philosophy — what's in core, what's not, and why
  • Subplots — multi-panel composition, shared scales
  • Coordinates — Circular, custom non-Cartesian projections
  • Extending — write your own plot type
  • Themes — visual presets
  • AI attributesdata-plotlet-* schema for automation

Reference plot types beyond the standard vocabulary ship in the separate plotlet-extensions package (single-file artists — sankey, alluvial, raincloud, upset_plot, …; pip install plotlet-extensions, then import plotlet.extensions.<name>) and in the plotlet-cookbook repo (multi-file, domain-specific projects). A few extensions the core tests depend on still ship in core under src/plotlet/extensions/.

For AI assistants

Compact, vendor-neutral onboarding docs live in skills/:

  • skills/users.md — for AI tools generating plotlet code on a user's behalf.
  • skills/developers.md — for AI (or human) contributors working on plotlet itself. Symlink as CLAUDE.md / .cursorrules / AGENTS.md as your tool expects.

Dependencies

plotlet supports Python 3.10+.

Required: fonttools, scipy (regression, qq, CI error bands, clustering/dendrogram), resvg_py (PNG rendering — prebuilt wheels, no system libraries). numpy / pandas / polars inputs work transparently.

Optional: cairosvg for PDF export (pip install plotlet[pdf]).

Installation

pip install plotlet

Testing

pip install -e ".[test]"
pytest tests/                  # check vs. committed baselines
pytest tests/ --update         # regenerate (review the diff!)

Development

Development takes place on GitHub. Please submit bugs to the issue tracker with a reproducible example.

License

MIT

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

plotlet-0.6.0.tar.gz (3.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plotlet-0.6.0-py3-none-any.whl (3.0 MB view details)

Uploaded Python 3

File details

Details for the file plotlet-0.6.0.tar.gz.

File metadata

  • Download URL: plotlet-0.6.0.tar.gz
  • Upload date:
  • Size: 3.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for plotlet-0.6.0.tar.gz
Algorithm Hash digest
SHA256 e0f40fe808d88712ec95f09c1755c6ad79129850d51a2a9d54e9dfa0cd7e689b
MD5 d711102ce4ddc8110e4662507bae8983
BLAKE2b-256 22d83dfd86084c24b45af94902836bb5834598b53a9ea68f91108934a340572c

See more details on using hashes here.

File details

Details for the file plotlet-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: plotlet-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 3.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for plotlet-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c9f953a8629a07fe5348c12d7905b1dea3387ecc7ab636201df00c35daab0f9b
MD5 4723b651e8dab1c187da8dbe835bdfd1
BLAKE2b-256 150dc97bc7543f8fc66e62806bae994223af4c0542901c685d76cf1354c02a79

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