max/poet
1
0
Fork 0
mirror of https://git.gfz-potsdam.de/naaice/poet.git synced 2025-12-16 12:54:50 +01:00
Code Issues Packages Projects Releases Wiki Activity

fixed typo

Browse Source
This commit is contained in:
Max Lübke 2021-02-09 20:03:50 +01:00
commit da71e2ec1e
No known key found for this signature in database
GPG Key ID: D3201E51647D1199
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -102,6 +102,11 @@ according to the binary.
## Running ## Running
Before POET is ready to run, a working directory must be created. In this
directory you should find the executable file, the R scripts
`<POET_ROOT>/R_lib/kin_r_library.R` and `<POET_ROOT>/R_lib/parallel_r_library.R`
and the simulation description e.g. `<POET_ROOT>/data/chem_problems/SimDol2D.R`.
Run POET by `mpirun ./poet <OPTIONS> <SIMFILE> <OUTPUT_DIRECTORY>` where: Run POET by `mpirun ./poet <OPTIONS> <SIMFILE> <OUTPUT_DIRECTORY>` where:
- **OPTIONS** - runtime parameters (explained below) - **OPTIONS** - runtime parameters (explained below)
@ -151,6 +156,7 @@ with 4 processes `cd` into your previously installed POET-dir
mpirun -n 4 ./poet ../data/SimDol2D.R output mpirun -n 4 ./poet ../data/SimDol2D.R output
``` ```
After a finished simulation all data generated by POET will be found in the After a finished simulation all data generated by POET will be found in the
directory `output`. directory `output`.
@ -166,15 +172,21 @@ mpirun -n 4 ./poet -dht SimDol2D.R output
- **SimDol2D.R** - simple chemistry (Calcite/Dolomite) on a 50x50 2D grid, 20 - **SimDol2D.R** - simple chemistry (Calcite/Dolomite) on a 50x50 2D grid, 20
time steps 2) time steps 2)
- ~~**SimDolKtz.R** - simple chemistry (Calcite/Dolomite) on Ketzin grid (~650k - ~~ **SimDolKtz.R** - simple chemistry (Calcite/Dolomite) on Ketzin grid (~650k
elements), 20 time steps The flow snapshots are **NOT INCLUDED** in project elements), 20 time steps The flow snapshots are **NOT INCLUDED** in project
directory but must be provided separately.~~ At this moment **SimDolKtz.R** is directory but must be provided separately.~~ At this moment **SimDolKtz.R** is
not supported. not supported.
## About the usage of MPI_Wtime() ## About the usage of MPI_Wtime()
Implemented time measurement functions use `MPI_Wtime()`. Some important Implemented time measurement functions uses `MPI_Wtime()`. Some important
informations from the OpenMPI Man Page: informations from the OpenMPI Man Page:
For example, on platforms that support it, the clock_gettime() function will be For example, on platforms that support it, the clock_gettime() function will be
used to obtain a monotonic clock value with whatever precision is supported on used to obtain a monotonic clock value with whatever precision is supported on
that platform (e.g., nanoseconds). that platform (e.g., nanoseconds).
## External Libraries
We use external libraries:
- **argh** - https://github.com/adishavit/argh (BSD license)