diff --git a/DESCRIPTION b/DESCRIPTION index 92ca1f4..ed22cbd 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -7,7 +7,7 @@ Maintainer: Tam V. Nguyen Description: Parameter calibration and uncertainty analysis with SWAT/SWAT+ and their modified versions. Encoding: UTF-8 LazyData: true -RoxygenNote: 7.3.1 +RoxygenNote: 7.3.2 URL: https://github.com/tamnva/R-SWAT BugReports: https://github.com/tamnva/R-SWAT/issues Depends: R (>= 4.0) @@ -40,3 +40,4 @@ Suggests: testthat (>= 3.0.0) Config/testthat/edition: 3 VignetteBuilder: knitr +SystemRequirements: SWAT/SWAT+ executable files (https://swat.tamu.edu/software/) diff --git a/README.md b/README.md index 09f8e21..3e4ed2e 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,9 @@ ## Quick Start! -RSWAT is an R package hosted on GitHub (to be submitted to CRAN soon). First, you need to install [R](https://cloud.r-project.org/), and [RStudio](https://posit.co/download/rstudio-desktop/) (installing RStudio is recommended, not a MUST) then **run** the following commands **in RStudio**. If you run in R, package vignettes cannot be built, however, this DOES NOT affect the functionalities of RSWAT. +RSWAT is an R package hosted on GitHub (to be submitted to CRAN soon). First, you need to install [R](https://cloud.r-project.org/), and [RStudio](https://posit.co/download/rstudio-desktop/) (installing RStudio is recommended, not a MUST) then run the following commands **in RStudio**. If you run in R, package vignettes cannot be built, however, this DOES NOT affect the functionalities of RSWAT. + +To run RSWAT, the SWAT/SWAT+ model is required. The SWAT/SWAT+ model (executable file) could be obtained from the official [SWAT website](https://swat.tamu.edu/software/). ```R # First install remotes package if you have not installed @@ -24,6 +26,7 @@ remotes::install_github("tamnva/R-SWAT", force = TRUE, dependencies = TRUE, buil library(RSWAT) # Extract example data (3.6 MB of storage). TODO: replace tempdir() with your path, e.g., "C:/example" +# The example data DO NOT include the SWAT executable files (please download them at https://swat.tamu.edu/software/) extracExampleData(exampleData, "all", tempdir()) # Call RSWAT graphical user interface: DO NOT use RSWAT::showRSWAT() diff --git a/inst/R-SWAT/HTML/introduction.html b/inst/R-SWAT/HTML/introduction.html index 28c9216..3ab7b9a 100644 --- a/inst/R-SWAT/HTML/introduction.html +++ b/inst/R-SWAT/HTML/introduction.html @@ -30,7 +30,6 @@
@@ -43,7 +42,7 @@