|
|
# Installation instructions
|
|
|
*This page explains some first steps in backbone. It is still under construction. In case something is missing, feel free to add it.*
|
|
|
|
|
|
0. Make sure you have [git](https://git-scm.com/) and ideally one 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/), ...) installed
|
|
|
1. Clone the repository.
|
|
|
2. Checkout the `dev` branch (as of now the tutorial has been tested for commit c8564702fbe4d4f5bdae274183dba5880d80598b)
|
|
|
3. make sure your `/input`directory contains the following files:
|
|
|
|
|
|
# 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/)...).
|
|
|
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).
|
|
|
3. Make sure your `/input`directory contains the following files:
|
|
|
- `1_options.gms` (this should call the `gdxxrw` if Excel-files are used as input)
|
|
|
- `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))
|
... | ... | @@ -12,6 +14,8 @@ |
|
|
|
|
|
Note that `scheduleInit.gms` has to be adapted to your input file in terms of time-series length.
|
|
|
|
|
|
To keep your Backbone updated, remember to `git pull` every once in a while.
|
|
|
|
|
|
## How to get backbone running
|
|
|
*somewhat detailed instruction on GAMS and Git, briefly describing which buttons to press*
|
|
|
* open GAMS Studio or GAMS IDE
|
... | ... | @@ -22,12 +26,3 @@ Note that `scheduleInit.gms` has to be adapted to your input file in terms of ti |
|
|
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. |
|
|
|
|
|
## Input Files
|
|
|
### Where to put them?
|
|
|
### What do they have to contain?
|
|
|
(provide explanation within reasonable effort)
|
|
|
### What does it all mean?
|
|
|
*(This section will, at some point in time, contain explanations about variables/key elements of backbone.)*
|
|
|
## Results
|
|
|
where they are, and how to plot them? |
|
|
\ No newline at end of file |