Add README.md

README.md

+adiosFoam data dumper
+=====================
+
+The _dump-data_ script extracts OpenFOAM data stored in an ADIOS2 file generated by adiosFOAM.
+
+
+Requirements
+------------
+
+data-dumper.py relies on standard Python imports and one extra plugin.
+The extra plugin is provided by ADIOS2 in the standard installation. 
+More information on the plugin:
+
+| Plugin | Reference |
+| ------ | ------ |
+| adios2 | [ADIOS2plugin] |
+
+Usage
+-----
+
+```bash
+python dump-data.py -c /directory/openfoamcase -t '0.1 0.5 0.9'
+```
+
+Features
+--------
+
+- Allow directory selection
+- Allow a list of time-steps to be selected (Python syntax)
+
+Limitations
+-----------
+
+In practical aspects, only scalar and volumetric fields are extracted. 
+since _adiosFOAM_ relies on OpenFOAM decomposed cases thus the same applies 
+for the script: data is generated in decomposed form.
+
+- The script is mainly limited by _adiosFoam_ limitations [adiosFoam].
+- Need a decomposed case mesh (processor# directories)
+
+## License
+
+
+
+
+
+   [openfoam]: <https://www.openfoam.com/>
+   [ADIOS2]: <https://develop.openfoam.com/Community/adiosfoam>
+   [ADIOS2paper]: <https://doi.org/10.1016/j.softx.2020.100561>
+   [ADIOS2plugin]: <https://adios2.readthedocs.io/en/latest/api_full/api_full.html#python-bindings>
+   [adiosFoam]: <http://daringfireball.net/projects/markdown/>