In rogiersbart/RMT3DMS: Pre- and post-processing of MT3DMS & MT3D-USGS files

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

The {RMT3DMS} R package
Pre- and post-processing of MT3DMS & MT3D-USGS files

The {RMT3DMS} R package provides a set of tools for solute transport modelling with MT3DMS & MT3D-USGS. It is closely related to the {RMODFLOW} package for groundwater flow modelling. The functionality is targeted at feature-parity with that of the ModelMuse GUI and friends, albeit restricted to the MODFLOW-2005 family of codes.

Install

You can install the latest version of {RMT3DMS} with any of the following:

renv::install("rogiersbart/RMT3DMS")
pak::pkg_install("rogiersbart/RMT3DMS")
remotes::install_github("rogiersbart/RMT3DMS")

If you don't have {renv}, {pak}, or {remotes} installed, try this instead:

install.packages("remotes")
remotes::install_github("rogiersbart/RMT3DMS")

Use

Similar to {RMODFLOW}, the {RMT3DMS} package provides a set of functions to work on a file-by-file basis, and another to work with complete models. If you have an existing MT3D model, a good place to start is trying to read it in completely with:

library(RMT3DMS)
my_model <- rmt_read("my-model.mt_nam")

And looking at the resulting object's structure:

str(my_model)

You can install the solute transport codes in the default location with:

rmt_install()

And check if this went fine:

rmt_installed_codes()

To run your model, try:

rmt_execute("my-model.mt_nam")

Note

A more extensive introduction to the package will be available soon.

rogiersbart/RMT3DMS documentation built on Oct. 16, 2021, 9:45 a.m.