Skip to content

hydrosolutions/RSMinerveR

Repository files navigation

RSMinerveR

I/O for RS MINERVE in R (Package site)

RS MINERVE is a hydrological modelling software freely available from CREALP. RS MINERVE can be scripted from within R by calling the Visual Basics interface. This package provides functions to simplify R-RS MINERVE interaction.
The Visual Basics interface is documented in the Technical Manual of RS Minerve. The Technical Manual can be viewed under "Help" from within RS MINERVE or online under https://crealp.github.io/rsminerve-releases/.

Requirements

RS MINERVE runs on Windows OS only.

Installation of RS MINERVE

RS MINERVE is freely available from CREALP. The download site is in French but the software is available in English. On the CREALP site linked above, click on "Version actuelle" to download the latest version of RS MINERVE. Follow the installation guide. RSMinerveR is written for RS MINERVE 2.9.1.0.

Installation of R and R tools

RSMinerveR is written in R 4.1.0 in RStudio 1.4.1717 and tested under R 4.2.2. RTools40 needs to be downloaded and installed. The latest R and RTools can be downloaded for example from https://stat.ethz.ch/CRAN/. The RStudio community version can be downloaded for free from rstudio.com.

Installation of rClr

rClr is a package for low-level access from R to a Common Language Runtime (CLR). The supported CLR implementations are Microsoft '.NET' framework on Windows. Using rClr we can interact with the Visual Basics Interface implemented for RS MINERVE. For this package we use the rClr implementation from [Open-Systems-Pharmacology] (https://github.com/Open-Systems-Pharmacology/rClr/releases) (v0.9.1 for R version 3, v0.9.2 for R version 4). Download the latest release as zip to your working directory and install it with the following command.

install.packages("rClr_0.9.2.zip", repos = NULL, type = "source")

Examples

Existing examples in Visual Basics provided by CREALP are being translated to R and made available as vignettes for this package. Many thanks to CREALP for providing these examples.
To run the examples, download the vignette to your computer, adapt the file paths and run the code.

Troubleshooting

RS MINERVE is a mature software but problems may occur when it is run on different locales. The troubleshooting page hepls solve such problems.

Overview over currently implemented interfaces

The functions relate to reading and writing of RS MINERVE inputs and outputs. The function reference on the package site summarises the currently implemented functions.

Especially relevant for writing parameter files: Overview over implemented RSMinerveR objects

About

I/O for RSMinerve in R

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages