forked from remindmodel/remind
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathstart_coupled.R
264 lines (228 loc) · 13.4 KB
/
start_coupled.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
# | (C) 2006-2020 Potsdam Institute for Climate Impact Research (PIK)
# | authors, and contributors see CITATION.cff file. This file is part
# | of REMIND and licensed under AGPL-3.0-or-later. Under Section 7 of
# | AGPL-3.0, you are granted additional permissions described in the
# | REMIND License Exception, version 1.0 (see LICENSE file).
# | Contact: [email protected]
##################################################################
################# D E F I N E start_coupled #####################
##################################################################
start_coupled <- function(path_remind,path_magpie,cfg_rem,cfg_mag,runname,max_iterations=5,start_iter=1,n600_iterations=0,report=NULL,LU_pricing=TRUE,qos) {
require(lucode2)
require(gms)
require(magclass)
require(gdx)
library(methods)
library(remind2)
# delete entries in stack that contain needle and append new
.setgdxcopy <- function(needle,stack,new){
matches <- grepl(needle,stack)
out <- c(stack[!matches],new)
return(out)
}
mainwd <- getwd() # save folder in which this script is executed
# Retrieve REMIND settings
cfg_rem <- check_config(cfg_rem,paste0(path_remind,"config/default.cfg"),paste0(path_remind,"modules"))
cfg_rem$slurmConfig <- "direct"
cm_iteration_max_tmp <- cfg_rem$gms$cm_iteration_max # save default setting
cfg_rem_original <- c(setdiff(cfg_rem$output, "emulator"), "emulator") # save default remind output config and add "emulator" if missing
# retrieve MAgPIE settings
cfg_mag <- check_config(cfg_mag,paste0(path_magpie,"config/default.cfg"),paste0(path_magpie,"modules"))
cfg_mag$sequential <- TRUE
cfg_mag$force_replace <- TRUE
cfg_mag$output <- c("rds_report") # ,"remind","report") # rds_report: MAgPIE4; remind,report: MAgPIE3 (glo.modelstat.csv)
if (start_iter > max_iterations ) stop("### COUPLING ### start_iter > max_iterations")
# Start REMIND and MAgPIE iteratively
for (i in start_iter:max_iterations) {
cat("### COUPLING ### Iteration ",i,"\n")
##################################################################
#################### R E M I N D #################################
##################################################################
####################### PREPARE REMIND ###########################
cat("### COUPLING ### Preparing REMIND\n")
cat("### COUPLING ### Set working directory from",getwd());
setwd(path_remind)
cat(" to",getwd(),"\n")
source("scripts/start/submit.R") # provide source of "get_magpie_data" and "start_run"
cfg_rem$results_folder <- paste0("output/",runname,"-rem-",i)
cfg_rem$title <- paste0(runname,"-rem-",i)
cfg_rem$force_replace <- TRUE # overwrite existing output folders
#cfg_rem$gms$biomass <- "magpie_linear"
# define gdx paths
if (i==start_iter) {
cat("### COUPLING ### gdx in first iteration taken from files2export$start \n")
} else {
cat("### COUPLING ### gdx taken from previous iteration\n")
cfg_rem$files2export$start["input.gdx"] <- paste0("output/",runname,"-rem-",i-1,"/fulldata.gdx")
cfg_rem$files2export$start["input_bau.gdx"] <- paste0("output/",runname,"-rem-",i-1,"/input_bau.gdx")
cfg_rem$files2export$start["input_ref.gdx"] <- paste0("output/",runname,"-rem-",i-1,"/input_ref.gdx")
}
# Control Negishi iterations
itr_offset <- 1 # Choose this if negishi iterations should only be adjusted for coupling iteration numbers below 3
#itr_offset <- start_iter # Choose this if negishi iterations should be adjusted for the first three iterations (regardless of their number)
# This is the case after the coupling was restarted continuing from existing iterations.
double_iterations <- 1
if (cfg_rem$gms$cm_SlowConvergence == "on") double_iterations <- 2
if(i==itr_offset) {
# Set negisgi iteration to 1 for the first run
cfg_rem$gms$cm_iteration_max <- 1*double_iterations
#} else if (i==itr_offset+1) {
# cfg_rem$gms$cm_iteration_max <- 2*double_iterations
#} else if (i==itr_offset+2) {
# cfg_rem$gms$cm_iteration_max <- 3*double_iterations
} else {
# Set negishi iterations back to the value defined in the config file
cfg_rem$gms$cm_iteration_max <- cm_iteration_max_tmp
}
cat("Set Negishi iterations to",cfg_rem$gms$cm_iteration_max,"\n")
# Switch off generation of needless output for all but the last REMIND iteration
if (i < max_iterations) {
cfg_rem$output <- c("reporting","emulator","rds_report")
} else {
cfg_rem$output <- cfg_rem_original
}
############ DECIDE IF AND HOW TO START REMIND ###################
outfolder_rem <- NULL
if (is.null(report)) {
######### S T A R T R E M I N D S T A N D A L O N E ##############
cfg_rem$gms$cm_MAgPIE_coupling <- "off"
cat("### COUPLING ### No MAgPIE report for REMIND input provided.\n")
cat("### COUPLING ### REMIND will be started in stand-alone mode with\n ",runname,"\n ",cfg_rem$results_folder,"\n")
outfolder_rem <- submit(cfg_rem)
} else if (grepl(paste0("report.mif"),report)) { # if it is a MAgPIE report
######### S T A R T R E M I N D C O U P L E D ##############
cfg_rem$gms$cm_MAgPIE_coupling <- "on"
if (!file.exists(report)) stop(paste0("### COUPLING ### Could not find report: ", report,"\n"))
cat("### COUPLING ### Starting REMIND in coupled mode with\n Report=",report,"\n Folder=",cfg_rem$results_folder,"\n")
# Keep path to MAgPIE report in mind to have it available after the coupling loop
mag_report_keep_in_mind <- report
cfg_rem$pathToMagpieReport <- report
outfolder_rem <- submit(cfg_rem)
############################
} else if (grepl("REMIND_generic_",report)) { # if it is a REMIND report
############### O M I T R E M I N D ###############################
cat("### COUPLING ### Omitting REMIND in this iteration\n Report=",report,"\n")
report <- report
} else {
stop(paste0("### COUPLING ### Could not decide whether ",report," is REMIND or MAgPIE output.\n"))
}
if(!is.null(outfolder_rem)) {
report <- paste0(path_remind,outfolder_rem,"/REMIND_generic_",cfg_rem$title,".mif")
cat("### COUPLING ### REMIND output was stored in ",outfolder_rem,"\n")
if (file.exists(paste0(outfolder_rem,"/fulldata.gdx"))) {
modstat <- readGDX(paste0(outfolder_rem,"/fulldata.gdx"),types="parameters",format="raw",c("s80_bool","o_modelstat"))
if (cfg_rem$gms$optimization == "negishi") {
if (as.numeric(modstat$o_modelstat$val)!=2 && as.numeric(modstat$o_modelstat$val)!=7) stop("Iteration stopped! REMIND o_modelstat was ",modstat," but is required to be 2 or 7.\n")
} else if (cfg_rem$gms$optimization == "nash") {
if (as.numeric(modstat$s80_bool$val)!=1) cat("Warning: REMIND s80_bool not 1. Iteration continued though.\n")
}
} else {
stop("### COUPLING ### REMIND didn't produce 'fulldata.gdx'. Iteration stopped!")
}
}
if (!file.exists(report)) stop(paste0("### COUPLING ### Could not find report: ", report,"\n"))
# If in the last iteration don't run MAgPIE
if (i == max_iterations) break
##################################################################
#################### M A G P I E #################################
##################################################################
cat("### COUPLING ### Preparing MAgPIE\n")
cat("### COUPLING ### Set working directory from",getwd());
setwd(path_magpie)
cat(" to",getwd(),"\n")
source("scripts/start_functions.R")
cfg_mag$results_folder <- paste0("output/",runname,"-mag-",i)
cfg_mag$title <- paste0(runname,"-mag-",i)
# Increase MAgPIE resolution n600_iterations before final iteration so that REMIND
# runs n600_iterations iterations using results from MAgPIE with higher resolution
if (i > (max_iterations-n600_iterations)) {
cat("Current iteration":i,". Setting MAgPIE to n600\n")
cfg_mag <- setScenario(cfg_mag,"n600",scenario_config=paste0("config/scenario_config.csv"))
}
# Providing MAgPIE with gdx from last iteration's solution only for time steps >= cfg_rem$gms$cm_startyear
# For years prior to cfg_rem$gms$cm_startyear MAgPIE output has to be identical across iterations.
# Because gdxes might slightly lead to a different solution exclude gdxes for the fixing years.
if (i>1) {
cat("### COUPLING ### Copying gdx files from previous iteration\n")
gdxlist <- paste0("output/",runname,"-mag-",i-1,"/magpie_y",seq(cfg_rem$gms$cm_startyear,2150,5),".gdx")
cfg_mag$files2export$start <- .setgdxcopy(".gdx",cfg_mag$files2export$start,gdxlist)
}
cat("### COUPLING ### MAgPIE will be started with\n Report = ",report,"\n Folder=",cfg_mag$results_folder,"\n")
########### START MAGPIE #############
outfolder_mag <- start_run(cfg_mag,path_to_report=report,LU_pricing=LU_pricing,codeCheck=FALSE)
######################################
cat("### COUPLING ### MAgPIE output was stored in ",outfolder_mag,"\n")
report <- paste0(path_magpie,outfolder_mag,"/report.mif")
# Checking whether MAgPIE is optimal in all years
file_modstat <- paste0(outfolder_mag,"/glo.magpie_modelstat.csv")
if(file.exists(file_modstat)) {
modstat_mag <- read.csv(file_modstat, stringsAsFactors = FALSE, row.names=1, na.strings="")
} else {
modstat_mag <- readGDX(paste0(outfolder_mag,"/fulldata.gdx"),"p80_modelstat","o_modelstat", format="first_found")
}
if(!all((modstat_mag==2) | (modstat_mag==7)))
stop("Iteration stopped! MAgPIE modelstat is not 2 or 7 for all years.\n")
} # End of coupling iteration loop
cat("### COUPLING ### Set working directory from",getwd());
setwd(mainwd)
cat(" to",getwd(),"\n")
# for the sbatch command of the subsequent runs below set the number of tasks per node
# this not clean, because we use the number of regions of the *current* run to set the number of tasks for the *subsequent* runs
# but it is sufficiently clean, since the number of regions should not differ between current and subsequent
if (cfg_rem$gms$optimization == "nash" && cfg_rem$gms$cm_nash_mode == "parallel") {
# for nash: set the number of CPUs per node to number of regions + 1
nr_of_regions <- length(levels(read.csv2(cfg_rem$regionmapping)$RegionCode)) + 1
} else {
# for negishi: use only one CPU
nr_of_regions <- 1
}
#start subsequent runs via sbatch
for(run in cfg_rem$subsequentruns){
cat("Submitting subsequent run",run,"\n")
# load the config of the subsequent run to provide the correct qos setting (use new environmet to not overwrite the cfg_rem of the current run)
subseq.env <- new.env()
load(paste0("C_",run,".RData"),envir=subseq.env)
system(paste0("sbatch --qos=",subseq.env$qos," --job-name=C_",run," --output=C_",run,".log --mail-type=END --comment=REMIND-MAgPIE --tasks-per-node=",nr_of_regions," --wrap=\"Rscript start_coupled.R coupled_config=C_",run,".RData\""))
}
# Read runtime of ALL coupled runs (not just the current scenario) and produce comparison pdf
remindpath <- paste0(path_remind,"output")
magpiepath <- paste0(path_magpie,"output")
runs <- findCoupledruns(resultsfolder=remindpath)
ret <- findIterations(runs,modelpath=c(remindpath,magpiepath),latest=FALSE)
readRuntime(ret,plot=TRUE,coupled=TRUE)
unlink(c("runtime.log","runtime.out","runtime.rda"))
# combine REMIND and MAgPIE reports of last coupling iteration (and REMIND water reporting if existing)
report_rem <- paste0(path_remind,outfolder_rem,"/REMIND_generic_",cfg_rem$title,".mif")
if (exists("outfolder_mag")) {
# If MAgPIE has run use its regular outputfolder
report_mag <- paste0(path_magpie,outfolder_mag,"/report.mif")
} else {
# If MAgPIE did not run, because coupling has been restarted with the last REMIND iteration,
# use the path to the MAgPIE report REMIND has been restarted with.
report_mag <- mag_report_keep_in_mind
}
cat("Joining to a common reporting file:\n ",report_rem,"\n ",report_mag,"\n")
tmp1 <- read.report(report_rem,as.list=FALSE)
tmp2 <- read.report(report_mag,as.list=FALSE)[,getYears(tmp1),]
tmp3 <- mbind(tmp1,tmp2)
getNames(tmp3,dim=1) <- gsub("-(rem|mag)-[0-9]{1,2}","",getNames(tmp3,dim=1)) # remove -rem-xx and mag-xx from scenario names
# only harmonize model names to REMIND-MAgPIE, if there are no variable names that are identical across the models
if (any(getNames(tmp3[,,"REMIND"],dim=3) %in% getNames(tmp3[,,"MAgPIE"],dim=3))) {
msg <- "Cannot produce common REMIND-MAgPIE reporting because there are identical variable names in both models!\n"
cat(msg)
warning(msg)
} else {
# Replace REMIND and MAgPIE with REMIND-MAgPIE
#getNames(tmp3,dim=2) <- gsub("REMIND|MAgPIE","REMIND-MAGPIE",getNames(tmp3,dim=2))
write.report(tmp3,file=paste0("output/",runname,".mif"))
}
}
##################################################################
################# E X E C U T E start_coupled ###################
##################################################################
require(lucode2)
readArgs("coupled_config")
load(coupled_config)
start_coupled(path_remind,path_magpie,cfg_rem,cfg_mag,runname,max_iterations,start_iter,n600_iterations,path_report,LU_pricing,qos)
# Manual call:
# Rscript start_coupled.R coupled_config=runname