Install

Only uv is needed; it fetches a suitable Python itself.

git clone https://github.com/C2SM/runhealth.git
cd runhealth
uv sync
uv run runhealth --help

Add uv run in front of runhealth in every example in this documentation, or activate the environment once with source .venv/bin/activate.

Placing the environment elsewhere under a tight inode quota

The environment holds a few thousand files, which count against the inode quota of some parallel file systems.

export UV_PROJECT_ENVIRONMENT=$SCRATCH/venvs/runhealth
uv sync

Keep that variable exported for uv run as well.

Installing with pip instead

pip install -e .
runhealth --help

Requirements: Python 3.11 or newer and pyyaml. The figures are drawn as SVG by runhealth itself, so no plotting library has to be installed.

PDF output requires one additional package, and only if runhealth is to write the PDF itself rather than the HTML being printed from a browser:

uv sync --extra pdf

See Output formats.