diff --git a/README.md b/README.md index d66af6324..774fd3f31 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ **Po**tsdamer **R**eactive **T**ransport @@ -7,7 +7,12 @@ # Forked Project -PORT is a fork of [POET](https://doi.org/10.5281/zenodo.4757913) integrating a standalone component for transport computations and leveraging PHREEQC_RM as geochemical solver. The following README is also applicable for this project. +*PORT* is a fork of [POET](https://doi.org/10.5281/zenodo.4757913) +integrating a standalone component for transport computations and +leveraging PHREEQC_RM as geochemical solver. The following README is +also applicable for this project. + +![PORT's Coupling Scheme](./docs/20221216_Scheme_PORT_en.svg) # POET @@ -31,9 +36,11 @@ To compile POET you need several software to be installed: - R language and environment - CMake 3.9+ -If you want to build documentation during compilation, `doxygen`and `graphviz` must be provided too. +If you want to build documentation during compilation, `doxygen`and +`graphviz` must be provided too. -The following R libraries must then be installed, which will get the needed dependencies automatically: +The following R libraries must then be installed, which will get the +needed dependencies automatically: - [devtools](https://www.r-project.org/nosvn/pandoc/devtools.html) - [Rcpp](https://cran.r-project.org/web/packages/Rcpp/index.html) @@ -43,17 +50,21 @@ The following R libraries must then be installed, which will get the needed depe ### Compiling source code -The generation of makefiles is done with CMake. If you obtained POET from git, you should be able to generate Makefiles by running +The generation of makefiles is done with CMake. If you obtained POET +from git, you should be able to generate Makefiles by running ```sh mkdir build && cd build cmake .. ``` -This will create the directory `build` and processes the CMake files and generate Makefiles from it. You're now able to run `make` to start build -process. +This will create the directory `build` and processes the CMake files +and generate Makefiles from it. You're now able to run `make` to start +build process. -If POET was obtained from the official SVN repository or the redmine at the branch or tag to be used have to be set via +If POET was obtained from the official SVN repository or the redmine +at the branch or tag +to be used have to be set via ```sh mkdir build && cd build @@ -64,20 +75,26 @@ where currently available branches/tags are: - dev -If everything went well you'll find the executable at `build/src/poet`, but it is recommended to install the POET project structure to a desired `CMAKE_INSTALL_PREFIX` with `make install`. +If everything went well you'll find the executable at +`build/src/poet`, but it is recommended to install the POET project +structure to a desired `CMAKE_INSTALL_PREFIX` with `make install`. -During the generation of Makefiles, various options can be specified via `cmake -D