Skip to content

Commit db170e2

Browse files
authored
Merge pull request #90 from KTH-dESA/documentation
Updated documentation
2 parents f08f342 + 6eb3014 commit db170e2

File tree

1 file changed

+28
-26
lines changed

1 file changed

+28
-26
lines changed

README.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,16 @@ in the model run, there will be 5 subdirectories, each labeled 0 through 4.
4747

4848
Within each `data/scenarios/#` subdirectory, CSV files hold information
4949
on the options that can be made. Each CSV file must follow the formatting
50-
shown below.
50+
shown below.
51+
NB: `-1` indicates to the model that there is no limit.
5152

5253
| PARAMETER | REGION | TECHNOLOGY | OPTION | YEAR | VALUE |
5354
|:--------------------------------:|:------:|------------|--------|:----:|-----------|
54-
| TotalAnnualMaxCapacityInvestment | UTOPIA | COAL | 0 | 2020 | 999999999 |
55-
| TotalAnnualMaxCapacityInvestment | UTOPIA | COAL | 0 | 2021 | 999999999 |
55+
| TotalAnnualMaxCapacityInvestment | UTOPIA | COAL | 0 | 2020 | -1 |
56+
| TotalAnnualMaxCapacityInvestment | UTOPIA | COAL | 0 | 2021 | -1 |
5657
| ... | ... | ... | ... | ... | ... |
57-
| TotalAnnualMaxCapacityInvestment | UTOPIA | COAL | 0 | 2049 | 999999999 |
58-
| TotalAnnualMaxCapacityInvestment | UTOPIA | COAL | 0 | 2050 | 999999999 |
58+
| TotalAnnualMaxCapacityInvestment | UTOPIA | COAL | 0 | 2049 | -1 |
59+
| TotalAnnualMaxCapacityInvestment | UTOPIA | COAL | 0 | 2050 | -1 |
5960
| TotalAnnualMaxCapacityInvestment | UTOPIA | COAL | 1 | 2020 | 0 |
6061
| TotalAnnualMaxCapacityInvestment | UTOPIA | COAL | 1 | 2021 | 0 |
6162
| ... | ... | ... | ... | ... | ... |
@@ -100,15 +101,16 @@ can be long formatted (otoole) or wide formatted (momani)
100101

101102
## 3. Add in scenario data
102103
For the first step, add the file `data/scenarios/1/A.csv`, where one
103-
option allows investment in IMPHCO, and one options does not allow it.
104+
option allows investment in IMPHCO, and one options does not allow it.
105+
NB: `-1` indicates to the model that there is no limit.
104106

105107
| PARAMETER | REGION | TECHNOLOGY | OPTION | YEAR | VALUE |
106108
|:--------------------------------:|:------:|------------|--------|:----:|-----------|
107-
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 1990 | 999999999 |
108-
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 1991 | 999999999 |
109+
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 1990 | -1 |
110+
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 1991 | -1 |
109111
| ... | ... | ... | ... | ... | ... |
110-
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 2009 | 999999999 |
111-
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 2010 | 999999999 |
112+
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 2009 | -1 |
113+
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 2010 | -1 |
112114
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 1 | 1990 | 0 |
113115
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 1 | 1991 | 0 |
114116
| ... | ... | ... | ... | ... | ... |
@@ -121,11 +123,11 @@ want to also add the option to invest in importing uranium. Add the file
121123

122124
| PARAMETER | REGION | TECHNOLOGY | OPTION | YEAR | VALUE |
123125
|:--------------------------------:|:------:|------------|--------|:----:|-----------|
124-
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPURN1 | 0 | 1990 | 999999999 |
125-
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPURN1 | 0 | 1991 | 999999999 |
126+
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPURN1 | 0 | 1990 | -1 |
127+
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPURN1 | 0 | 1991 | -1 |
126128
| ... | ... | ... | ... | ... | ... |
127-
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPURN1 | 0 | 2009 | 999999999 |
128-
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPURN1 | 0 | 2010 | 999999999 |
129+
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPURN1 | 0 | 2009 | -1 |
130+
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPURN1 | 0 | 2010 | -1 |
129131
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPURN1 | 1 | 1990 | 0 |
130132
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPURN1 | 1 | 1991 | 0 |
131133
| ... | ... | ... | ... | ... | ... |
@@ -138,31 +140,31 @@ in importing coal, importing RL1, and if RLu is allowed to run or not. Add the f
138140

