Skip to content

Latest commit

 

History

History
229 lines (184 loc) · 12.2 KB

2_RunDefaultSettings.md

File metadata and controls

229 lines (184 loc) · 12.2 KB
Raw

Start running MAgPIE with default settings

Kristine Karstens ([email protected]) 11 October, 2019

1 Introduction

Whereas MAgPIE inner core is written in GAMS, it comes with an outer layer for data handling in R. This also applies to the start of MAgPIE. Moreover this nested structure leads to some characteristics in code execution, that should been understand to do basic troubleshooting.

Learning objectives

The goal of this exercise is to run MAgPIE with default settings. After completion of this exercise, you’ll be able to:

  1. Start MAgPIE with the predefined start scripts.
  2. Understand the stages of model execution.
  3. Find basic indicators in the case of errors.
  4. Stop MAgPIE code.

2 Start Scripts

To run the model execute in terminal (cmd for Windows, shell for Linux, MacOS) in the main folder of the model:

Rscript start.R

or from within R

source("start.R")

This will give you a list of available run scripts you can choose from, looking as follows:

Global .Rprofile loaded!


Choose start script:
1: default
2: check code
3: download data only
4: recalibrate
5: aff test
6: bmi shr
7: bra comp
8: cemics2
9: demandtest
10: disagg
11: emulator
12: fable prep
13: fable start
14: factor cost comparison
15: fix som
16: inms
17: inms2
18: MAg4 candidate
19: run time
20: sim4nexus temporary
21: sim4nexus
22: ssp cc
23: ssp deforestation
24: sustag
25: testruns
26: tradetest
Number:

To run a single model run with settings as stated in default.cfg you can choose start script default, which can be done by typing 1 and confirm via Enter. A new selecting list to choose the way of executing the code will show up:

Choose submission type:
1: Direct execution
2: Background execution
3: Debug mode
Number:

To run a the code within your terminal you choose Direct execution (again via 1 and Enter).

Exercise: Start a magpie run with the default start scrpit as Direct execution.

More details:

  • check code will execute a test script within R, that check consistence of the code.
  • download data only will just execetute a download script.
  • recalibrate will recalculate the yield calibration factors. This is usually not nessessary (only if the input files change and than default settings will automatically run the recalibration with the default run script.)
  • All other start scripts refer to quite specific run settings from individual MAgPIE developers. When you become a more advanced users, you can also add your own run scripts by saving them in the folder scripts/start.
  • Background execution will start the model as a job in the background even running, if you close your terminal. The output will be written into [run_title].log
  • Debug mode is similar to normal Direct execution.
  • If you run the code on a high performance cluster handling jobs with SLURM, you maybe also get a 4. and 5. option for job execution. `SLURM [priority/standby] will handle job submission to hpc. This is customize to PIK-cluster settings and may lead to problems on other hpc.

3 Phases of model execution

As pointed out before the execution of the GAMS model execution is nested in pre- and postprosessing framework written R.

Preprocessing

Preprocessing starts with the execution of Rscript start.R and includes the following steps:

step tasks: embedded in:
1. job submission load choosen start script, apply choosen submission type start.R
- lock model folder - create .lock folder to stop co-execution scripts/start_function.R
2. configurate run and code check load libraries, configure settings, run settingsCheck() (lucode) to check code for consistency scripts/start_function.R
3. input data check, if data download is nessessary, download data scripts/downloader/download.R
4. npi/ndc calculation calculate for specific cluster and regional settings the representation of land based npi/ndc policies within the model scripts/npi_ndc/start_npi_ndc.R
5. yield calibration calculates a regional yield calibration factor based on a pre run of magpie to be inline with FAO production data scripts/calibration/calc_calib.R
6. gams code submission execute gams command to final run the gams model, start post-processing after run finished scripts/run_submit/submit.R
- unlock model folder - delete .lock folder, be ready for next call of start script scripts/start_function.R

Several of these steps will generate terminal output.

Exercise: Match the terminal output to steps of preprocessing.

GAMS model execution

The GAMS code execution is started with submit.R and by default there is no output on your terminal with regard to the optimizations prozess. You can find output in the output folder of the run:

  • output/[run_title]/full.lst - complitation, execution & iteration log and summaries
  • output/[run_title]/full.log - optimization log (detailed solver output)
step more information in:
1. code complilation full.lst
2. code execution for each time step: full.lst
2.1. solve food demand model full.lst, full.log
2.2. solve magpie model full.lst, full.log
2.3. iterate food demand and magpie model till convergence is reached full.lst

Exercise: Open the full.lst and locate the different steps of gams model run.

Postprosessing

Postprocessing starts after gams runs finished. If a fulldata.gdx was created, the following postprocessing steps are executed:

step tasks: embedded in:
1. Submit run statistics Submit run statistics repository submit.R
2. Execute configured output scripts Run output.R in postprocessing mode output.R
2.1. rds report Create rds report with magpie4 library scripts/output/single/rds_report.R
2.2. validation Create based on report-functions (magpie4) a validation.pdf scripts/output/single/validation.R
2.3. interpolation Disaggregate land use pattern to 0.5° grid, generate spam-files scripts/output/single/interpolation.R
2.4. (others) Several other scripts scripts/output/[single/comparison]/*.R

Several of these steps will generate terminal output. More information in tutorial 5_AnalysingModelOutputs.Rmd.

4 First ideas for troubleshooting

Here we listed some troubles and where to find them:

step possible issues:
pre1. job submission General R issues (missing PATH variables)
- lock model folder - .lock folder not deleted after termination of a run
pre2. configurate run and code check missing libraries, failed code check (after change in the code)
pre3. input data no internet connection, input data not available (check spelling)
pre4. npi/ndc calculation
pre5. yield calibration general gams issues (compilation or solver failures, missing PATH variables)
pre6. gams code submission
- unlock model folder -
gams1. code complilation general gams issues (compilation or solver failures, missing PATH variables)
gams2. code execution for each time step:
gams2.1. solve food demand model Infeasibilties
gams2.2. solve magpie model Infeasibilties
gams2.3. iterate food demand and magpie model till convergence is reached
post1. Submit run statistics No access to repository (not critical)
post2. Execute configured output scripts
post2.1. rds report missing libraries (specially gdx, gdxrrw, magpie4)
post2.2. validation latexrelated r-extension are not working or missing
post2.3. interpolation
post2.4. (others) r extension are missing (e.g. ncdf)

Exercise: If your run fails, try to find out with the help of terminal output and full.lst, full.log, what went wrong.

5 Stop the model

  • The model can be stopped with Crtl + C.
  • If you run it in background mode you have to kill the job over the Task Manager or process handler (linux: top).
  • Make sure that you delete the .lock folder, if it was not deleted automatically to unlock the model after a termination of a run.

Exercise: Stop the magpie run with Crtl + C.

6 Lessons learned

  1. You started a MAgPIE run with the predefined default start scripts.
  2. You had a look into on the terminal output and the full.lst.
  3. Maybe: you solved some first issues.
  4. You stopped a MAgPIE run.