edited README.md

README.md

@@ -5,21 +5,55 @@ Simulating fluid flow around arbitrary shapes is key to solving various engineer
 We envision that FlowBench will enable evaluating the interplay between complex geometry, coupled flow phenomena, and data sufficiency on the performance of current, and future, neural PDE solvers. We enumerate several evaluation metrics to help rank order the performance of current (and future) neural PDE solvers. We benchmark the performance of three baseline methods: Fourier Neural Operators (FNO), Convolutional Neural Operators (CNO), and DeepONets. This dataset will be a valuable resource for evaluating neural PDE solvers that model complex fluid dynamics around 2D and 3D objects.
 
 
-**FlowBench dataset**
+**Dataset Information**
+*SciML* exposes data for four families of datasets:
+
+```
+FPO - Flow Past an Object
+Settings : Time dependent problem. We provide 242 snapshots per simulation.
+Geometries : harmonics, nurbs, skelneton
+Specification : Navier Stokes [2d, resolutions = 1024x256, 512x128]
+```
 ```
-FlowBench consists of over 10K samples of scientific models 
+LDC - Lid Driven Cavity
+Geometries : harmonics, nurbs, skelneton
+Specification : Navier Stokes [2d, resolutions = 512x512, 256x256, 128x128]
+```
+```
+LDC - Lid Driven Cavity
+Geometries : 
+Specification : Navier Stokes [3d, resolution = 128x128x128]
 ```
 
-**Dataset Information**
 ```
+LDC - Lid Driven Cavity
+Setting - Constant Reynolds Number
+Geometries : harmonics, nurbs, skelneton
+Specification : Navier Stokes + Heat Transfer [2d, resolutions = 512x512, 256x256, 128x128]
+```
+
+```
+LDC - Lid Driven Cavity
+Setting - Variable Reynolds Number
+Geometries : harmonics, nurbs, skelneton
+Specification : Navier Stokes + Heat Transfer [2d, resolutions = 512x512, 256x256, 128x128]
 ```
 
+For all families of datasets, except FPO, we directly provide the ```numpy``` input and output tensors ```X,Y``` that can be used by SciML researchers to train their SciML models. Tensor formulae for both ```X,Y``` have been described in appendix (section B.2) of our main paper.
+
+For FPO family of datasets, we adopt a slightly different approach. Because we are exposing the full 242 time steps of a simulation, it was more prudent to have the end users prepare their own input and output tensors depending on the time steps they choose. This allows the end users to control the size of the tensors going into their SciML models. Hence we recommend the following approach for accessing the data:
+
+1. Go to the one of the FPO simulation folders, e.g. ```FPO_NS_2D_512x128```
+2. Choose your geometry, e.g., harmonics
+3. You would notice several directories - these represent the various geometries of the type harmonics.
+4. Under each geometry, the user will find full simulations of three different flow conditions packaged as a *.npz file. Each of these files contains the full simulation across 242 time steps for each of the fields.
+
 **License**
 ```
 CC-BY-NC-4.0
 ```
 
-**Usage**
+**Downloading dataset from Huggingface**
 
 To run the example code, you need to install the following package:
 
@@ -109,74 +143,75 @@ main/
 ├── LDC_NSHT_2D_constant-Re/
 │   ├── 128x128/
 │   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── harmonics_lid_driven_cavity_Y.npz
 │   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── nurbs_lid_driven_cavity_Y.npz
 │   │   ├── skelneton_lid_driven_cavity_X.npz
-│   │   └── skelneton_lid_driven_cavity_X.npz
+│   │   └── skelneton_lid_driven_cavity_Y.npz
 │   ├── 256x256/
 │   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── harmonics_lid_driven_cavity_Y.npz
 │   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── nurbs_lid_driven_cavity_Y.npz
 │   │   ├── skelneton_lid_driven_cavity_X.npz
-│   │   └── skelneton_lid_driven_cavity_X.npz
+│   │   └── skelneton_lid_driven_cavity_Y.npz
 │   └── 512x512/
 │   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── harmonics_lid_driven_cavity_Y.npz
 │   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── nurbs_lid_driven_cavity_Y.npz
 │   │   ├── skelneton_lid_driven_cavity_X.npz
-│   │   └── skelneton_lid_driven_cavity_X.npz
+│   │   └── skelneton_lid_driven_cavity_Y.npz
 ├── LDC_NSHT_2D_variable-Re/
 │   ├── 128x128/
 │   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── harmonics_lid_driven_cavity_Y.npz
 │   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── nurbs_lid_driven_cavity_Y.npz
 │   │   ├── skelneton_lid_driven_cavity_X.npz
-│   │   └── skelneton_lid_driven_cavity_X.npz
+│   │   └── skelneton_lid_driven_cavity_Y.npz
 │   ├── 256x256/
 │   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── harmonics_lid_driven_cavity_Y.npz
 │   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── nurbs_lid_driven_cavity_Y.npz
 │   │   ├── skelneton_lid_driven_cavity_X.npz
-│   │   └── skelneton_lid_driven_cavity_X.npz
+│   │   └── skelneton_lid_driven_cavity_Y.npz
 │   └── 512x512/
 │   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── harmonics_lid_driven_cavity_Y.npz
 │   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── nurbs_lid_driven_cavity_Y.npz
 │   │   ├── skelneton_lid_driven_cavity_X.npz
-│   │   └── skelneton_lid_driven_cavity_X.npz
+│   │   └── skelneton_lid_driven_cavity_Y.npz
 ├── LDC_NS_2D/
 │   ├── 128x128/
 │   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── harmonics_lid_driven_cavity_Y.npz
 │   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── nurbs_lid_driven_cavity_Y.npz
 │   │   ├── skelneton_lid_driven_cavity_X.npz
-│   │   └── skelneton_lid_driven_cavity_X.npz
+│   │   └── skelneton_lid_driven_cavity_Y.npz
 │   ├── 256x256/
 │   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── harmonics_lid_driven_cavity_Y.npz
 │   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── nurbs_lid_driven_cavity_Y.npz
 │   │   ├── skelneton_lid_driven_cavity_X.npz
-│   │   └── skelneton_lid_driven_cavity_X.npz
+│   │   └── skelneton_lid_driven_cavity_Y.npz
 │   └── 512x512/
 │   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── harmonics_lid_driven_cavity_X.npz
-│   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── harmonics_lid_driven_cavity_Y.npz
 │   │   ├── nurbs_lid_driven_cavity_X.npz
+│   │   ├── nurbs_lid_driven_cavity_Y.npz
 │   │   ├── skelneton_lid_driven_cavity_X.npz
-│   │   └── skelneton_lid_driven_cavity_X.npz
+│   │   └── skelneton_lid_driven_cavity_Y.npz
 ├── LDC_NS_3D/
 │   ├── LDC_3D_X.npz
 │   ├── LDC_3D_Y.npz
 ├── README.md
 ├── .gitattributes
+├── croissant.json
 └── info.txt
 ```