|
|
*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
|
|
|
|
|
|
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 `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`
|
|
|
- `modelsInit.gms`
|
|
|
- `scheduleInit.gms`
|
|
|
- `timesAndSamples.inc`
|
|
|
- input data file that can be excel or gdx
|
|
|
|
|
|
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_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"`.
|
|
|
|
|
|
4. To keep your Backbone updated,
|
|
|
* 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.
|
|
|
|
|
|
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.
|
|
|
2. Clone the Backbone 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 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.
|
|
|
3. Make sure your `/input`directory contains the following files:
|
|
|
- `1_options.gms`
|
|
|
- `modelsInit.gms`
|
|
|
- `scheduleInit.gms`
|
|
|
- `timesAndSamples.inc`
|
|
|
- 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:
|
|
|
* `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"`.
|
|
|
5. To keep your Backbone updated,
|
|
|
* 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.
|
|
|
|
|
|
## 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
|
|
|
* If using IDE, create a new project to the folder where you cloned the model
|
|
|
* open `Backbone.gms` from the cloned repository
|
... | ... | @@ -43,7 +42,7 @@ If you have added your GAMS directory to your PATH, you can also call backbone v |
|
|
|
|
|
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.
|
|
|
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?
|
|
|
|
... | ... | |