|
# Installation instructions
|
|
# 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.*
|
|
*This page explains some first steps in backbone. It is still under construction. In case something is missing, feel free to add it.*
|
|
|
|
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:
|
|
|
|
- `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))
|
|
|
|
- `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.
|
|
|
|
|
|
## 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 `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 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
|
|
## Input Files
|
|
### Where to put them?
|
|
### Where to put them?
|
... | | ... | |