Package 'remindClimateAssessment'

Append Climate Assessment Data to MIF File

Description

This function appends climate assessment data to a MIF (Model Intercomparison Framework) file. It removes data from old MAGICC7 runs to avoid duplication and then writes the updated data back to the MIF file.

Usage

appendClimateAssessmentToMif(qf, mif)

Arguments

qf	'quitte' data frame containing the climate assessment data to be appended
mif	File path to the MIF to which the data will be appended

Value

The function returns the result of writing the updated data to the MIF file.

---

Archive Climate Assessment Data

Description

Archives climate assessment data by copying all *.csv/*.xlsx from climate diretory (and, if specified, extra files) to a temporary directory, then tar'ing and gzip'ing the temporary directory & deleting it afterwards

Usage

archiveClimateAssessmentData(
  climateDir,
  climateArchiveDir = NULL,
  suffix = "",
  extraFiles = c(),
  returnFn = TRUE
)

Arguments

climateDir	Base directory containing climate assessment data
climateArchiveDir	Directory where the climate assessment data will be archived. Default is NULL, in which case a new 'archive' subdir is created in the climate directory. Note: This directory is NOT deleted after archiving, only the temporary directory created within it is
suffix	String appended to the file name. Can be used to identify the climate assessment run mode (i.e. 'report', 'iteration', 'impulse') in the archive file name. Defaults to empty string
extraFiles	Character vector of additional file paths to include in the archive. Default is an empty vector
returnFn	A logical value indicating whether to return the path to the tar file. Defaults to TRUE

Value

If returnFn is TRUE, the function returns the path to the tar file. Otherwise, it returns invisible()

Author(s)

Tonn Rüter

Examples

## Not run: 
cfg <- climateAssessmentConfig("<outputDir>", "iteration")
extraFiles <- c("pm_globalMeanTemperature", "p15_forc_magicc")
archiveClimateAssessmentData(cfg$climateArchiveDir, extraFiles)

## End(Not run)

---

Something

Description

Something

Usage

dumpToGDX(
  assessmentData,
  exportConf,
  interpolateYears = NULL,
  logFile = NULL,
  verbose = NULL
)

Arguments

assessmentData	Data frame as produced by climate-assessment
exportConf	Associates climate assessment variables with the GDX file names and their GAMS counterpart
interpolateYears	In case the periods in the emission report do not match the one reported by climate assessment, we need to interpolate to be able to integrate them with existing GAMS data
logFile	Path to the log file. Default is NULL
verbose	Determines logging level. If set to TRUE, log messages are printed to std out

Author(s)

Tonn Rüter

Examples

## Not run: 
# Generates REMIND emission report, extracts relevant variables and reshapes. Note: This funtion
can be used in a tidyverse pipeline.
emissionDataForClimateAssessment(
  remind2::reportEmi(fulldata.gdx),
  scenarioName = "SSP2EU-NPi-ar6",
  climateAssessmentYaml = file.path(
    system.file(package = "piamInterfaces"), "iiasaTemplates", "climate_assessment_variables.yaml"
  )
  logFile = "output/missing.log"
)

## End(Not run)

---

Clean Up Climate Assessment Data

Description

This function cleans up climate assessment data by filtering for specific periods, interpolating missing periods, and renaming variables from MAGICC7 to REMIND naming convention

Usage

cleanUpClimateAssessment(qf, periods)

Arguments

qf	A 'quitte' object containing the climate assessment data to be cleaned
periods	Vector periods (years) to be considered

Value

A cleaned 'quitte' object with filtered periods, interpolated missing periods, and renamed variables

---

Configure Climate Assessment

Description

Collects all necessary files and directories to set up climate assessment run from a REMIND output directory

Usage

climateAssessmentConfig(outputDir, mode)

Arguments

outputDir	A REMIND output directory
mode	Determines which probabiliy files is used. Must be either "report", "iteration" or "impulse"

Value

A list containing the configuration settings for the climate assessment

Examples

## Not run: 
climateAssessmentConfig("<outputDir>", "iteration") # yields
list(
  outputDir  = "/p/tmp/tonnru/remind/output/h_cpol_KLW_d50_2025-02-06_18.10.48",
  scenario   = "h_cpol_KLW_d50",
  condaEnv   = "/p/projects/rd3mod/python/environments/scm_magicc7_hpc",
  isArchived = FALSE,
  logFile    = "<outputDir>/log_climate.txt",
  workersDir = "<outputDir>/climate-assessment-data/workers",
  climateDir = "<outputDir>/climate-assessment-data",
  archiveDir = "",
  scriptsDir = "<Depending on your installation>",
  magiccBin  = "<Depending on your installation>",
  variablesFile = "<Depending on piamInterfaces>",
  infillingDatabase = "<Depending on your REMIND default.cfg>",
  probabilisticFile = "<Depending on your REMIND default.cfg>",
  nSets             = "<Depending on your REMIND probabilisticFile>",
  ...
)

## End(Not run)

---

assessmentDataToGDX

Description

Something

Usage

dumpToGdx(relevantData, fileName, variables)

Arguments

relevantData	FOO
fileName	BAR
variables	BAZ

Author(s)

Tonn Rüter

Examples

## Not run: 
# Generates REMIND emission report, extracts relevant variables and reshapes. Note: This funtion
can be used in a tidyverse pipeline.
emissionDataForClimateAssessment(
  remind2::reportEmi(fulldata.gdx),
  scenarioName = "SSP2EU-NPi-ar6",
  climateAssessmentYaml = file.path(
    system.file(package = "piamInterfaces"), "iiasaTemplates", "climate_assessment_variables.yaml"
  )
  logFile = "output/missing.log"
)

## End(Not run)

---

emissionDataForClimateAssessment

Description

Converts remind emission data from long to wide format suitable for climate assessment. Only considers regions "GLO" and "World" and extracts only the variables needed for climate assessment. Per default these are provided from the AR6 mapping in the piamInterfaces package. The resulting data frame has one column for each year and one row for each variable. For more information visit https://pyam-iamc.readthedocs.io/en/stable/data.html

Usage

emissionDataForClimateAssessment(
  qf,
  scenario,
  mapping = "AR6",
  variablesFile = NULL,
  logFile = NULL
)

Arguments

qf	quitte data frame containing the emission data
scenario	Name of the scenario
mapping	Name of the mapping file from the piamInterfaces library, must be 'AR6', 'climateassessment', 'NGFS_AR6' or 'AR6_MAgPIE'. Defaults to 'AR6'
variablesFile	Path to the yaml file containing the variables needed for climate-assessment. If no file path is provided, the function gets the yaml file from the piamInterfaces package
logFile	Path to the log file. Default is "output/missing.log"

Value

quitte data frame with the REMIND emission data reshaped for climate assessment

Author(s)

Tonn Rüter

Examples

## Not run: 
# Generates REMIND emission report, extracts relevant variables and reshapes. Note: This funtion
can be used in a tidyverse pipeline.
emissionDataForClimateAssessment(
  remind2::reportEmi(fulldata.gdx),
  scenarioName = "SSP2EU-NPi-ar6",
  climateAssessmentYaml = file.path(
    system.file(package = "piamInterfaces"), "iiasaTemplates", "climate_assessment_variables.yaml"
  )
  logFile = "output/missing.log"
)

## End(Not run)

---

emissionImpulseSenarios

Description

Geenerates emission impulse scenarios from a harmonized and infilled emissions data by repeating the unperturbed scenario as baseline and concatenating perturbed scenarios. Each scenario adds a specified quantity of additional emissions to the spcified emission variable in the given time periods. The periods of the original data frame can be extended to observe long term effects in the climate emulation

Usage

emissionImpulseSenarios(
  qf,
  var = "AR6 climate diagnostics|Infilled|Emissions|CO2|Energy and Industrial Processes",
  impulse = 3660,
  periods = c(2020, 2030, 2040, 2050, 2060, 2070, 2080, 2090, 2100, 2110, 2130),
  endYear = 2200,
  inbetween = 1
)

Arguments

qf	quitte data frame containing the emission data from a single emission scenario
var	Name of the variable to be perturbed
impulse	Amount of additional emissions. Defaults to 3.66e2, CO2 equivalent in Mt to 1 GtC
periods	Periods in which to add the emissions impulse. Defaults to c(2020, 2030, ..., 2110, 2130)
endYear	Extends the original observation periods. Defaults to 2200
inbetween	Duration of the extended observation periods in years. Defaults to 1

Value

quitte data frame containing all data for the emission impulse scenarios

Author(s)

Tonn Rüter

Examples

## Not run: 
impulses <- read.quitte(cfg$harmInfEmissionsFile) %>%
  emissionImpulseSenarios() %>%
  write_csv(cfg$emissionsImpulseFile, quote = "none")

## End(Not run)

---

exportConfFromYaml

Description

Read yaml export configuration. It determines which variables to extract from the MAGICC7 climate assessment data & to which file they are supposed to be written. Resulting data frame contains magicc7Variable, gamsVariable and fileName columns.

Usage

exportConfFromYaml(yamlFileName = "default.yaml")

Arguments

yamlFileName

Location of the configuration file. Default is 'which_var_in_which_file.yaml'

Value

A tibble data frame containing the association between climate assessment and gams variable names

Author(s)

Tonn Rüter

---

renameVariableMagicc7ToRemind

Description

Substitutes parts of MAGICC7 variable names to create REMIND compatible variable names

Usage

renameVariableMagicc7ToRemind(varName)

Arguments

varName

Variable to be renamed

Value

Renamed variable

Author(s)

Tonn Rüter

---

renameVariableRemindToMagicc7

Description

Renames climate assessment variables given in the REMIND convetion MAGICC7 compatible variable names

Usage

renameVariableRemindToMagicc7(varName, magiccVersion = "7.5.3")

Arguments

varName	Variable to be renamed
magiccVersion	Version string of the MAGICC model in use. Default is "7.5.3"

Value

Renamed variable

Author(s)

Tonn Rüter

---

Report climate assessment configuration

Description

Returns a string represenatation of a climate assessment configuration

Usage

reportClimateAssessmentConfig(cfg)

Arguments

cfg	Path to default.cfg file

Value

A string detailing the configuration settings.

Examples

## Not run: 
cfg <- climateAssessmentConfig("<outputDir>", "iteration")
report <- reportClimateAssessmentConfig(cfg)
cat(report)

## End(Not run)

---

Generate a report of run times.

Description

This function takes a named vector of run times and generates a formatted report showing the duration of each run. The names of the run times must follow the pattern 'task_id_1 start' and 'task_id_1 end', where 'task_id_1' can be any string identifier.

Usage

runTimeReport(runTimes, prefix = "")

Arguments

runTimes	A named vector of run times
prefix	A string to prefix each line of the report. Default is "".

Value

A formatted string showing the duration of each run.

Examples

## Not run: 
# Typical usage: Set up as empty vector
runTimes <- c()
# [... run set up ...]
runTimes <- c("task1 start" = Sys.time())
# [... run task1 ...]
runTimes <- c("task1 end" = Sys.time())
# [... something untimed in between ...]
runTimes <- c("task2 start" = Sys.time())
# [... run task2 ...]
runTimes <- c("task2 end" = Sys.time())
runTimeReport(runTimes)

## End(Not run)

---