rmt_install: Install external codes

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

Description

This function installs external codes that are used by [RMT3DMS].

Usage

rmt_install(code = "all", overwrite = NULL)

rmt_installed_codes()

Arguments

code	Character vector with the codes to install, or '"all"' (default).
overwrite	Logical. Overwrite when the code is already installed? If 'NULL' (default), the user is asked what to do in an interactive session. An error message is issued otherwise.

Details

## Supported software [MT3DMS v5.3](https://hydro.geo.ua.edu/) and [MT3D-USGS](https://www.usgs.gov/software/mt3d-usgs-groundwater-solute-transport-simulator-modflow). The zip files with windows binaries hosted at these website are downloaded and extracted in the installation directory. The main folder names are modified in order to have more consistency.

## Installation location The default installation location is 'file.path(system.file(package = "RMT3DMS"), "code")', but it can be altered by setting option 'RMT3DMS.path'.

[rmt_installed_codes()] shows which codes are installed in the default installation location as set by the 'RMT3DMS.path' option.

Value

[rmt_installed_codes()] returns an invisible character vector with installed code names.

Examples

## Not run: 
rmt_install() # Install all codes.
rmt_install("MT3D-USGS", overwrite = TRUE) # Install MT3D-USGS.
rmt_install("MT3DMS", overwrite = TRUE) # Install MT3DMS.

## End(Not run)

## Not run: 
rmt_installed_codes()

## End(Not run)

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