Update README.md

README.md

@@ -1,31 +1,52 @@
 ---
 license: cc-by-4.0
 ---
+# BubbleML 2.0:
+
+**BubbleML_2** is a high-fidelity dataset of boiling simulations in 2D for three fluids (FC-72, Liquid N2 and R515B). It provides paired time-series fields stored in HDF5 (.hdf5) files together with metadata (.json) and explicit train/test splits.
+
 ---
-dataset_info:
-  config_name: single-bubble
-  features:
-  - name: input
-    sequence:
-      sequence:
-        sequence:
-          sequence: float32
-  - name: output
-    sequence:
-      sequence:
-        sequence:
-          sequence: float32
-  - name: fluid_params
-    sequence: float32
-  - name: filename
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 142299153
-    num_examples: 16
-  - name: test
-    num_bytes: 53362183
-    num_examples: 6
-  download_size: 0
-  dataset_size: 195661336
----
+
+## 🚀 Quickstart
+
+The current available dataset subsets are-
+```
+"single-bubble", "pb-saturated", "pb-subcooled", "fb-velscale", "fb-chf"
+```
+They are chosen for each individual forecasting task in our paper, viz. Single Bubble, Saturated Pool Boiling, Subcooled Pool Boiling, Flow Boiling- Varying Inlet Velocity and
+Flow Boiling- Varying Heat Flux.
+```python
+from datasets import load_dataset
+
+# Load the TRAIN split
+ds_train = load_dataset(
+    "hpcforge/BubbleML_2",
+    name="single-bubble",
+    split="train",
+    streaming=True,            # to save disk space
+    trust_remote_code=True,    # required to run the custom dataset script
+)
+
+# Load the TEST split
+ds_test = load_dataset(
+    "hpcforge/BubbleML_2",
+    name="single-bubble",
+    split="test",
+    streaming=True,
+    trust_remote_code=True,
+)
+```
+Each example in ds_train / ds_test has the following fields:
+  * input
+    NumPy array of shape (time_window=5, fields=4, HEIGHT, WIDTH)
+  * output
+    NumPy array of shape (time_window=5, fields=4, HEIGHT, WIDTH)
+  * fluid_params
+    List of 9 floats representing: Inverse Reynolds Number, Non-dimensionalized Specific Heat, Non-dimensionalized Viscosity, Non-dimensionalized Density, 
+    Non-dimensionalized Thermal Conductivity, Stefan Number, Prandtl Number, Nucleation wait time and the Heater temperature.
+    ```
+    [inv_reynolds, cpgas, mugas, rhogas, thcogas, stefan, prandtl, heater.nucWaitTime, heater.wallTemp]
+    ```
+  * filename
+    HDF5 filename (e.g. Twall_90.hdf5)
+