README.md

In eWaterCycle/bmi-r: basic model interface

Contains abstract super class which implements the basic model interface (bmi) in R.

See https://github.com/eWaterCycle/grpc4bmi for the Python server/client implementation.

Install

From R

devtools::install_github("eWaterCycle/bmi-r")

For Python runner

pip install grpc4bmi[R]

Serve the model using grpc4bmi

First the model should be wrapped in a basic model interface be subclassing the AbstractBmi class. Then the server can be started with:

run-bmi-server --lang R --path <path to r script with bmi class> --name <bmi class name>

Docker container

So for example for WALRUS model, see its Dockerfile.

The config file for the bmi initialize function should be put in current working directory and the initialize function should be called with /data/<config filename.

Release

Generate man pages

Rscript -e "devtools::document(roclets=c('rd', 'collate', 'namespace'))"

Local build & install

Rscript -e 'devtools::document()'
R CMD INSTALL .

eWaterCycle/bmi-r documentation built on May 26, 2019, 2:35 a.m.