diff --git a/careless/README.md b/careless/README.md index b2df471..ff05205 100644 --- a/careless/README.md +++ b/careless/README.md @@ -21,6 +21,40 @@ Loading the module puts the venv's `bin/` on `PATH` (the `careless` command is directly available, no activation needed) and sets `CARELESS_ENV` to the venv path. +## Verifying the install + +Run on a Ra login node after building (in order, cheap to expensive): + +```sh +# 1. module is visible and loads +module search careless +module load careless/ + +# 2. modulefile wiring: PATH + CARELESS_ENV +which careless # -> .../careless//venv/bin/careless +echo $CARELESS_ENV # -> .../venv + +# 3. venv is self-contained: must resolve inside the module PREFIX, +# not the builder's home cache (which may be cleaned later) +readlink -f "$CARELESS_ENV/bin/python" + +# 4. CLI entry point; imports the full TensorFlow stack +careless --help # usage text, no traceback + +# 5. installed version matches the one requested +"$CARELESS_ENV/bin/python" -c "import careless; print(careless.__version__)" + +# 6. GPU pickup (GPU node only; [] on a CPU node is fine) +"$CARELESS_ENV/bin/python" -c "import tensorflow as tf; print(tf.config.list_physical_devices('GPU'))" +``` + +Optional end-to-end smoke test with a small unmerged mtz (a few seconds; +proves the TF graph builds and the optimizer steps): + +```sh +careless mono dHKL /tmp/careless_test --iterations 10 +``` + ## Adding a new version Add the version under `versions:` in `files/config.yaml`, then on a Ra