Skip to content

Commit

Permalink
doc: add quick demo to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nguyenta committed Feb 9, 2024
1 parent 96b4c70 commit 7dbbaf0
Show file tree
Hide file tree
Showing 9 changed files with 41 additions and 6 deletions.
45 changes: 40 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,17 +53,52 @@ Example of working without the user interface, please see the RSWAT vignettes:
vignette("SUFI2_without_GUI",package="RSWAT")
```

# Quick demo (streamflow calibration with SWAT)

## Citing RSWAT
```R
# Call RSWAT graphical user interface: DO NOT use RSWAT:showRSWAT()
library(RSWAT)

**Nguyen, T. V.**, Dietrich, J., Dang, D. T., Tran, D. A., Doan, B. V., Sarrazin, F. J., Abbaspour, K., Srinivasan, R. (2022). An interactive graphical interface tool for parameter calibration, sensitivity analysis, uncertainty analysis, and visualization for the Soil and Water Assessment Tool. Environmental Modelling & Software, 156, 105497. https://doi.org/10.1016/j.envsoft.2022.105497.
# Extract example data (TODO: replace C:/example with your folder)
extracExampleData(exampleData, "all", "C:/example")

**Nguyen, T. V.** (2024). RSWAT: An R package for the Soil and Water Assessment Tool models. Submitted to The Journal of Open Source Software.
# We still need SWAT executable for this demo
# which can be downloaded from https://swat.tamu.edu/software/swat-executables/

# GUI of RSWAT
# Now show the interface and run with example data (detail of each step are shown below)
showRSWAT()

```

(NOTE: in the latest version, the user interface could be slightly difference)
<p align="center">
<img src="inst/R-SWAT/figures/RSWAT.gif" width=100% title="hover text">
<img src="inst/R-SWAT/figures/1.PNG" width=100% title="hover text">
</p>

<p align="center">
<img src="inst/R-SWAT/figures/2.PNG" width=100% title="hover text">
</p>

<p align="center">
<img src="inst/R-SWAT/figures/3.PNG" width=100% title="hover text">
</p>

<p align="center">
<img src="inst/R-SWAT/figures/41.PNG" width=100% title="hover text">
</p>

<p align="center">
<img src="inst/R-SWAT/figures/42.PNG" width=100% title="hover text">
</p>

<p align="center">
<img src="inst/R-SWAT/figures/43.PNG" width=100% title="hover text">
</p>



## Citing RSWAT

**Nguyen, T. V.**, Dietrich, J., Dang, D. T., Tran, D. A., Doan, B. V., Sarrazin, F. J., Abbaspour, K., Srinivasan, R. (2022). An interactive graphical interface tool for parameter calibration, sensitivity analysis, uncertainty analysis, and visualization for the Soil and Water Assessment Tool. Environmental Modelling & Software, 156, 105497. https://doi.org/10.1016/j.envsoft.2022.105497.

**Nguyen, T. V.** (2024). RSWAT: An R package for the Soil and Water Assessment Tool models. Submitted to The Journal of Open Source Software.
Binary file added inst/R-SWAT/figures/1.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added inst/R-SWAT/figures/2.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added inst/R-SWAT/figures/3.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added inst/R-SWAT/figures/41.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added inst/R-SWAT/figures/42.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added inst/R-SWAT/figures/43.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed inst/R-SWAT/figures/RSWAT.gif
Binary file not shown.
2 changes: 1 addition & 1 deletion inst/R-SWAT/ui.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ ui <- shinydashboard::dashboardPage(
# ----------------------------------------------------------------------Header
shinydashboard::dashboardHeader(
# Name of the app
title = "RSWAT (v1.0)",
title = "RSWAT (v4.0)",

# Add two buttons in the header for saving and loading project
tags$li(class = "dropdown",
Expand Down

0 comments on commit 7dbbaf0

Please sign in to comment.