Skip to content

Commit

Permalink
small additions
Browse files Browse the repository at this point in the history
  • Loading branch information
biopsichas committed Jun 20, 2024
1 parent 5a75331 commit d9dba0f
Show file tree
Hide file tree
Showing 8 changed files with 77 additions and 13 deletions.
20 changes: 18 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,27 @@ library(badger)
`r badge_code_size("biopsichas/SWATtunR")`
`r badge_license("MIT")`

Text text text
The goal of `SWATtunR` is to help with the [SWAT+ model](https://swat.tamu.edu/software/plus/) calibration and validation. These functions were developed and tested for the implementation of modeling tasks in the [OPTAIN project](https://www.optain.eu/), [Nordbalt-Ecosafe](https://projects.au.dk/nordbalt-ecosafe) and [LIFE SIP Vanduo](https://webgate.ec.europa.eu/life/publicWebsite/project/LIFE22-IPE-LT-LIFE-SIP-Vanduo-101104645/integrated-water-management-in-lithuania). Functions are initially developed by [Christoph Schuerz](https://www.ufz.de/index.php?en=49467), which added important capability on top of other R tools designed for the SWAT/SWAT+ models. Therefore, we highly recommend trying and using these tools:

- [SWATbuildR](https://git.ufz.de/optain/wp4-integrated-assessment/swat/bildr_script)[^1] -
R tool for building SWAT+ setups;
- [SWATprepR](https://biopsichas.github.io/SWATprepR/) - SWAT+ model input data preparation helper.
- [SWATfarmR](http://chrisschuerz.github.io/SWATfarmR/) - R tool for
preparing management schedules for SWAT model;
- [SWATdoctR](https://git.ufz.de/schuerz/swatdoctr) - A collection of
functions in R and routines for SWAT model calibration and model
diagnostics;
- [SWATrunR](https://chrisschuerz.github.io/SWATrunR/) - R tool for running
SWAT models for different parameters and scenarios.
- [SWATmeasR](https://nc.ufz.de/s/KA9Cr2bbtALGMHr?path=%2FWPs%20%26%20Tasks%2FWP4%2FTask%204.4%2FTools%20to%20share)[^1] - R tool for implementing Natural/Small Water Retention Measures (NSWRMs) in the SWAT+ models and running scenarios.

<img src="man/figures/swativerse_update.png" title="SWAT packages for R" alt="swativerse logo" width="80%" style="display: block; margin: auto;" />

Detailed information about packages, workflow steps, input data, SWAT+ parameters, model calibration, validation, etc., could be found in the [SWAT+ modeling protocol](https://doi.org/10.5281/zenodo.7463395).

## Installation

Text text text
You can install the development version of **SWATtunR** from [GitHub](https://github.com/biopsichas/SWATtunR).

``` r
# If the package 'remotes' is not installed run first:
Expand Down
38 changes: 35 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Introduction to SWATtunR

# SWATtunR

[![](https://img.shields.io/badge/devel%20version-0.0.1.9003-blue.svg)](https://github.com/biopsichas/SWATtunR)
[![](https://img.shields.io/badge/devel%20version-0.0.1.9006-blue.svg)](https://github.com/biopsichas/SWATtunR)
[![](https://img.shields.io/github/last-commit/biopsichas/SWATtunR.svg)](https://github.com/biopsichas/SWATtunR/commits/green)
[![](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![Project Status: Active - The project has reached a stable, usable
Expand All @@ -13,11 +13,43 @@ developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.re
[![License:
MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://cran.r-project.org/web/licenses/MIT)

Text text text
The goal of `SWATtunR` is to help with the [SWAT+
model](https://swat.tamu.edu/software/plus/) calibration and validation.
These functions were developed and tested for the implementation of
modeling tasks in the [OPTAIN project](https://www.optain.eu/),
[Nordbalt-Ecosafe](https://projects.au.dk/nordbalt-ecosafe) and [LIFE
SIP
Vanduo](https://webgate.ec.europa.eu/life/publicWebsite/project/LIFE22-IPE-LT-LIFE-SIP-Vanduo-101104645/integrated-water-management-in-lithuania).
Functions are initially developed by [Christoph
Schuerz](https://www.ufz.de/index.php?en=49467), which added important
capability on top of other R tools designed for the SWAT/SWAT+ models.
Therefore, we highly recommend trying and using these tools:

- [SWATbuildR](https://git.ufz.de/optain/wp4-integrated-assessment/swat/bildr_script)\[^1\] -
R tool for building SWAT+ setups;
- [SWATprepR](https://biopsichas.github.io/SWATprepR/) - SWAT+ model
input data preparation helper.
- [SWATfarmR](http://chrisschuerz.github.io/SWATfarmR/) - R tool for
preparing management schedules for SWAT model;
- [SWATdoctR](https://git.ufz.de/schuerz/swatdoctr) - A collection of
functions in R and routines for SWAT model calibration and model
diagnostics;
- [SWATrunR](https://chrisschuerz.github.io/SWATrunR/) - R tool for
running SWAT models for different parameters and scenarios.
- [SWATmeasR](https://nc.ufz.de/s/KA9Cr2bbtALGMHr?path=%2FWPs%20%26%20Tasks%2FWP4%2FTask%204.4%2FTools%20to%20share)\[^1\] -
R tool for implementing Natural/Small Water Retention Measures
(NSWRMs) in the SWAT+ models and running scenarios.

<img src="man/figures/swativerse_update.png" title="SWAT packages for R" alt="swativerse logo" width="80%" style="display: block; margin: auto;" />

Detailed information about packages, workflow steps, input data, SWAT+
parameters, model calibration, validation, etc., could be found in the
[SWAT+ modeling protocol](https://doi.org/10.5281/zenodo.7463395).

## Installation

Text text text
You can install the development version of **SWATtunR** from
[GitHub](https://github.com/biopsichas/SWATtunR).

``` r
# If the package 'remotes' is not installed run first:
Expand Down
22 changes: 19 additions & 3 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ articles:
hc: hc.html
sc-crops: sc-crops.html
sc-wy: sc-wy.html
last_built: 2024-06-19T12:05Z
last_built: 2024-06-20T12:39Z

Binary file added docs/reference/figures/swativerse_update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/reference/sample_lhs.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/search.json

Large diffs are not rendered by default.

Binary file added man/figures/swativerse_update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d9dba0f

Please sign in to comment.