prevalidate-cluster

A language-agnostic dry-run tool that users can run on a cluster before sbatch, that profiles their task and flags cluster-unfriendly behavior

• GitHub

• Created by Florence Bockting | GitHub @florence-bockting
• MIT License

Install with pip install prevalidate-cluster (or uv add prevalidate-cluster), then import as prevc.

Features

• TODO

Documentation

Documentation is built with Zensical and deployed to GitHub Pages.

• Live site: https://florence-bockting.github.io/prevalidate-cluster/
• Preview locally: just docs-serve (serves at http://localhost:8000)
• Build: just docs-build

API documentation is auto-generated from docstrings using mkdocstrings.

Docs deploy automatically on push to main via GitHub Actions. To enable this, go to your repo's Settings > Pages and set the source to GitHub Actions.

Development

To set up for local development:

# Clone your fork
git clone git@github.com:your_username/prevalidate-cluster.git
cd prevalidate-cluster

# Install in editable mode with live updates
uv tool install --editable .

This installs the CLI globally but with live updates - any changes you make to the source code are immediately available when you run prevc.

Run tests:

uv run pytest

Run quality checks (format, lint, type check, test):

just qa

Author

prevalidate-cluster was created in 2026 by Florence Bockting.

Built with Cookiecutter and the audreyfeldroy/cookiecutter-pypackage project template.