Document results/ folder

README.md

@@ -57,19 +57,54 @@ The `COSIBalloon_*` folders additionally carry a `crossections/` directory —
 MEGAlib-generated cross-section tables. They are regenerated on demand by
 MEGAlib and are included only so the folders are a byte-exact mirror.
 
+## Results
+
+`results/` holds the **outputs** of the ablation study over the datasets above —
+a mirror of `ablations/results/` in the GitHub repo (which remains the source of
+truth; these are generated files, published here so the figures and numbers are
+citable alongside the inputs they came from). 25 MB total.
+
+One folder per run, named by timestamp:
+
+| Run | Contents |
+|---|---|
+| `2026-07-14_09-33-32/` | includes a `no_calibration` ablation, since removed |
+| `2026-07-15_00-45-23/` | |
+| `2026-07-15_05-06-29/` | most recent; adds `deployment` and `label_window` |
+
+Each run folder has:
+
+- `tables/` — one CSV per ablation (`factor_contributions`, `learned_weights`,
+  `no_ckd_order`, `gt_tolerance` / `label_window`, …) plus a `summary.csv`.
+  `deployment.csv` is the champion deployed per dataset at the dedicated-prior
+  operating point.
+- `figures/` — one PNG per ablation at the top level, plus a per-dataset
+  subfolder (`SPILike/`, `NCT/`, `Max/`, `GeACT/`, `COSIBalloon_*/`) of the
+  per-run plots for that geometry.
+
+Regenerate with `python ablations/main.py` from the GitHub repo.
+
 ## Download
 
 ```bash
 hf download aryaraeesi/BEvAn-data --repo-type dataset --local-dir data/
 ```
 
-Or a single dataset (remember to take its `.inc*` chunks along with the `.sim`):
+Note this pulls `results/` into `data/` too. For just the simulation inputs, or
+a single dataset (remember to take its `.inc*` chunks along with the `.sim`):
 
 ```bash
 hf download aryaraeesi/BEvAn-data --repo-type dataset \
   --include "SPILike/*" --local-dir data/
 ```
 
+Or just the results, without the multi-GB simulations:
+
+```bash
+hf download aryaraeesi/BEvAn-data --repo-type dataset \
+  --include "results/*" --local-dir .
+```
+
 ## Gotcha: the geometry path is absolute
 
 The `Geometry` line inside every `.sim` header is an **absolute path from the