... | @@ -3,16 +3,25 @@ |
... | @@ -3,16 +3,25 @@ |
|
|
|
|
|
# Installation instructions
|
|
# Installation instructions
|
|
|
|
|
|
0. Before starting, make sure you have [git](https://git-scm.com/) and [GAMS](https://www.gams.com/) installed. Ideally use one 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/)...).
|
|
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.
|
|
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 `master`-branch OR: `git clone -b dev https://gitlab.vtt.fi/backbone/backbone.git` to clone `dev`-branch. Note: If you planning to use the tutorial [Example data sets](Getting-started/Example data sets) provided, please clone the `dev` branch (as of now the tutorial has been tested for commit c8564702fbe4d4f5bdae274183dba5880d80598b).
|
|
* 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.
|
|
3. Make sure your `/input`directory contains the following files:
|
|
* Then clone by typing: `git clone -b dev https://gitlab.vtt.fi/backbone/backbone.git` to clone `dev`-branch. It is recommended to clone the `dev`-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](Getting-started/Example data sets) provided (as of now the tutorial has been tested for commit c8564702fbe4d4f5bdae274183dba5880d80598b).
|
|
|
|
2. Make sure your `/input`directory contains the following files (to be found in the [example](https://gitlab.vtt.fi/backbone/backbone/-/wikis/Getting-started/Example-data-sets)):
|
|
- `1_options.gms` (this should call the `gdxxrw` if Excel-files are used as input)
|
|
- `1_options.gms` (this should call the `gdxxrw` if Excel-files are used as input)
|
|
- `modelsInit.gms`
|
|
- `modelsInit.gms`
|
|
- `scheduleInit.gms` (all of the above are included in the [example](https://gitlab.vtt.fi/backbone/backbone/-/wikis/Getting-started/Example-data-sets))
|
|
- `scheduleInit.gms`
|
|
- `timesAndSamples.inc` (you can copy and rename `timesAndSamples_temp.inc`from the repo root)
|
|
- `timesAndSamples.inc` (you can copy and rename `timesAndSamples_temp.inc`from the repo root)
|
|
|
|
|
|
Note that `scheduleInit.gms` has to be adapted to your input file in terms of time-series length.
|
|
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')`
|
|
|
|
* `mSettings({MODEL_TYPE}, 't_horizon')`
|
|
|
|
* `mSettings({MODEL_TYPE}, 't_jump')`
|
|
|
|
* `mSettings({MODEL_TYPE}, 'dataLength')`
|
|
|
|
* `mSettings({MODEL_TYPE}, 'stepLengthInHours')`
|
|
|
|
* `mInterval({MODEL_TYPE}, 'stepsPerInterval', 'c000')`
|
|
|
|
|
|
|
|
where `{MODEL_TYPE}` should be `"invest"` or `"schedule"`.
|
|
|
|
|
|
To keep your Backbone updated, remember to `git pull` every once in a while.
|
|
To keep your Backbone updated, remember to `git pull` every once in a while.
|
|
|
|
|
... | @@ -25,4 +34,4 @@ To keep your Backbone updated, remember to `git pull` every once in a while. |
... | @@ -25,4 +34,4 @@ To keep your Backbone updated, remember to `git pull` every once in a while. |
|
|
|
|
|
The paths in toolbar are relative to the executed file and the `../data/` subdirectory is just a recommendation.
|
|
The paths in toolbar are relative to the executed file and the `../data/` subdirectory is just a recommendation.
|
|
|
|
|
|
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 `gams Backbone.gms --input_dir=input --input_file=input/data/YOUR_INPUT_FILE.xlsx` from a terminal. |
|
|
|
\ No newline at end of file |