project_template

Minimal Python + HPC project skeleton.

Rename checklist

After copying, replace project_template in:

• pyproject.toml (name, packages)
• src/project_template/ (directory name)
• scripts/submit.py (PROJECT_NAME, ENTRY_MODULE)
• mutagen.yml (session name, beta: path)

Setup

python -m venv .venv && source .venv/bin/activate
pip install -e .

Run locally

python -m project_template.train

Paths default to repo-relative (./data, ./experiments).

Run on cluster

Sync:

mutagen project create -f mutagen.yml

Submit:

ssh jz
cd /path/on/cluster && python scripts/submit.py

submit.py rsyncs src/ into a timestamped run dir under $SCRATCH, then exports DATA_DIR / EXPERIMENTS_DIR / HF_HOME before invoking the entry function.

Path contract

All I/O goes through project_template.paths. Never hardcode paths or read $SCRATCH outside that module.