Update dataset card and file table

README.md

@@ -3,29 +3,33 @@ license: other
 license_name: sdrbench
 license_link: https://sdrbench.github.io/
 pretty_name: "SDRBench: NYX"
-viewer: false
 tags:
 - scientific-data
 - lossy-compression
 - sdrbench
 - hpc
 - sz3
+configs:
+- config_name: files
+  data_files: files.jsonl
+  default: true
 ---
 
 # SDRBench — NYX
 
-Cosmology: adaptive mesh hydrodynamics + N-body cosmological simulation. 6 fields of 512x512x512, single precision, little-endian; the _log variant holds log-transformed fields.
+Cosmology: adaptive-mesh hydrodynamics + N-body simulation (Nyx), 512 x 512 x 512, single precision, little-endian.
 
-This repository is an **unmodified mirror** of the NYX dataset from
-[SDRBench](https://sdrbench.github.io/datasets.html), the Scientific Data Reduction Benchmark. The originals are hosted by
-Argonne National Laboratory on Globus; every archive was unpacked and its files uploaded
-byte-for-byte (sha256 verified). `metadata/` holds the original SDRBench property and template
-files. The mirror is kept in sync automatically by
+> **Raw binary arrays, not an Arrow/Parquet dataset.** `datasets.load_dataset("sdrbench/nyx")` returns the table of files (`files.jsonl`: path, dtype, shape, sha256). Read the arrays with the `sdrbench` package or `hf_hub_download` + numpy as shown below.
+
+This repository is an **unmodified mirror** of the NYX data of [SDRBench](https://sdrbench.github.io/datasets.html), the
+Scientific Data Reduction Benchmark. The originals are hosted by Argonne National Laboratory on Globus;
+every archive was unpacked and its files uploaded byte-for-byte (sha256 verified) (revision `e6ce039140`). `metadata/` holds
+the original SDRBench property and template files. Kept in sync automatically by
 [szcompressor/sdrbench](https://github.com/szcompressor/sdrbench).
 
-- **Data source:** Zarija Lukic (LBNL)
-- **Total size:** 6.4 GB
-- **Format:** raw little-endian binary, C order (slowest dimension first)
+- **Data provider:** Zarija Lukic (LBNL)
+- **Size:** 6.4 GB in 2 variant(s)
+- **Format:** raw little-endian binary, C order (slowest dimension first); dtype and shape per field below
 
 ## Usage
 
@@ -38,7 +42,7 @@ import numpy as np
 import sdrbench
 from pysz import sz, szConfig, szErrorBoundMode
 
-ds = sdrbench.dataset("nyx")         # default variant: original
+ds = sdrbench.dataset("nyx")                # default variant "original"
 print(ds.fields)
 x = ds["baryon_density"]                     # numpy array, dtype <f4, shape (512, 512, 512)
 
@@ -52,26 +56,27 @@ max_err, psnr, nrmse = sz.verify(np.asarray(x), y)
 print(f"ratio {ratio:.1f}x, PSNR {psnr:.1f} dB, max error {max_err:.3g}")
 ```
 
-Other variants: `sdrbench.dataset("nyx", "log")`.
-
-Files are downloaded on first use and cached; if Hugging Face is unreachable the package falls
-back to the original archive on Globus.
+Files are fetched on first use (in parallel with `ds.download("data/")`) and cached, pinned to the revision
+of the installed `sdrbench` release; if Hugging Face is unreachable the package falls back to the original
+archive on Globus. Existing local SDRBench copies can be used with `sdrbench.dataset("nyx", root="/path")`.
 
-Without the package, any file can be read with `huggingface_hub` and numpy:
+Without the package, with `huggingface_hub` and numpy only:
 
 ```python
 from huggingface_hub import hf_hub_download
 import numpy as np
-p = hf_hub_download("sdrbench/nyx", "512x512x512/baryon_density.f32", repo_type="dataset")
+p = hf_hub_download("sdrbench/nyx", "512x512x512/baryon_density.f32", repo_type="dataset", revision="e6ce03914098d6dcdf160cb3fe567e7c784c6edf")
 x = np.fromfile(p, dtype="<f4").reshape((512, 512, 512))
 ```
 
-## Contents
+## Variants and fields
 
 
 ### `original` (default)
 
-7 files, 3.2 GB, from [SDRBENCH-EXASKY-NYX-512x512x512.tar.gz](https://g-d0cd3f.fd635.8443.data.globus.org/raw-data/EXASKY/NYX/SDRBENCH-EXASKY-NYX-512x512x512.tar.gz).
+`sdrbench.dataset("nyx", "original")` — folder `512x512x512/` — 7 files, 3.2 GB, from [SDRBENCH-EXASKY-NYX-512x512x512.tar.gz](https://g-d0cd3f.fd635.8443.data.globus.org/raw-data/EXASKY/NYX/SDRBENCH-EXASKY-NYX-512x512x512.tar.gz).
+
+Six fields: baryon and dark-matter density, temperature, velocities.
 
 | Field | dtype | Shape (C order) | File |
 |---|---|---|---|
@@ -86,7 +91,9 @@ Other files: `512x512x512/template_data.txt`
 
 ### `log`
 
-6 files, 3.2 GB, from [SDRBENCH-EXASKY-NYX-512x512x512_log.tar.gz](https://g-d0cd3f.fd635.8443.data.globus.org/raw-data/EXASKY/NYX/SDRBENCH-EXASKY-NYX-512x512x512_log.tar.gz).
+`sdrbench.dataset("nyx", "log")` — folder `512x512x512_log/` — 6 files, 3.2 GB, from [SDRBENCH-EXASKY-NYX-512x512x512_log.tar.gz](https://g-d0cd3f.fd635.8443.data.globus.org/raw-data/EXASKY/NYX/SDRBENCH-EXASKY-NYX-512x512x512_log.tar.gz).
+
+The same fields with the two densities log10-transformed (recommended for visualization).
 
 | Field | dtype | Shape (C order) | File |
 |---|---|---|---|
@@ -99,7 +106,7 @@ Other files: `512x512x512/template_data.txt`
 
 ## Citation
 
-If you use this dataset, please cite SDRBench:
+Please cite SDRBench; `sdrbench cite nyx` prints it:
 
 ```bibtex
 @inproceedings{zhao2020sdrbench,
@@ -113,5 +120,6 @@ If you use this dataset, please cite SDRBench:
 
 ## License and terms
 
-The data are distributed under the same terms as on the [SDRBench website](https://sdrbench.github.io/datasets.html).
-Rights remain with the original data providers listed above.
+The data are distributed by the SDRBench team for research use under the terms of the original
+data providers listed above (see the [SDRBench website](https://sdrbench.github.io/datasets.html)); please acknowledge them as
+requested. Rights remain with the data providers.

files.jsonl

@@ -0,0 +1,13 @@
+{"variant": "original", "field": "baryon_density", "var": "baryon_density", "step": null, "path": "512x512x512/baryon_density.f32", "dtype": "<f4", "shape": [512, 512, 512], "file_shape": [512, 512, 512], "component": null, "transpose": null, "bytes": 536870912, "sha256": "352856560d319c207622662484d358bce2198282de4a50c7d5963b97a4f2986d"}
+{"variant": "original", "field": "dark_matter_density", "var": "dark_matter_density", "step": null, "path": "512x512x512/dark_matter_density.f32", "dtype": "<f4", "shape": [512, 512, 512], "file_shape": [512, 512, 512], "component": null, "transpose": null, "bytes": 536870912, "sha256": "d7cd7ad513afc8b31867e7cab58df8bf28f6e44314e340b8483dbd2057bbe438"}
+{"variant": "original", "field": "temperature", "var": "temperature", "step": null, "path": "512x512x512/temperature.f32", "dtype": "<f4", "shape": [512, 512, 512], "file_shape": [512, 512, 512], "component": null, "transpose": null, "bytes": 536870912, "sha256": "805895e894603952a156605e5b1ffae0bd37f349daa089036a49b8a4a5ed90bd"}
+{"variant": "original", "field": null, "var": null, "step": null, "path": "512x512x512/template_data.txt", "dtype": null, "shape": null, "file_shape": null, "component": null, "transpose": null, "bytes": 440, "sha256": "93db11305d765c267a3b326ee6765ff1467095e1a6e157caf1da4c36cfca17cd"}
+{"variant": "original", "field": "velocity_x", "var": "velocity_x", "step": null, "path": "512x512x512/velocity_x.f32", "dtype": "<f4", "shape": [512, 512, 512], "file_shape": [512, 512, 512], "component": null, "transpose": null, "bytes": 536870912, "sha256": "8796f3bbb05f4b203799f8daba6f5c05258efb769179dcc2b231d2f058fde86b"}
+{"variant": "original", "field": "velocity_y", "var": "velocity_y", "step": null, "path": "512x512x512/velocity_y.f32", "dtype": "<f4", "shape": [512, 512, 512], "file_shape": [512, 512, 512], "component": null, "transpose": null, "bytes": 536870912, "sha256": "1adf59dd2bf1b2a79b3ebbac99a547f448a423f4e30c170fb331adb948318eff"}
+{"variant": "original", "field": "velocity_z", "var": "velocity_z", "step": null, "path": "512x512x512/velocity_z.f32", "dtype": "<f4", "shape": [512, 512, 512], "file_shape": [512, 512, 512], "component": null, "transpose": null, "bytes": 536870912, "sha256": "619553bbe1222743c22cac4da57e64d79659cf3cd1c10a7137aadba9156158b9"}
+{"variant": "log", "field": "baryon_density_log10", "var": "baryon_density_log10", "step": null, "path": "512x512x512_log/baryon_density_log10.f32", "dtype": "<f4", "shape": [512, 512, 512], "file_shape": [512, 512, 512], "component": null, "transpose": null, "bytes": 536870912, "sha256": "c2f5f8d99cdc3be46f54acff5c585beefe315f1180dc8d6204080523e73119aa"}
+{"variant": "log", "field": "dark_matter_density_log10", "var": "dark_matter_density_log10", "step": null, "path": "512x512x512_log/dark_matter_density_log10.f32", "dtype": "<f4", "shape": [512, 512, 512], "file_shape": [512, 512, 512], "component": null, "transpose": null, "bytes": 536870912, "sha256": "d308cc8918d427b7ce563d0bb98ff84fc2bc13faff9743b3cec93b39f3e8de68"}
+{"variant": "log", "field": "temperature", "var": "temperature", "step": null, "path": "512x512x512_log/temperature.f32", "dtype": "<f4", "shape": [512, 512, 512], "file_shape": [512, 512, 512], "component": null, "transpose": null, "bytes": 536870912, "sha256": "805895e894603952a156605e5b1ffae0bd37f349daa089036a49b8a4a5ed90bd"}
+{"variant": "log", "field": "velocity_x", "var": "velocity_x", "step": null, "path": "512x512x512_log/velocity_x.f32", "dtype": "<f4", "shape": [512, 512, 512], "file_shape": [512, 512, 512], "component": null, "transpose": null, "bytes": 536870912, "sha256": "8796f3bbb05f4b203799f8daba6f5c05258efb769179dcc2b231d2f058fde86b"}
+{"variant": "log", "field": "velocity_y", "var": "velocity_y", "step": null, "path": "512x512x512_log/velocity_y.f32", "dtype": "<f4", "shape": [512, 512, 512], "file_shape": [512, 512, 512], "component": null, "transpose": null, "bytes": 536870912, "sha256": "1adf59dd2bf1b2a79b3ebbac99a547f448a423f4e30c170fb331adb948318eff"}
+{"variant": "log", "field": "velocity_z", "var": "velocity_z", "step": null, "path": "512x512x512_log/velocity_z.f32", "dtype": "<f4", "shape": [512, 512, 512], "file_shape": [512, 512, 512], "component": null, "transpose": null, "bytes": 536870912, "sha256": "619553bbe1222743c22cac4da57e64d79659cf3cd1c10a7137aadba9156158b9"}