Update README.md

README.md

@@ -1,3 +1,70 @@
----
-license: mit
----
+---
+license: mit
+---
+# Rayleigh-Bénard convection (RBC)
+RBC2D data generated using [Dedalus](https://dedalus-project.readthedocs.io/en/latest/) solver and RBC3D data is generated using [pySDC](https://zenodo.org/records/15196003) solver.
+
+- dataset: `RBC2D_256x64_Ra1e7_dt1e-3_update.h5` 
+```
+ -- grid shape : (256, 64)
+ -- grid domain : [0.0, 4.0] x [0.0, 1.0]
+ -- nSimu : 10
+ -- dtData : 0.001
+ -- inSize : 1
+ -- outStep : 1
+ -- inStep : 500
+ -- nSamples (per simu) : 200
+ -- nSamples (total) : 2000
+ -- dtInput : 0.001
+ -- outType : update
+ -- outScaling : 1e+03
+ -- Rayleigh: 1e7
+ -- Prandtl : 1.0
+```
+
+- dataset: `RBC3D_64x64x32_Ra1e5_dt0_5_solution.h5`
+```
+ -- grid shape : (64, 64, 32)
+ -- grid domain : [0.0, 3.9] x [0.0,3.9] x [0.0, 1.0]
+ -- nSimu : 6
+ -- dtData : 0.5
+ -- inSize : 1
+ -- outStep : 1
+ -- inStep : 1
+ -- nSamples (total) : 2401
+ -- dtInput : 0.5
+ -- outType : solution
+ -- outScaling : 1
+ -- Rayleigh: 1e5
+ -- Prandtl : 0.7
+```
+
+# Particle-In-Cell (PIC)
+Data is generated using PIC methods using [https://github.com/srikrrish/PIC-Simulation](https://github.com/srikrrish/PIC-Simulation) code.
+
+- dataset: `PIC1D_electrostatic.h5`
+```
+-- nDim : 1
+ -- inputKeys : ['pos_weakLandau', 'pos_strongLandau', 'pos_tsi', 'pos_bti']
+ -- inputShape : [  2000      2 100000]
+ -- outputKeys : ['Eout_weakLandau', 'Eout_strongLandau', 'Eout_tsi', 'Eout_bti']
+ -- outputShape : [  2000      1 100000]
+ -- outputMean : -9.313583237968714e-11
+ -- outputStd : 0.26851966977119446
+ -- outType : solution
+ -- outScaling : 1
+ -- particles : 100000
+```
+- dataset: `PIC2D_electrostatic.h5`
+```
+ -- nDim : 2
+ -- inputKeys : ['pos_weakLandau', 'pos_strongLandau', 'pos_tsi', 'pos_bti']
+ -- inputShape : [  4200      3 100000]
+ -- outputKeys : ['Eout_weakLandau', 'Eout_strongLandau', 'Eout_tsi', 'Eout_bti']
+ -- outputShape : [  4200      2 100000]
+ -- outputMean : [-1.8569685e-13  6.0242131e-11]
+ -- outputStd : [0.06087422 0.2189879 ]
+ -- outType : solution
+ -- outScaling : 1
+ -- particles : 100000
+```