Datasets:

ArXiv:
License:
nashton commited on
Commit
553490f
·
verified ·
1 Parent(s): 1c266d3

Document native-point surface quadrature sidecars

Browse files

Adds the file contract, area-weighted metric example, selective download command, and release note for all 1,800 dual-area sidecars.

Files changed (1) hide show
  1. README.md +53 -2
README.md CHANGED
@@ -35,6 +35,7 @@ In order to cite the use of this dataset, please cite the corresponding preprint
35
  Each folder (e.g., `geo_LHCi_AoA_j` where `i` is the geometry ID from 001 to 180 and `j` is the angle of attack) corresponds to a different geometry and angle of attack. Inside each run folder, you will find:
36
 
37
  * `boundary_geo_LHCi_AoA_j.vtu.tgz`: Time-averaged flow quantities on the surface boundary (approx. 13 GB compressed, 21 GB unzipped).
 
38
  * `volume_geo_LHCi_AoA_j.vtu.tgz`: Time-averaged flow quantities within the domain volume (approx. 23 GB compressed, 86 GB unzipped).
39
  * `geo_LHCi_AoA_j.stl`: Surface mesh (tris) of the geometry (approx. 197 MB).
40
  * `geo_LHCi_AoA_j.stp`: Surface geometry definition (approx. 48 MB).
@@ -50,6 +51,7 @@ In addition to the files per run folder, there are also general summary files in
50
  * `geo_values_all.csv`: Reference geometry values used to define the geometry via the DoE method for all runs.
51
  * `force_mom_all.csv`: Time-averaged drag, lift, moment, and pressure/viscous coefficients for all runs.
52
  * [`splits/`](splits/): Deterministic train/validation/test split manifest, documentation, and generation code.
 
53
 
54
  ## Recommended Dataset Splits
55
 
@@ -64,9 +66,41 @@ For reproducible machine-learning evaluation, HiLiftAeroML provides 14 determini
64
 
65
  The levels within each data-efficiency ladder are nested and share the same validation and test sets, enabling direct comparisons across training-set sizes. Use validation data for model selection and reserve test data for final evaluation. See [`splits/README.md`](splits/README.md) for the complete definitions, counts, and selection guidance, or [`splits/generate_splits.py`](splits/generate_splits.py) for the generation and validation logic.
66
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
67
  ## How to Download
68
 
69
- HiLiftAeroML is publicly available on Hugging Face. There is no Hugging Face access charge, but the dataset is very large: the full repository is about 65.9 TB as stored on Hugging Face and substantially larger after extracting the `.tgz` archives. Please make sure you have sufficient storage and bandwidth before downloading large subsets.
70
 
71
  We recommend using the Hugging Face CLI rather than `git clone` for selective downloads, resumable local downloads, dry-run previews, and Xet-backed large-file support.
72
 
@@ -122,7 +156,22 @@ hf download nvidia/HiLiftAeroML \
122
 
123
  Remove `--dry-run` to download those files.
124
 
125
- ### Example 3: Download Specific Runs with a Bash Script
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
126
 
127
  This script loops over geometry IDs 1-180 and AoA values 4-22 in steps of 2. By default it runs in preview mode. Set `DRY_RUN=0` to download the files.
128
 
@@ -185,6 +234,8 @@ This dataset is provided under the permissive open-source **CC-BY-4.0** license.
185
 
186
  ## Version History
187
 
 
 
188
  * 06/07/2026 - updated the splits to include a couple of extra ones (geometry_medium, scarce, super_scare and medium)
189
 
