From 0e821cf2517142bac86807ca85e0cdc12f80f98c Mon Sep 17 00:00:00 2001
From: Tibo De Peuter <tibo.depeuter@ugent.be>
Date: Wed, 1 Apr 2026 19:34:47 +0200
Subject: [PATCH] docs: add HPC integration instructions

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index 47b0552..4cbfd4b 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,33 @@ example command:
 ```bash
 uv run src/train.py --model_name my_model --epochs 50 --batch_size 32
 ```
+
+## HPC Integration
+
+To run training on the VSC HPC (Ghent Tier 2):
+
+### Setup
+
+Run the installation script once on a login node. This sets up a virtual environment in `$VSC_DATA` with the required system modules (JAX, Flax, WandB) and lightweight dependencies.
+
+```bash
+bash scripts/hpc_install.sh
+```
+
+### Smoke Test
+Verify everything runs on a compute node:
+```bash
+python src/train.py --config configs/hpc_smoke_test.yaml
+```
+
+### Submitting Jobs
+Submit long-running experiments via the provided Slurm script:
+```bash
+sbatch scripts/hpc_train.slurm
+```
+
+### Syncing WandB
+Since compute nodes are offline, sync your WandB logs after the job finishes:
+```bash
+wandb sync runs/<run_name>/wandb
+```