updated README.md with dataset_card.yaml
Browse files
README.md
CHANGED
|
@@ -1,3 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
## Dataset Structure
|
| 2 |
|
| 3 |
When you run the code from [ines-lang/pde-solver](https://github.com/ines-lang/pde-solver), it automatically generates a directory structure based on the **selected PDE** and **initial condition (IC)**.
|
|
@@ -6,7 +17,7 @@ This folder structure matches the format in which this dataset is organized and
|
|
| 6 |
|
| 7 |
### Example structure for a 1D PDE dataset:
|
| 8 |
|
| 9 |
-
|
| 10 |
1D/
|
| 11 |
├── pde/
|
| 12 |
│ └── ic/
|
|
@@ -14,7 +25,7 @@ This folder structure matches the format in which this dataset is organized and
|
|
| 14 |
│ ├── metadata.json
|
| 15 |
│ └── plots/
|
| 16 |
│ └── seed_i.png # for 1D
|
| 17 |
-
|
| 18 |
|
| 19 |
### File descriptions:
|
| 20 |
- **`dataset.h5`**: Contains the full dataset with the generated PDE solution data.
|
|
@@ -26,5 +37,3 @@ This folder structure matches the format in which this dataset is organized and
|
|
| 26 |
You can extend this structure to other PDEs and dimensions (e.g., `2D/`, `3D/`) following the same hierarchy.
|
| 27 |
|
| 28 |
---
|
| 29 |
-
|
| 30 |
-
This dataset and associated code are released under the [MIT License](https://opensource.org/licenses/MIT).
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: mit
|
| 3 |
+
tags:
|
| 4 |
+
- pde
|
| 5 |
+
- physics
|
| 6 |
+
- numerical-simulation
|
| 7 |
+
pretty_name: PDE Collection
|
| 8 |
+
task_categories:
|
| 9 |
+
- structured-data-modeling
|
| 10 |
+
---
|
| 11 |
+
|
| 12 |
## Dataset Structure
|
| 13 |
|
| 14 |
When you run the code from [ines-lang/pde-solver](https://github.com/ines-lang/pde-solver), it automatically generates a directory structure based on the **selected PDE** and **initial condition (IC)**.
|
|
|
|
| 17 |
|
| 18 |
### Example structure for a 1D PDE dataset:
|
| 19 |
|
| 20 |
+
```
|
| 21 |
1D/
|
| 22 |
├── pde/
|
| 23 |
│ └── ic/
|
|
|
|
| 25 |
│ ├── metadata.json
|
| 26 |
│ └── plots/
|
| 27 |
│ └── seed_i.png # for 1D
|
| 28 |
+
```
|
| 29 |
|
| 30 |
### File descriptions:
|
| 31 |
- **`dataset.h5`**: Contains the full dataset with the generated PDE solution data.
|
|
|
|
| 37 |
You can extend this structure to other PDEs and dimensions (e.g., `2D/`, `3D/`) following the same hierarchy.
|
| 38 |
|
| 39 |
---
|
|
|
|
|
|