|
*This page explains some first steps in backbone. It is still under construction. In case something is missing, feel free to add it.*
|
|
_This page explains some first steps in backbone. It is still under construction. In case something is missing, feel free to add it._
|
|
|
|
|
|
|
|
|
|
# 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 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. 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.
|
|
2. 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.
|
|
* Instructions if you are using Git CMD from 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 `release-3x`-branch as it is latest stable branch.
|
|
* Then clone by typing: `git clone https://gitlab.vtt.fi/backbone/backbone.git` to clone the latest Backbone source code.
|
|
|
|
* It is recommended to switch to the `release-3x`-branch as it is latest stable branch, see [Versions](https://gitlab.vtt.fi/backbone/backbone/-/wikis/Versions) for instructions how to switch to release-3.x
|
|
* 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.
|
|
* 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:
|
|
3. Make sure your `/input`directory contains the following files:
|
|
- `1_options.gms`
|
|
- `1_options.gms`
|
|
- `modelsInit.gms`
|
|
- `modelsInit.gms`
|
|
- `scheduleInit.gms`
|
|
- `scheduleInit.gms`
|
|
- `timesAndSamples.inc`
|
|
- `timesAndSamples.inc`
|
|
- input data file that can be excel or gdx
|
|
- input data file that can be excel or gdx
|
|
|
|
4. If you do not have these files, 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:
|
|
3. If you do not have these files, 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')`
|
|
* `mSettings({MODEL_TYPE}, 't_end')`
|
|
* `mSettings({MODEL_TYPE}, 't_horizon')`
|
|
* `mSettings({MODEL_TYPE}, 't_horizon')`
|
|
* `mSettings({MODEL_TYPE}, 't_jump')`
|
|
* `mSettings({MODEL_TYPE}, 't_jump')`
|
... | @@ -23,14 +22,14 @@ |
... | @@ -23,14 +22,14 @@ |
|
* `mSettings({MODEL_TYPE}, 'stepLengthInHours')`
|
|
* `mSettings({MODEL_TYPE}, 'stepLengthInHours')`
|
|
* `mInterval({MODEL_TYPE}, 'stepsPerInterval', 'c000')`
|
|
* `mInterval({MODEL_TYPE}, 'stepsPerInterval', 'c000')`
|
|
* where `{MODEL_TYPE}` should be `"invest"` or `"schedule"`.
|
|
* where `{MODEL_TYPE}` should be `"invest"` or `"schedule"`.
|
|
|
|
5. To keep your Backbone updated,
|
|
4. To keep your Backbone updated,
|
|
|
|
* run `git pull` every once in a while. This downloads the most recent version of the branch.
|
|
* run `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.
|
|
* 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
|
|
## How to get backbone running
|
|
*somewhat detailed instruction on GAMS and Git, briefly describing which buttons to press*
|
|
|
|
|
|
_somewhat detailed instruction on GAMS and Git, briefly describing which buttons to press_
|
|
|
|
|
|
* open GAMS Studio or GAMS IDE
|
|
* open GAMS Studio or GAMS IDE
|
|
* If using IDE, create a new project to the folder where you cloned the model
|
|
* If using IDE, create a new project to the folder where you cloned the model
|
|
* open `Backbone.gms` from the cloned repository
|
|
* open `Backbone.gms` from the cloned repository
|
... | | ... | |