Update Dataset Card for NavierStokes-2D dataset

#1
by nodemon - opened
Files changed (1) hide show
  1. README.md +82 -0
README.md CHANGED
@@ -1,3 +1,85 @@
1
  ---
2
  license: mit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: mit
3
+ task_categories:
4
+ - time-series-forecasting
5
+ - image-to-image
6
+ language:
7
+ - en
8
+ tags:
9
+ - pde
10
+ - navier-stokes
11
+ - fluid-dynamics
12
+ - turbulence
13
+ - neural-operator
14
+ - fno
15
+ - cfd
16
+ - surrogate-modeling
17
+ - scientific-ml
18
+ - huggingscience
19
+ - science
20
+ pretty_name: PDE Arena — Navier–Stokes 2D
21
  ---
22
+
23
+ # Dataset Card for pdearena/NavierStokes-2D
24
+
25
+ 2D Navier–Stokes simulation data for scientific ML (operator learning, surrogates, forecasting). Files are HDF5. License: MIT.
26
+
27
+ ## Dataset Details
28
+
29
+ - **Provided by:** PDE Arena org on Hugging Face (see also Maxwell-3D, ShallowWater-2D).
30
+ - **License:** MIT (per repo).
31
+ - **Format:** `.h5` files (HDF5) containing simulation tensors.
32
+ - **Typical use:** Train/evaluate neural operators (FNO/UNO/DeepONet), PINNs baselines, and CFD surrogates.
33
+
34
+ ## Dataset Structure
35
+
36
+ - **Splits:** `train`, `validation`, `test`.
37
+ - **Common arrays (by file):** velocity components, pressure (naming may vary).
38
+ - **Shape note:** Many PDE datasets follow `[t, x, y, channels]` or `[channels, t, x, y]`. Inspect keys to confirm.
39
+
40
+ ## How to Load
41
+
42
+ ```python
43
+ # 1) Simple: download a file and inspect keys
44
+ import h5py, numpy as np, requests, io
45
+
46
+ url = "https://huggingface.co/datasets/pdearena/NavierStokes-2D/resolve/main/NavierStokes2D_test_509778_0.50000.h5"
47
+ f = h5py.File(io.BytesIO(requests.get(url).content), "r")
48
+ print(list(f.keys())) # e.g., ['u', 'v', 'p'] or similar
49
+ u = np.array(f["u"]) # (T, H, W)
50
+ ```
51
+ ```python
52
+ # 2) Convert to PyTorch tensors (example)
53
+ import torch
54
+ U = torch.from_numpy(u).float() # (T, H, W)
55
+ # if channels present: (T, H, W, C) -> (T, C, H, W)
56
+
57
+ ```
58
+
59
+ ## Uses
60
+
61
+ ### Direct Use
62
+ - **Neural operators / surrogates:** learn mappings between initial/boundary conditions and flow fields.
63
+ - **Forecasting:** autoregressive prediction of future velocity/pressure frames.
64
+ - **Downstream eval:** error metrics in pixel/physical/Fourier space (e.g., **RMSE**, **nRMSE**, **fRMSE**).
65
+
66
+ ### Out-of-Scope
67
+ - **Clinical or safety-critical decisions.**
68
+ - **Treating as a labeled vision benchmark** (no class labels).
69
+
70
+ ## References
71
+ - **PDE Arena (org page):** dataset family (Navier–Stokes 2D/conditioned, ShallowWater-2D, Maxwell-3D): https://huggingface.co/datasets/pdearena
72
+ - **Hugging Face:** general datasets hub: https://huggingface.co/datasets
73
+ - **PDEBench (related benchmark & metrics):** Burgers, Darcy, Navier–Stokes, Shallow Water, etc.: https://darus.uni-stuttgart.de/
74
+ - **Neural operators (FNO paper):** https://arxiv.org/abs/2010.08895
75
+
76
+ ## Citation
77
+ ```bibtex
78
+ @misc{pdearena_navierstokes2d,
79
+ title = {PDE Arena — Navier–Stokes 2D},
80
+ author = {PDE Arena},
81
+ howpublished = {\url{https://huggingface.co/datasets/pdearena/NavierStokes-2D}},
82
+ year = {2023}
83
+ }
84
+ ```
85
+