Initial Setup of piam_interfaces

Project specific interfaces to REMIND / MAgPIE

R package piamInterfaces, version 0.18.7

Purpose and Functionality

Project specific interfaces to REMIND / MAgPIE.

Tutorial

To understand how to submit to the IIASA database, read this REMIND tutorial.
In the following, we differentiate templates (list of variables and corresponding units used in a project) and mappings (specifying which PIAM variable will be mapped to a project variable).

Mappings

Mappings found in the inst/mappings folder serve to map variables from the PIAM framework to variables needed for the submission to databases. The mappings are ;-separated files, using # as comment character, with the following mandatory columns:

variable: name of the variable in the project template
unit: unit corresponding to variable
piam_variable: name of the variable in REMIND / MAgPIE / EDGE-T etc. reporting
piam_unit: unit corresponding to piam_variable
piam_factor: factor with which the piam_variable has to be multiplied for units to match

Recommended column:

description: description text defining the variable. Never use " and ; in the text.
source: abbreviation of the PIAM part where the piam_variable comes from. Use B = Brick, C = MAGICC, M = MAgPIE, R = REMIND, S = SDP postprocessing, T = EDGE-Transport. This column is used to select the variables passed to remind2 and coupling tests. If the variable is not normally reported, add a small x after the model abbreviation for it to be skipped.

Additionally, some mappings use those columns:

idx: serial number of variable
Tier: importance of variable. 1 means most important
Comment: place for comments

To edit a mapping in R, use:

mappingdata <- getMapping("AR6")
...
write.csv2(mappingdata, "test.csv", na = "", row.names = FALSE, quote = FALSE)

Opening the csv files in Excel can be problematic, as it sometimes changes values and quotation marks. You can edit the files in LibreOffice Calc using these settings in the Text Import dialog:

Text Import with:
- Character set: Unicode (UTF-8)
- Separated by: Semicolon.
Save with:
- Character set: Unicode (UTF-8)
- Field Delimiter: ;
- String Delimiter: (none)

The github diff on a large semicolon-separated file is often unreadable. For a human-readable output, save the old version of the mapping and run:

remind2::compareScenConf(fileList = c("oldfile.csv", "mappingfile.csv"), row.names = NULL)

Model intercomparison

To compare the results of different models, pass as modeldata a quitte object or a csv/xlsx file. You get a PDF document for each scenario and each model with area plots for all the summation groups in AR6 (or NAVIGATE) summation files plus line plots for each variable in the lineplotVariables vector you supplied. It takes some time, better use a slurm job for:
```
plotIntercomparison(modeldata, summationsFile = "AR6", lineplotVariables = c("Temperature|Global Mean", "Population"))
```
If your modeldata is not well filtered such that for example model regions are not too different, you can use interactive = TRUE which allows to select models, regions, scenarios and variables that you like in your PDF. As lineplotVariables, you can also specify mapping names.
```
plotIntercomparison(modeldata, summationsFile = "AR6", lineplotVariables = c("AR6", "AR6_NGFS"), interactive = TRUE)
```

Installation

For installation of the most recent package version an additional repository has to be added in R:

options(repos = c(CRAN = "@CRAN@", pik = "https://rse.pik-potsdam.de/r/packages"))

The additional repository can be made available permanently by adding the line above to a file called .Rprofile stored in the home folder of your system (Sys.glob("~") in R returns the home directory).

After that the most recent version of the package can be installed using install.packages:

install.packages("piamInterfaces")

Package updates can be installed using update.packages (make sure that the additional repository has been added before running that command):

update.packages()

Questions / Problems

In case of questions / problems please contact Falk Benke [email protected].

Citation

To cite package piamInterfaces in publications use:

Benke F, Richters O (2024). piamInterfaces: Project specific interfaces to REMIND / MAgPIE. R package version 0.18.7, <URL: https://github.com/pik-piam/piamInterfaces>.

A BibTeX entry for LaTeX users is

@Manual{,
 title = {piamInterfaces: Project specific interfaces to REMIND / MAgPIE},
 author = {Falk Benke and Oliver Richters},
 year = {2024},
 note = {R package version 0.18.7},
 url = {https://github.com/pik-piam/piamInterfaces},
}

	851;2;energy (final);Final Energy\|Transportation\|LDV\|Electricity;EJ/yr;FE\|Transport\|LDV\|Electricity;EJ/yr;;;;final energy consumption of electricity (including on-site solar PV), excluding transmission/distribution losses in the transportation sector by LDV;
	852;2;energy (final);Final Energy\|Transportation\|LDV\|Gases;EJ/yr;FE\|Transport\|LDV\|Gases;EJ/yr;;;;final energy consumption of gases (natural gas, biogas, coal-gas), excluding transmission/distribution losses in the transportation sector by LDV;
	853;2;energy (final);Final Energy\|Transportation\|LDV\|Hydrogen;EJ/yr;FE\|Transport\|LDV\|Hydrogen;EJ/yr;;;;;
	854;2;energy (final);Final Energy\|Transportation\|LDV\|Liquids;EJ/yr;FE\|Transport\|LDV\|Liquids;EJ/yr;;;;;

parent	child
Primary Energy	Primary Energy\|non-Fossil
Primary Energy	Primary Energy\|Fossil

Primary Energy\|Fossil	Primary Energy\|Coal
Primary Energy\|Fossil	Primary Energy\|Gas
Primary Energy\|Fossil	Primary Energy\|Oil

	Emissions\|Kyoto Gases 2;Emissions\|F-Gases;1
	Emissions\|Kyoto Gases 2;Emissions\|N2O;0.265
	Emissions\|Kyoto Gases 2;Emissions\|CH4;28
	Emissions\|Kyoto Gases 2;Emissions\|CO2;1

	mip::showAreaAndBarPlots(plotdata, intersect(childs, unique(plotdata$variable)), tot = p,
	mainReg = "World", yearsBarPlot = c(2030, 2050), scales = "fixed")

pik-piam / piaminterfaces Goto Github PK

piaminterfaces's Introduction

Project specific interfaces to REMIND / MAgPIE

Purpose and Functionality

Tutorial

Mappings

Model intercomparison

Installation

Questions / Problems

Citation

piaminterfaces's People

Contributors

Watchers

Forkers

piaminterfaces's Issues

Useful code:

Issue:

Request:

Application:

Emissions|N2O

N2O in NAVIGATE template:

N2O in AR6 template:

Emissions|CH4

CH4 in NAVIGATE template:

CH4 in AR6 template:

Issue:

Reproduction:

Recommend Projects

Recommend Topics

Recommend Org