diff --git a/README.md b/README.md index 0cd4790c51711b931a4ed03a7121881c3cb3c8f6..d77b2a86648a7a7443d2c05abc022c24e90068bd 100644 --- a/README.md +++ b/README.md @@ -15,18 +15,11 @@ More information on the plugin: | ------ | ------ | | 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) +- Allows directory selection +- Allows a list of time-steps to be selected (Python syntax) Limitations ----------- @@ -38,6 +31,13 @@ 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) +Usage +----- + +```bash +python dump-data.py -c /directory/openfoamcase -t '0.1 0.5 0.9' +``` + ## License @@ -45,7 +45,7 @@ for the script: data is generated in decomposed form. [openfoam]: <https://www.openfoam.com/> - [ADIOS2]: <https://develop.openfoam.com/Community/adiosfoam> + [ADIOS2]: <https://adios2.readthedocs.io/en/latest/index.html> [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/> + [adiosFoam]: <https://develop.openfoam.com/Community/adiosfoam>