Commit 199bd108 authored by Marco De Lucia's avatar Marco De Lucia
Browse files

README as orgmode instead of markdown

parent 2f2350b8
# RedModRphree #
This package serves as test bed for the developments about surrogate
models and reactive transport in the framework of the RedMod project.
### Installation ###
In R, the quickest way is to install the package `devtools` and
install RedModRphree directly from this repository:
```
library(devtools)
install_gitlab("delucia/RedModRphree", host="https://git.gfz-potsdam.de")
```
To install in a specific directory (which R must know about, e.g.,
specifying the variable R_LIBS_USER in the file `$HOME/.Renviron`:
```shell
R_LIBS_USER="~/MyRPackageDir"
```
then:
```
devtools::install_gitlab("delucia/RedModRphree", host="https://git.gfz-potsdam.de", lib="~/MyRPackageDir")
```
This should (hopefully) take care of all dependencies.
### Usage ###
In your R session, just type:
```
library(RedModRphree) ## loads package and dependencies
```
There are a bunch of demo scripts and datasets provided by the package:
```
demo(package="RedModRphree") ## displays a list of available demo scripts
## CAUTION: these take 1-2 minutes each
## some (hopefully platform-independent) parallelization is activated by default
demo("demo-equilibrium",package="RedModRphree")
demo("demo-kinetics",package="RedModRphree")
## CAUTION: these take 2-3 minutes each!
demo("demo-eq-surr-RF",package="RedModRphree")
demo("demo-kin-surr",package="RedModRphree")
## Instructions to obtain the code to the gmd2020-445 paper submitted to Geoscientific Model Development
demo("demo-gmd2020-445",package="RedModRphree")
```
* RedModRphree
This package serves as test bed for the developments about surrogate
models and reactive transport in the framework of the RedMod project.
*** Installation
In R, the quickest way is to install the package =devtools= and install
RedModRphree directly from this repository:
#+begin_example
library(devtools)
install_gitlab("delucia/RedModRphree", host="https://git.gfz-potsdam.de")
#+end_example
To install in a specific directory (which R must know about, e.g.,
specifying the variable R_LIBS_USER in the file =$HOME/.Renviron=:
#+begin_src shell
R_LIBS_USER="~/MyRPackageDir"
#+end_src
then:
#+begin_example
devtools::install_gitlab("delucia/RedModRphree", host="https://git.gfz-potsdam.de", lib="~/MyRPackageDir")
#+end_example
This should (hopefully) take care of all dependencies.
*** Usage
:PROPERTIES:
:CUSTOM_ID: usage
:END:
In your R session, just type:
#+begin_example
library(RedModRphree) ## loads package and dependencies
#+end_example
There are a bunch of demo scripts and datasets provided by the package:
#+begin_example
demo(package="RedModRphree") ## displays a list of available demo scripts
## CAUTION: these take 1-2 minutes each
## some platform-independent parallelization is activated by default
demo("demo-equilibrium",package="RedModRphree")
demo("demo-kinetics",package="RedModRphree")
## CAUTION: these take 2-3 minutes each!
demo("demo-eq-surr-RF",package="RedModRphree")
demo("demo-kin-surr",package="RedModRphree")
## Instructions to obtain the code to the gmd2020-445 paper submitted to Geoscientific Model Development
demo("demo-gmd2020-445",package="RedModRphree")
#+end_example
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment