updated README with correct Data Structure
Browse files
README.md
CHANGED
|
@@ -9,31 +9,63 @@ task_categories:
|
|
| 9 |
- other
|
| 10 |
---
|
| 11 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 12 |
## Dataset Structure
|
| 13 |
|
| 14 |
-
When
|
|
|
|
|
|
|
| 15 |
|
| 16 |
-
|
|
|
|
|
|
|
|
|
|
| 17 |
|
| 18 |
-
### Example structure for a
|
| 19 |
|
| 20 |
-
|
| 21 |
-
1D/
|
| 22 |
-
|
| 23 |
-
│
|
| 24 |
-
│ ├──
|
| 25 |
-
│
|
| 26 |
-
│
|
| 27 |
-
|
| 28 |
-
|
| 29 |
|
| 30 |
### File descriptions:
|
| 31 |
-
- **`dataset.h5`**: Contains the full dataset with the generated PDE solution data.
|
| 32 |
-
- **`metadata.json`**: Describes the PDE type, initial conditions, and solver parameters.
|
| 33 |
-
- **`plots/`**: Contains sample visualizations for each generated seed.
|
| 34 |
|
| 35 |
-
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 36 |
|
| 37 |
-
|
|
|
|
| 38 |
|
| 39 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 9 |
- other
|
| 10 |
---
|
| 11 |
|
| 12 |
+
# PDE Collection
|
| 13 |
+
|
| 14 |
+
This dataset contains numerical solutions of canonical **Partial
|
| 15 |
+
Differential Equations (PDEs)** generated with the
|
| 16 |
+
[ines-lang/pde-solver](https://github.com/ines-lang/pde-solver).\
|
| 17 |
+
It provides standardized datasets for benchmarking PDE solvers, machine
|
| 18 |
+
learning surrogates, and physics-informed methods.
|
| 19 |
+
|
| 20 |
+
------------------------------------------------------------------------
|
| 21 |
+
|
| 22 |
## Dataset Structure
|
| 23 |
|
| 24 |
+
When running the solver locally, the directory structure is organized by
|
| 25 |
+
**dimension first** (e.g., `1D/`, `2D/`, `3D/`), then by PDE type and
|
| 26 |
+
initial condition (IC).
|
| 27 |
|
| 28 |
+
However, on Hugging Face the datasets follow a slightly different
|
| 29 |
+
organization: files are grouped by **PDE type first**, then by
|
| 30 |
+
dimension.\
|
| 31 |
+
This difference ensures consistency when browsing multiple PDE datasets.
|
| 32 |
|
| 33 |
+
### Example Hugging Face structure for a PDE dataset:
|
| 34 |
|
| 35 |
+
pde/
|
| 36 |
+
├── 1D/
|
| 37 |
+
│ └── ic/
|
| 38 |
+
│ ├── dataset.h5
|
| 39 |
+
│ ├── metadata.json
|
| 40 |
+
│ └── plots/
|
| 41 |
+
│ └── variable0.000_channel_0.png # Example visualization for 1D
|
| 42 |
+
├── 2D/
|
| 43 |
+
│ └── ...
|
| 44 |
|
| 45 |
### File descriptions:
|
|
|
|
|
|
|
|
|
|
| 46 |
|
| 47 |
+
- **`dataset.h5`**: HDF5 file with the PDE solution data
|
| 48 |
+
(multi-dimensional arrays over space and time).
|
| 49 |
+
- **`metadata.json`**: Describes PDE type, dimensionality, ICs, BCs,
|
| 50 |
+
solver method, and parameters.
|
| 51 |
+
- **`plots/`**: Folder with quick-look PNG visualizations of generated
|
| 52 |
+
seeds for inspection.
|
| 53 |
|
| 54 |
+
-----------------------------------------------------
|
| 55 |
+
## Applications
|
| 56 |
|
| 57 |
+
This dataset supports research and education in scientific computing and machine learning:
|
| 58 |
+
|
| 59 |
+
- **Benchmarking**: Standardized data for evaluating PDE solvers and surrogate models.
|
| 60 |
+
- **Machine Learning**: Training physics-informed and reduced-order models for dynamical systems.
|
| 61 |
+
- **Reproducibility**: Consistent metadata and structure enable reliable comparisons across studies.
|
| 62 |
+
- **Extensibility**: Easily adapted to new PDEs, parameter regimes, or boundary conditions.
|
| 63 |
+
|
| 64 |
+
By combining reproducible datasets with rich metadata, this resource bridges **numerical analysis and modern ML**, providing a foundation for standardized benchmarks in data-driven PDE modeling.
|
| 65 |
+
|
| 66 |
+
------------------------------------------------------------------------
|
| 67 |
+
|
| 68 |
+
## License
|
| 69 |
+
|
| 70 |
+
Released under the **MIT License** --- free to use, modify, and share
|
| 71 |
+
with attribution.
|