SparseWake commited on
Commit
36da428
·
verified ·
1 Parent(s): e45abdb

Update details

Browse files
Files changed (1) hide show
  1. README.md +4 -7
README.md CHANGED
@@ -14,8 +14,7 @@ tags:
14
 
15
  # SparseWake
16
 
17
- SparseWake is an anonymous benchmark artifact for sparse temporal hydrodynamic sensing. It contains processed HDF5 datasets, metadata, summary CSV files, figures, checksums, and lightweight Python scripts for inspecting the data and reproducing benchmark-level evaluation outputs.
18
-
19
  ## Dataset Summary
20
 
21
  SparseWake evaluates whether sparse body-fixed temporal flow measurements can recover the relative state of a neighboring wake-producing fish in a controlled single-leader setting. The benchmark data are synthetic and were generated from a DNS-parameterized fish-schooling agent-based model. The artifact starts from processed HDF5 files and does not require the upstream simulator or high-fidelity solver.
@@ -27,9 +26,8 @@ The released data support held-out-pose evaluation, temporal-history sweeps, sen
27
  - Full processed HDF5 benchmark datasets in `data/processed/`.
28
  - A small sample HDF5 file in `data/sample/` for inspection and smoke tests.
29
  - Dataset metadata, schema documentation, split protocol, provenance notes, and limitations in `docs/`.
30
- - Summary CSV files for reported tables and figures in `data/results/`.
31
  - Reproduced table CSVs in `tables/`.
32
- - Manuscript-compatible figure PDFs and script-generated figure outputs in `figures/`.
33
  - Lightweight loading, verification, plotting, and smoke-test training scripts in `scripts/`.
34
  - Minimal reusable Python utilities in `src/sparsewake/`.
35
  - Checksums in `data/checksums.sha256` and a full file manifest in `MANIFEST.json`.
@@ -92,7 +90,7 @@ python scripts/reproduce_tables.py --results data/results --out tables
92
 
93
  On Unix-like systems, use `.venv/bin/pip` and `.venv/bin/python`.
94
 
95
- ## Reproduce Stored Tables and Figures
96
 
97
  ```bash
98
  python scripts/reproduce_tables.py --results data/results --out tables
@@ -100,8 +98,7 @@ python scripts/make_main_figures.py --results data/results --out figures
100
  python scripts/make_supp_figures.py --results data/results --out figures
101
  ```
102
 
103
- These commands use stored summary CSV files and are intended for fast verification. Full training reruns are supported by `scripts/train_temporal_mlp.py` and `scripts/run_main_evaluation.py` when the full processed HDF5 files are present.
104
-
105
  ## License
106
 
107
  The SparseWake processed datasets, metadata, result summaries, documentation, and release utilities are made available under the Creative Commons Attribution 4.0 International license (CC BY 4.0). Upstream simulator source code and solver assets are not redistributed and are not covered by this dataset release.
 
14
 
15
  # SparseWake
16
 
17
+ SparseWake is an anonymous benchmark artifact for sparse temporal hydrodynamic sensing. It contains processed HDF5 datasets, metadata, summary CSV files, checksums, and lightweight Python scripts for inspecting the data and reproducing benchmark-level evaluation outputs.
 
18
  ## Dataset Summary
19
 
20
  SparseWake evaluates whether sparse body-fixed temporal flow measurements can recover the relative state of a neighboring wake-producing fish in a controlled single-leader setting. The benchmark data are synthetic and were generated from a DNS-parameterized fish-schooling agent-based model. The artifact starts from processed HDF5 files and does not require the upstream simulator or high-fidelity solver.
 
26
  - Full processed HDF5 benchmark datasets in `data/processed/`.
27
  - A small sample HDF5 file in `data/sample/` for inspection and smoke tests.
28
  - Dataset metadata, schema documentation, split protocol, provenance notes, and limitations in `docs/`.
29
+ - Summary CSV files for reported tables and figure-level results in `data/results/`.
30
  - Reproduced table CSVs in `tables/`.
 
31
  - Lightweight loading, verification, plotting, and smoke-test training scripts in `scripts/`.
32
  - Minimal reusable Python utilities in `src/sparsewake/`.
33
  - Checksums in `data/checksums.sha256` and a full file manifest in `MANIFEST.json`.
 
90
 
91
  On Unix-like systems, use `.venv/bin/pip` and `.venv/bin/python`.
92
 
93
+ ## Reproduce Stored Tables and Diagnostic Plots
94
 
95
  ```bash
96
  python scripts/reproduce_tables.py --results data/results --out tables
 
98
  python scripts/make_supp_figures.py --results data/results --out figures
99
  ```
100
 
101
+ These commands use stored summary CSV files and are intended for fast numerical verification and diagnostic plotting. Final manuscript figures may include manual layout adjustments and are not part of the dataset artifact.
 
102
  ## License
103
 
104
  The SparseWake processed datasets, metadata, result summaries, documentation, and release utilities are made available under the Creative Commons Attribution 4.0 International license (CC BY 4.0). Upstream simulator source code and solver assets are not redistributed and are not covered by this dataset release.