Hugging Face's logo

Datasets:
SparseWake
/
sparsewake

Tags:
benchmark
synthetic-data
hydrodynamics
time-series
regression
physical-sensing
License:
Dataset card Files
xet
 Community
sparsewake / RELEASE_CHECKLIST.md
SparseWake's picture
SparseWake
Upload dataset
e45abdb verified
preview code
|
raw
history blame contribute delete
2.23 kB

SparseWake Anonymous Release Checklist

Required Before Upload

  • Upload only the release-tree contents; do not include the parent .git directory.
  • Confirm the three full HDF5 files are present in data/processed/.
  • Run python scripts/verify_dataset.py --data data/sample/sparsewake_sample.h5 --checksums data/checksums.sha256 after final packaging contents are fixed.
  • Confirm MANIFEST.json and data/checksums.sha256 match the final upload contents.
  • Inspect the uploaded file list for hidden files, notebooks, local logs, cache folders, and OS metadata.
  • Do not include development directories outside the artifact tree.
  • Confirm Croissant metadata remains anonymous and does not contain creator email, institution, publisher, non-anonymous URL, or local path.
  • Confirm the license is listed as cc-by-4.0 in the dataset card.

Reviewer Smoke-Test Commands 

python -m venv .venv
.venv/Scripts/pip install -r requirements.txt
python scripts/verify_dataset.py --data data/sample/sparsewake_sample.h5 --checksums data/checksums.sha256
python scripts/train_temporal_mlp.py --config configs/main_v04.yaml --data data/sample/sparsewake_sample.h5 --quick
python scripts/reproduce_tables.py --results data/results --out tables
python scripts/make_main_figures.py --results data/results --out figures
python scripts/make_supp_figures.py --results data/results --out figures

Use .venv/bin/pip and .venv/bin/python on Unix-like systems.

Final Manual Review

  • README states benchmark purpose, dataset structure, HDF5 fields, targets, sensors, splits, metrics, reproduction commands, compute expectations, limitations, license, and citation.
  • Dataset card states synthetic/simulated origin, intended and out-of-scope use, limitations, no human or private data, and why upstream simulator/source code is not redistributed.
  • Referenced figures exist at figures/main/Fig1.pdf through Fig3.pdf and figures/supp/Fig4.pdf through Fig9.pdf.
  • Stored summary CSVs in data/results/ match manuscript tables and figures within rounding tolerance.
  • AUDIT_REPORT.md lists unresolved issues, changed files, tested commands, and revision notes.