139141
| PARAMETER | REGION | TECHNOLOGY | OPTION | YEAR | VALUE |
140142
|:---------------------------------------:|:------:|------------|--------|:----:|-----------|
141-
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 1990 | 999999999 |
142-
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 1991 | 999999999 |
143+
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 1990 | -1 |
144+
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 1991 | -1 |
143145
| ... | ... | ... | ... | ... | ... |
144-
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 2009 | 999999999 |
145-
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 2010 | 999999999 |
146+
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 2009 | -1 |
147+
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 0 | 2010 | -1 |
146148
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 1 | 1990 | 0 |
147149
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 1 | 1991 | 0 |
148150
| ... | ... | ... | ... | ... | ... |
149151
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 1 | 2009 | 0 |
150152
| TotalAnnualMaxCapacityInvestment | UTOPIA | IMPHCO1 | 1 | 2010 | 0 |
151-
| TotalAnnualMaxCapacityInvestment | UTOPIA | RL1 | 0 | 1990 | 9999999 |
152-
| TotalAnnualMaxCapacityInvestment | UTOPIA | RL1 | 0 | 1991 | 9999999 |
153+
| TotalAnnualMaxCapacityInvestment | UTOPIA | RL1 | 0 | 1990 | -1 |
154+
| TotalAnnualMaxCapacityInvestment | UTOPIA | RL1 | 0 | 1991 | -1 |
153155
| ... | ... | ... | ... | ... | ... |
154-
| TotalAnnualMaxCapacityInvestment | UTOPIA | RL1 | 0 | 2009 | 9999999 |
155-
| TotalAnnualMaxCapacityInvestment | UTOPIA | RL1 | 0 | 2010 | 9999999 |
156+
| TotalAnnualMaxCapacityInvestment | UTOPIA | RL1 | 0 | 2009 | -1 |
157+
| TotalAnnualMaxCapacityInvestment | UTOPIA | RL1 | 0 | 2010 | -1 |
156158
| TotalAnnualMaxCapacityInvestment | UTOPIA | RL1 | 1 | 1990 | 0 |
157159
| TotalAnnualMaxCapacityInvestment | UTOPIA | RL1 | 1 | 1991 | 0 |
158160
| ... | ... | ... | ... | ... | ... |
159161
| TotalAnnualMaxCapacityInvestment | UTOPIA | RL1 | 1 | 2009 | 0 |
160162
| TotalAnnualMaxCapacityInvestment | UTOPIA | RL1 | 1 | 2010 | 0 |
161-
| TotalTechnologyAnnualActivityUpperLimit | UTOPIA | RLu | 0 | 1990 | 9999999 |
162-
| TotalTechnologyAnnualActivityUpperLimit | UTOPIA | RLu | 0 | 1991 | 9999999 |
163+
| TotalTechnologyAnnualActivityUpperLimit | UTOPIA | RLu | 0 | 1990 | -1 |
164+
| TotalTechnologyAnnualActivityUpperLimit | UTOPIA | RLu | 0 | 1991 | -1 |
163165
| ... | ... | ... | ... | ... | ... |
164-
| TotalTechnologyAnnualActivityUpperLimit | UTOPIA | RLu | 0 | 2009 | 9999999 |
165-
| TotalTechnologyAnnualActivityUpperLimit | UTOPIA | RLu | 0 | 2010 | 9999999 |
166+
| TotalTechnologyAnnualActivityUpperLimit | UTOPIA | RLu | 0 | 2009 | -1 |
167+
| TotalTechnologyAnnualActivityUpperLimit | UTOPIA | RLu | 0 | 2010 | -1 |
166168
| TotalTechnologyAnnualActivityUpperLimit | UTOPIA | RLu | 1 | 1990 | 0 |
167169
| TotalTechnologyAnnualActivityUpperLimit | UTOPIA | RLu | 1 | 1991 | 0 |
168170
| ... | ... | ... | ... | ... | ... |

0 commit comments

Comments
 (0)