190
  * 26/05/2026 - IDs 0-43 for angles 16-22 had incomplete force_mom (didn't have std dev etc). Corrected. Please download forces again if you took files before this date
 
35
  Each folder (e.g., `geo_LHCi_AoA_j` where `i` is the geometry ID from 001 to 180 and `j` is the angle of attack) corresponds to a different geometry and angle of attack. Inside each run folder, you will find:
36
 
37
  * `boundary_geo_LHCi_AoA_j.vtu.tgz`: Time-averaged flow quantities on the surface boundary (approx. 13 GB compressed, 21 GB unzipped).
38
+ * `boundary_dual_area_geo_LHCi_AoA_j.npy`: Native-point surface quadrature weights for the corresponding boundary VTU (little-endian float32, one value per VTU point, in exact VTU point order, with units of `in^2`).
39
  * `volume_geo_LHCi_AoA_j.vtu.tgz`: Time-averaged flow quantities within the domain volume (approx. 23 GB compressed, 86 GB unzipped).
40
  * `geo_LHCi_AoA_j.stl`: Surface mesh (tris) of the geometry (approx. 197 MB).
41
  * `geo_LHCi_AoA_j.stp`: Surface geometry definition (approx. 48 MB).
 
51
  * `geo_values_all.csv`: Reference geometry values used to define the geometry via the DoE method for all runs.
52
  * `force_mom_all.csv`: Time-averaged drag, lift, moment, and pressure/viscous coefficients for all runs.
53
  * [`splits/`](splits/): Deterministic train/validation/test split manifest, documentation, and generation code.
54
+ * [`surface_dual_areas/`](surface_dual_areas/): Definition, generator, complete 1,800-case manifest, per-case topology/provenance records, validation summaries, and SHA-256 hashes for the native-point surface quadrature sidecars.
55
 
56
  ## Recommended Dataset Splits
57
 
 
66
 
67
  The levels within each data-efficiency ladder are nested and share the same validation and test sets, enabling direct comparisons across training-set sizes. Use validation data for model selection and reserve test data for final evaluation. See [`splits/README.md`](splits/README.md) for the complete definitions, counts, and selection guidance, or [`splits/generate_splits.py`](splits/generate_splits.py) for the generation and validation logic.
68
 
69
+ ## Area-Weighted Evaluation on the Native Surface
70
+
71
+ Every raw boundary VTU now has a matching `boundary_dual_area_<case>.npy` sidecar. If a native surface polygon is fan-triangulated, each triangle contributes one third of its area to each incident vertex. The resulting mass-lumped dual areas sum to the fan-triangulated surface area and allow point-data predictions to be scored by physical surface measure rather than by the nonuniform density of mesh points.
72
+
73
+ The sidecar applies **only** to the corresponding raw `boundary_<case>.vtu`: its length equals `mesh.n_points`, and entry `i` weights point-data entry `i`. Do not use it after reordering, resampling, converting to STL, or processing the mesh into another representation. Accumulate statistics in float64 even though the stored weights are float32. For a scalar or vector field, an area-weighted relative L2 error can be computed as follows:
74
+
75
+ ```python
76
+ import numpy as np
77
+ import pyvista as pv
78
+
79
+ case = "geo_LHC001_AoA_4"
80
+ mesh = pv.read(f"{case}/boundary_{case}.vtu")
81
+ w = np.load(
82
+ f"{case}/boundary_dual_area_{case}.npy", mmap_mode="r"
83
+ )
84
+ assert w.dtype == np.dtype("<f4") and w.shape == (mesh.n_points,)
85
+
86
+ # pred and reference have shape (mesh.n_points,) for a scalar field or
87
+ # (mesh.n_points, n_components) for a vector field.
88
+ err2 = np.square(pred.astype(np.float64) - reference.astype(np.float64))
89
+ ref2 = np.square(reference.astype(np.float64))
90
+ if err2.ndim == 2:
91
+ err2 = err2.sum(axis=1)
92
+ ref2 = ref2.sum(axis=1)
93
+
94
+ numerator = np.sum(w * err2, dtype=np.float64)
95
+ denominator = np.sum(w * ref2, dtype=np.float64)
96
+ relative_l2 = np.sqrt(numerator / denominator)
97
+ ```
98
+
99
+ The weights are in square inches because the native coordinates are in inches. A constant unit conversion cancels from normalized metrics such as relative L2 and weighted means. See [`surface_dual_areas/README.md`](surface_dual_areas/README.md) and [`surface_dual_areas/manifest.json`](surface_dual_areas/manifest.json) for the exact algorithm and validation contract.
100
+
101
  ## How to Download
102
 
103
+ HiLiftAeroML is publicly available on Hugging Face. There is no Hugging Face access charge, but the dataset is very large: the full repository is about 66.9 TB as stored on Hugging Face and substantially larger after extracting the `.tgz` archives. Please make sure you have sufficient storage and bandwidth before downloading large subsets.
104
 
105
  We recommend using the Hugging Face CLI rather than `git clone` for selective downloads, resumable local downloads, dry-run previews, and Xet-backed large-file support.
106
 
 
156
 
157
  Remove `--dry-run` to download those files.
158
 
159
+ ### Example 3: Download Only the Surface Quadrature Sidecars
160
+
161
+ The following command downloads the 1,800 native-point NPY files and their algorithm, provenance, and validation metadata without downloading the CFD archives. The sidecars occupy about 1.02 TB (946.7 GiB) in total, so preview the selection first.
162
+
163
+ ```bash
164
+ hf download nvidia/HiLiftAeroML \
165
+ --repo-type dataset \
166
+ --local-dir ./hiliftaeroml_data \
167
+ --include "geo_LHC*_AoA_*/boundary_dual_area_*.npy" \
168
+ --include "surface_dual_areas/**" \
169
+ --dry-run
170
+ ```
171
+
172
+ Remove `--dry-run` to download those files.
173
+
174
+ ### Example 4: Download Specific Runs with a Bash Script
175
 
176
  This script loops over geometry IDs 1-180 and AoA values 4-22 in steps of 2. By default it runs in preview mode. Set `DRY_RUN=0` to download the files.
177
 
 
234
 
235
  ## Version History
236
 
237
+ * 07/08/2026 - added native-boundary-point dual-area NPY sidecars for all 1,800 cases, together with a complete manifest, hashes, validation records, and generation code for reproducible area-weighted surface evaluation
238
+
239
  * 06/07/2026 - updated the splits to include a couple of extra ones (geometry_medium, scarce, super_scare and medium)
240
 
241
  * 26/05/2026 - IDs 0-43 for angles 16-22 had incomplete force_mom (didn't have std dev etc). Corrected. Please download forces again if you took files before this date