Skip to content

Releases: KWB-R/kwb.swmm

kwb.swmm (v0.1.1): R Package with Functions for Working with EPA`s Storm Water Management Model (SWMM)

19 Mar 11:12
62ccd4d
Compare
Choose a tag to compare

kwb.swmm (v0.1.0): R Package with Functions for Working with EPA`s Storm Water Management Model (SWMM)

23 May 06:49
1461d3b
Compare
Choose a tag to compare

Installation

This version 0.1.0 of the R package can be downloaded and installed from GitHub:

### 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.swmm' from GitHub
remotes::install_github("KWB-R/kwb.swmm@v0.1.0")

Content

  • Functions

    • download_swmm_executable(): downloads SWMM executable from USEPA`s GitHub repo of https://github.com/USEPA/Stormwater-Management-Model/releases

    • run_swmm(): compared to swmmr::run_swmm()it allows to use allows to run SWMM model in model folder, i.e. it is possible to define paths to climate data in swmm_model.inp with relative paths (if these are contained in the same folder or a subfolder of the model_dir)

    • get_results() function for importing SWMM results into R

    • calculate_rainevent_stats() for aggregation of imported results based on user-defined column (default: total_runoff), function (default: sum) and event separation time

    • [get_lid_para_types()[https://kwb-r.github.io/kwb.swmm/reference/get_lid_para_types.html]: returning tidy tibble with expected/possible system elements for different low impact development elements

  • Workflow on how to use this R package