Update readme.md

README.md

@@ -1,3 +1,69 @@
----
-license: cc-by-4.0
----
+---
+license: cc-by-4.0
+pretty_name: SparseWake
+tags:
+- benchmark
+- synthetic-data
+- hydrodynamics
+- time-series
+- regression
+- physical-sensing
+---
+
+# Dataset Name
+SparseWake
+
+## Dataset summary
+
+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 contains processed synthetic data generated from a DNS-parameterized fish-schooling agent-based model.
+
+The released data support the evaluation protocol described in the anonymous submission: held-out follower poses, temporal-history sweeps, sensor-count ablations, component-separated flow inputs, common raw-noise stress tests, and self-signal controls.
+
+## What is included
+
+- Processed HDF5 benchmark files.
+- Dataset metadata and sensor coordinates.
+- Held-out-pose split protocol.
+- Summary CSV files for reported tables and figures.
+- Lightweight loading and verification scripts.
+- Checksums and file manifest.
+
+## What is not included
+
+The upstream fish-schooling ABM source code and the underlying high-fidelity CFD solver are not redistributed. The release is intended to reproduce benchmark evaluations from the processed HDF5 files, not to regenerate the DNS-parameterized wake library from first principles.
+
+## Intended use
+
+This dataset is intended for evaluating sparse temporal physical sensing, hydrodynamic neighbor-state estimation, and reproducibility of the reported benchmark protocol.
+
+## Not Intended Use
+
+SparseWake is not a full biological lateral-line pressure model, a multi-neighbor schooling model, or a replacement for direct CFD solvers.
+
+## Data Source
+
+The processed data were generated from WakeSchool, an external fish-schooling simulator with DNS-parameterized wake and body-flow components. The artifact starts from processed HDF5 benchmark datasets and does not redistribute simulator source code.
+
+## Released Fields
+
+- `X_raw`: wake-plus-potential induced velocity features, sample shape `[N, 6, 3]` after loading.
+- `X_wake_raw`: wake-only induced velocity features where available.
+- `X_potential_raw`: potential-only induced velocity features where available.
+- `X_external_raw`, `X_self_raw`, `X_total_raw`: self-signal controls where available.
+- `y`: labels with columns `delta_x`, `delta_y`, `theta_rel`, `sin_phi`, `cos_phi`, `phi`.
+- `groups`: wake phase index.
+- `pose_id`: pose index for pose-holdout splitting in the sample dataset; full datasets can derive it from phase blocks.
+- `region_id`: region code for close wake, near side, and mid wake.
+- `sensor_world_positions`: sensor coordinates for each sample.
+
+## Units and Conventions
+
+Lengths are nondimensionalized by fish body length. Angles are stored in radians. Reported orientation metrics use degrees. The fish body is represented with semi-axes `a = 0.5 L` and `b = 0.075 L`.
+
+## Sensor Layout
+
+Six body-fixed sensors are arranged as anterior, midbody, and posterior left/right pairs. Sensor names are stored in documentation and sample HDF5 attributes.
+
+## Ethical Considerations
+
+The dataset is synthetic fluid-dynamics data. It contains no human subjects, no animal measurements, and no personal data.