From 503d6f4bce7a4a20f69bb6046596ed5bb350be33 Mon Sep 17 00:00:00 2001
From: Vitor Silva <v.silva@fz-juelich.de>
Date: Tue, 22 Aug 2023 14:14:04 +0200
Subject: [PATCH] Update README.md
---
README.md | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 0cd4790..d77b2a8 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>
--
GitLab