Merge pull request #1383 from orichters/updatetutorial

update tutorials
remindmodel · Aug 22, 2023 · 06d3f61 · 06d3f61
2 parents 6c7db81 + ad646d2
commit 06d3f61
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -65,20 +65,17 @@ and memory. Recommended is a machine with Windows, MacOS or Linux, with at least
 16GB of memory and a Core i7 CPU or similar.
 
 ## HOW TO INSTALL
-
 Please refer to the [installation guide](tutorials/01_GettingREMIND.md).
 
-
 ## HOW TO CONFIGURE
 Model run settings are set in `config/default.cfg` and `main.gms` (or another config file of
 the same structure). New model scenarios can be created by adding a row to
 `config/scenario_config.csv`
 
 ## HOW TO RUN
-To run the model execute `Rscript start.R` (or `source("start.R")` from within
-R) in the main folder of the model.
-Make sure that the config file has been set correctly before
-starting the model.
+Please refer to the tutorials on how to
+[use the default settings](tutorials/02_RunningREMIND.md) and how to
+[run multiple scenarios](tutorials/03_RunningBundleOfRuns.md).
 
 ## HOW TO CONTRIBUTE
 We are interested in working with you! Contact us through GitHub
@@ -155,4 +152,4 @@ to cite the model.
 See list of authors in CITATION.cff
 
 ## CHANGELOG
-See log on GitHub (https://github.com/remindmodel)
+See [CHANGELOG.md](CHANGELOG.md) on GitHub.
diff --git a/tutorials/02_RunningREMIND.md b/tutorials/02_RunningREMIND.md
@@ -71,7 +71,8 @@ Go to your REMIND main folder (i.e. it contains subfolders such as `config`, `co
 Rscript start.R
 ```
 
-Without additional arguments this starts a single REMIND run using the settings from [`config/default.cfg`](../config/default.cfg) and [`main.gms`](../main.gms). Also, on Windows, you can double-click the `start.cmd` file.
+Without additional arguments this starts a single REMIND run using the settings from [`config/default.cfg`](../config/default.cfg) and [`main.gms`](../main.gms).
+Also, on Windows, you can double-click the `start_windows.cmd` file.
 You can control the script's behavior by providing additional arguments, for example starting a single REMIND run in one-region mode using the settings from `config/default.cfg` and `main.gms` (useful to quickly check if your changes to the code break the model):
 
 ``` bash

diff --git a/tutorials/03_RunningBundleOfRuns.md b/tutorials/03_RunningBundleOfRuns.md
@@ -82,12 +82,14 @@ If you want to manually start runs instead of editing the `start` column in the
 ```bash
 Rscript start.R --interactive config/scenario_config_XYZ.csv
 ```
-In interactive mode, the scripts lets you select a config file if you do not specify one. You can combine all these options and use
+In interactive mode, the scripts lets you select a config file if you do not specify one. You can combine options such as
 ```bash
-Rscript start.R -gqi
+Rscript start.R --quick --interactive
+Rscript start.R -qi
 ```
-as a shortcut, meaning `g` for `gamscompile`, `i` for `--interactive`, `q` for `--quick`. The shortcut `t` for `--test` avoids that `--gamscompile` is executed.
-
+The latter uses shortcuts, meaning `i` for `--interactive`, `q` for `--quick`. The shortcut `t` for `--test` avoids that anything is executed,
+`g` for `gamscompile` avoids that actual runs are started.
+See `Rscript start.R --help` for further information.
 
 Further notes:
 --------------