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

update README.md

Browse Source
This commit is contained in:
Max Lübke 2021-02-17 19:57:08 +01:00
parent f7d94218c6
commit a5f95c328d
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -25,6 +25,9 @@ To compile POET you need several software to be installed:
- R language and environment - R language and environment
- CMake 3.9+ - CMake 3.9+
If documantiation should be build during compilation `doxygen`and `graphviz`
must be provided too.
The following R libraries must then be installed: The following R libraries must then be installed:
- [devtools](https://www.r-project.org/nosvn/pandoc/devtools.html) - [devtools](https://www.r-project.org/nosvn/pandoc/devtools.html)
@ -51,6 +54,8 @@ During the generation of Makefiles, various options can be specified via `cmake
- **DHT_Debug**=*boolean* - toggles the output of detailed statistics about DHT - **DHT_Debug**=*boolean* - toggles the output of detailed statistics about DHT
usage (`cmake -D DHT_Debug=ON`). Defaults to *OFF*. usage (`cmake -D DHT_Debug=ON`). Defaults to *OFF*.
- **BUIL_DOC**=*boolean* - toggles the generation of documantiation during
compilation process. Defaults to *ON*.
### Example: Build from scratch ### Example: Build from scratch
@ -81,7 +86,7 @@ This will install a POET project structure into `/home/<user>/poet` which is
called hereinafter `<POET_INSTALL_DIR>`. With this version of POET I would not called hereinafter `<POET_INSTALL_DIR>`. With this version of POET I would not
recommend to install to hierarchies like `/usr/local/` etc. recommend to install to hierarchies like `/usr/local/` etc.
The correspondending directory tree would be look like this: The correspondending directory tree would look like this:
``` sh ``` sh
. .
@ -90,6 +95,10 @@ The correspondending directory tree would be look like this:
│ └── poet │ └── poet
├── data/ ├── data/
│ └── SimDol2D.R │ └── SimDol2D.R
├── docs/
│ └── html/
│ ├── index.html
│ └── ...
└── R_lib/ └── R_lib/
├── kin_r_library.R ├── kin_r_library.R
└── parallel_r_library.R └── parallel_r_library.R
@ -100,6 +109,9 @@ absolute paths inside `poet.cpp`. So, if you consider to move `bin/poet` either
change paths of the R source files and recompile POET or also move `R_lib/*` change paths of the R source files and recompile POET or also move `R_lib/*`
according to the binary. according to the binary.
To display the generetated html documentation just open `docs/html/index.html`
with the browser of your choice.
## Running ## Running
Before POET is ready to run, a working directory must be created. In this Before POET is ready to run, a working directory must be created. In this
@ -184,9 +196,3 @@ 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)