Getting-started/Quick-Start.md

@@ -6,12 +6,16 @@
 0. Before starting, make sure you have [git](https://git-scm.com/) and [GAMS](https://www.gams.com/) installed. Ideally use a git client of your choice ([Sublime](https://www.sublimemerge.com/), [Git Graph](https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph) in [VS Code](https://code.visualstudio.com/), [SourceTree](https://www.sourcetreeapp.com/)...) to visualize and navigate git.
 1. Clone the Backbone repository.  
     * Instructions if you are using Git CMD from [git-scm.com](https://git-scm.com/): First `cd` to the place on your computer where you wish to create your local repository. 
-    * Then clone by typing: `git clone https://gitlab.vtt.fi/backbone/backbone.git` to clone the latest Backbone source code. It is recommended to clone the latest `master`-branch as it most likely contains the most up-to-date version of backbone. Especially if you're planning to use the tutorial [Example data sets](https://gitlab.vtt.fi/backbone/backbone/-/wikis/Getting-started/Example%20models) provided (as of now the tutorial has been tested for commit  c8564702fbe4d4f5bdae274183dba5880d80598b).
+    * Then clone by typing: `git clone https://gitlab.vtt.fi/backbone/backbone.git` to clone the latest Backbone source code. It is recommended to clone the `release-3x`-branch as it is latest stable branch. 
+    * If you're planning to use the tutorial [Example data sets](https://gitlab.vtt.fi/backbone/backbone/-/wikis/Getting-started/Example%20models) provided, check that you download a tutorial version matching the model branch.
 2. Make sure your `/input`directory contains the following files:
-    - `1_options.gms` (this should call the `gdxxrw` if Excel-files are used as input)
+    - `1_options.gms`
     - `modelsInit.gms`
     - `scheduleInit.gms` 
-    - `timesAndSamples.inc` (you can copy and rename `timesAndSamples_temp.inc`from the repo root) 
+    - `timesAndSamples.inc`
+    - input data file that can be excel or gdx
+
+Folder `input/` contains a template file for each of these. 
 
 Note that `scheduleInit.gms` or `investInit.gms` has to be adapted to your input file in terms of time-series length and time-step length in hours. The settings to be adapted are: 
 * `mSettings({MODEL_TYPE}, 't_end')`
@@ -23,25 +27,28 @@ Note that `scheduleInit.gms` or `investInit.gms` has to be adapted to your input
 
 where `{MODEL_TYPE}` should be `"invest"` or `"schedule"`.
 
-To keep your Backbone updated, remember to `git pull` every once in a while.
+3. Updating the model 
+To keep your Backbone updated, remember to `git pull` every once in a while. This downloads the most recent version of the branch. 
+
+We are not introducing updates that brake input data within a release. All braking updates are released first in the master branch and then later release branches.
+
 
 ## How to get backbone running
 *somewhat detailed instruction on GAMS and Git, briefly describing which buttons to press*
 * open GAMS Studio or GAMS IDE
+* If using IDE, create a new project to the folder where you cloned the model
 * open `Backbone.gms` from the cloned repository
-* add `--input_dir=input --input_file=input/data/YOUR_INPUT_FILE.xlsx` in the toolbar
-* hit the run button
-
-The paths in toolbar are relative to the executed file and the `../data/` subdirectory is just a recommendation.
+* If using input data excel, add `--input_file_excel=YOUR_INPUT_FILE.xlsx` in the toolbar and hit the run button
+* If using input data gdx, add `--input_file_gdx=YOUR_INPUT_FILE.gdx` in the toolbar and hit the run button
 
-If you have added your GAMS directory to your PATH you can also call backbone via `gams Backbone.gms --input_dir=input --input_file=input/data/YOUR_INPUT_FILE.xlsx` from a terminal.
+If you have added your GAMS directory to your PATH, you can also call backbone via `--input_file_excel=YOUR_INPUT_FILE.xlsx` from a command line.
 
-## Tutorial for new users (updated 27.10.2022)
+## Tutorial for new users
 
 Ruhr University Bochum (RUB) offers a free and updated tutorial material for new users: [Backbone tutorial](https://www.ee.ruhr-uni-bochum.de/ee/forschung/backbone.html.en). You can find the instructions and assignments under the link Backbone-tutorial / Read more. Backbone can be tricky to learn on your own, so we recommend following the tutorial to get started.
 
 RUB has been using Backbone in Master's course Energy System Analysis since 2020. The other course material like lectures, lecture slides and answers to tutorial assignments are unfortunately available only to course participants. 
 
-## Need help getting started? (updated 27.10.2022)
+## Need help getting started?
 
 If you would like to start using Backbone in your project, please join the monthly [user support calls](More-information/Bi-weekly-call-agenda). Feel free to contact the developers at VTT by sending your request to: nelli.putkonen(at)vtt.fi.
\ No newline at end of file