Installation

PlotNado uses standard Python packaging, but the recommended workflow is uv.

Requirements

  • Python 3.12+
  • uv
  • Quarto, only if you are building the public documentation site

Install uv

curl -LsSf https://astral.sh/uv/install.sh | sh

On macOS:

brew install uv

Use PlotNado as a CLI

For a user-level command:

uv tool install plotnado
plotnado --help

From a checked-out repository, prefer:

uv run plotnado --help

Develop from source

git clone https://github.com/alsmith151/plotnado
cd plotnado
uv sync --extra dev --extra docs
uv run pytest tests/
uv run python examples/run_examples.py
uv run plotnado --help

uv sync --extra dev --extra docs installs the package, test tools, and documentation dependencies into the project environment.

Build docs locally

uv sync --extra dev --extra docs
QUARTO_PYTHON=.venv/bin/python quarto render
QUARTO_PYTHON=.venv/bin/python quarto preview

The docs use executable Quarto Python cells. Most examples use deterministic in-memory data; optional cooler, CapCruncher, and QuantNado examples need their corresponding dependencies and fixture data.

Pip and Conda

pip and Conda environments can still install PlotNado, but project development and docs examples assume the uv commands above.

python -m venv .venv
source .venv/bin/activate
pip install plotnado