Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Marco De Lucia
RedModRphree
Commits
199bd108
Commit
199bd108
authored
Apr 12, 2021
by
Marco De Lucia
Browse files
README as orgmode instead of markdown
parent
2f2350b8
Changes
2
Show whitespace changes
Inline
Side-by-side
README.md
deleted
100644 → 0
View file @
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")
```
README.org
0 → 100644
View file @
199bd108
* 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
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment