isuarez commited on
Commit
0b02d07
·
1 Parent(s): 294f7af

updated README.md

Browse files
Files changed (1) hide show
  1. README.md +28 -1
README.md CHANGED
@@ -1,3 +1,30 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
- license: mit
 
 
3
  ---
 
 
 
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)**.
4
+
5
+ This folder structure matches the format in which this dataset is organized and shared here.
6
+
7
+ ### Example structure for a 1D PDE dataset:
8
+
9
+
10
+ 1D/
11
+ ├── pde/
12
+ │ └── ic/
13
+ │ ├── dataset.h5
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.
21
+ - **`metadata.json`**: Describes the PDE type, initial conditions, and solver parameters.
22
+ - **`plots/`**: Contains sample visualizations for each generated seed.
23
+
24
  ---
25
+
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).