index.md

Appveyor build status Build Status codecov lifecycle Dependencies CRAN_Status_Badge Research software impact DOI

An R package for calculating groundwater mounding beneath an infiltration basin based on the Hantush equation, 1967.

Installation

For details on how to install KWB-R packages checkout our installation tutorial.

### Optionally: specify GitHub Personal Access Token (GITHUB_PAT)
### See here why this might be important for you:
### https://kwb-r.github.io/kwb.pkgbuild/articles/install.html#set-your-github_pat

# Sys.setenv(GITHUB_PAT = "mysecret_access_token")

# Install package "remotes" from CRAN
if (! require("remotes")) {
  install.packages("remotes", repos = "https://cloud.r-project.org")
}

# Install KWB package 'kwb.hantush' from GitHub

remotes::install_github("kwb-r/kwb.hantush")

Further Documentation

Please have a look at the following two articles:

  1. Tutorial: for using the R package

  2. Shiny App: for interactively "exploring" the impact of the different input model parameters on the groundwater mounding

Recommended Literature

The USGS report 'Simulation of Groundwater Mounding Beneath Hypothetical Stormwater Infiltration Basins' by Carleton (2010) provides more background information on the Hantush calculation and also compares it to alternative approaches. In order to validate the calculation accuracy of the R package kwb.hantush it is benchmarked against these solutions here.



KWB-R/kwb.hantush documentation built on Oct. 1, 2019, 3:32 p.m.