Skip to main content

Minimal pgfplots wrapper for marimo notebooks

Project description

pypgfplots

Minimal Python wrapper that renders pgfplots figures as high-quality PNG inside marimo notebooks. Figures are identical to what you would include in a LaTeX paper or slide deck — because they are LaTeX.

Requires a working LaTeX installation with pdflatex on $PATH, plus a PDF→PNG converter — install one of:

brew install poppler       # provides pdftoppm (recommended)
brew install mupdf-tools   # provides mutool
brew install imagemagick   # provides convert

Ghostscript (gs) is also accepted if already on $PATH.


Installation

From GitHub with uv (recommended)

uv add git+https://github.com/bjoseru/pypgfplots

Inside a marimo notebook

Add a cell at the top:

import subprocess
subprocess.run(["uv", "pip", "install", "git+https://github.com/bjoseru/pypgfplots"])

Or use marimo's package manager sidebar (requires uv backend).

Plain pip

pip install git+https://github.com/bjoseru/pypgfplots

Quick start

from pypgfplots import Axis

a = Axis(title="Parabola", xlabel=r"$x$", ylabel=r"$f(x)$")
a.addplot(r"x^2", color="red", domain="-2:2", samples=100)
a  # displays as PNG in marimo

Combine two axes side by side:

a = Axis(title="Left")
a.addplot(r"sin(deg(x))", domain="0:6.28")

b = Axis(title="Right", axis_lines="left")
b.addplot(r"cos(deg(x))", domain="0:6.28")

a + b  # renders both in one tikzpicture

Coordinate data

coords = " ".join(f"({x},{x**2})" for x in range(6))
a = Axis()
a.addplot(coords, _type="coordinates", mark="*", color="blue")
a

Table data

a = Axis()
a.addplot("data.csv", _type="table", col_sep="comma", x="time", y="value")
a

3-D plots

a = Axis()
a.addplot3(r"x^2 + y^2", domain="-2:2", samples=30)
a

Global settings

from pypgfplots import pgfplotset, preamble, classoptions

pgfplotset(compat="1.18")
preamble(r"\usepackage{amsmath}")
classoptions("border=5pt")

Export

a.save_pdf("figure.pdf")   # compile and write PDF
a.save_tex("figure.tex")   # write LaTeX source (no compilation)
src = a.latex()             # full standalone source as string
log = a.compile_log()       # pdflatex output of last run

Development

Clone the repo and install in editable mode:

git clone https://github.com/bjoseru/pypgfplots
cd pypgfplots
uv pip install -e .

Run the tests:

uv run --with pytest pytest

Tests that require pdflatex and a PDF→PNG converter are skipped automatically if those tools are not on $PATH. To run only the pure-Python unit tests:

uv run --with pytest pytest tests/test_core.py tests/test_options.py

Pipeline

Display:  Python API  →  .tex  →  pdflatex  →  PDF  →  pdftoppm  →  PNG  →  marimo
PDF:      Python API  →  .tex  →  pdflatex  →  PDF

The PNG is delivered via _repr_html_() and is therefore also usable in Jupyter.


License

MIT — see LICENSE.

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

pypgfplots-0.1.9.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

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

pypgfplots-0.1.9-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file pypgfplots-0.1.9.tar.gz.

File metadata

  • Download URL: pypgfplots-0.1.9.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pypgfplots-0.1.9.tar.gz
Algorithm Hash digest
SHA256 0fc70e47ad549b883be956037c26092c6fcea2e0df6efd96a664fce5b709cd19
MD5 a54523f535606dc47d6a58f9d1913a43
BLAKE2b-256 f612d1d77f151030f143dd1dd4f135982a7a4ac552369443f39a18d57ccc5286

See more details on using hashes here.

Provenance

The following attestation bundles were made for pypgfplots-0.1.9.tar.gz:

Publisher: publish.yml on bjoseru/pypgfplots

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pypgfplots-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: pypgfplots-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pypgfplots-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 efb95cf1c28ab63c45d705eec591c8a58bb6ed449c688aa2ae855e853d890fc4
MD5 dc3562c2c87ec52bcc2311c7324fa2e4
BLAKE2b-256 a11b0b76f59cf7293ab2cc9ded6a3c59aef44efddb0eea77a332f559558217ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for pypgfplots-0.1.9-py3-none-any.whl:

Publisher: publish.yml on bjoseru/pypgfplots

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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