Create README.md

README.md

@@ -0,0 +1,67 @@
+---
+license: cc-by-nc-4.0
+tags:
+- CFD
+- Multiphase
+- CompressibleFlow
+- SciML
+- Bubbles
+- Shock
+pretty_name: 2D Shock-Induced Air Bubble Collapse in Water
+size_categories:
+- 10K<n<100K
+---
+
+# 2D Shock-Induced Air Bubble Collapse in Water
+## Description
+
+The dataset captures the time-evolving behavior of 2D cylindrical air bubbles subjected to an external shock wave in water.
+The interaction with the shock wave results in a collapse of the air bubble. 
+Here we investigate a scenario with symmetric boundary conditions at the north and south walls.
+
+## About the data
+|Metadata|Description|
+|-----|------|
+|Solver|[ALPACA](https://www.sciencedirect.com/science/article/abs/pii/S0010465521003581)|
+|PDE|2D compressible Euler equations|
+|Dimension|2D|
+|Number of Trajectories|300|
+|Number of Timesteps|101|
+|Simulation End Time|15 \\( \mu s \\)|
+|Save Interval|0.15 \\( \mu s \\)|
+|Fields|density_mixed, density_water, density_air, pressure, velocityX, velocityY, volume_fraction_water|
+|Simulation Resolution|2048x1024|
+|Dataset Resolution|512x512 & 256x256 <br/> Clipped and Downsampled|
+|Grid Type|Cartesian Uniform Grid|
+|Initial Condition|The bubbles are in equilibrium with the surrounding pre shock environment.|
+|Boundary Conditions| North: Symmetry <br/> South: Symmetry <br/> East: Open <br/> West: Open|
+|Train-Test-Split|0.8 - 0.2|
+|Conditioning Parameters| Shock Mach Number [1.3 - 2.1] <br/> Bubble Count [1 - 5] <br/> Bubble Radius [2mm - 3.5mm] <br/> Bubble Center Position [Random in Domain]
+
+Further metadata information can be found in the corresponding `metadata.json` file.
+
+## Key Challenges for Surrogate Modelling
+- Acurate interface capturing
+- Peak pressure in the domain
+- Understanding wave dynamics
+
+## How to Download the Dataset
+
+Download the whole dataset:
+```
+hf download FluidVerse/2D_SABW_SSOO --repo-type dataset
+```
+
+Download only part of the dataset with resolution 256x256:
+```
+from huggingface_hub import snapshot_download
+
+snapshot_download(
+    repo_id="FluidVerse/2D_SABW_SSOO",
+    repo_type="dataset",
+    allow_patterns="multi_bubble/256x256/*",
+    local_dir="."
+)
+```
+
+