moinput: Model Operations Input Data Library

#' @importFrom dplyr %>%
#' @importFrom quitte inline.data.frame


calcFE <- function(source = "IEA", scenario_proj = "SSP2") {
  
  #------ READ-IN DATA----------------------------------------
  if (source == "IEA"){
    
    data <- calcOutput("IO", subtype = "output", aggregate = FALSE)
    
    #remove period where only 0s appear
    data <- data[,2016,, invert = T]
  } else if (source == "EDGE_projections") {
    
    data <- calcOutput("FEdemand", subtype = "FE", aggregate = FALSE)
    data <- data[,,paste0("gdp_",scenario_proj)]
    data <- collapseNames(data)
    
  } else {
    
    stop ("source of calcFE should be either IEA or EDGE_projections")
  }
  
  #------ PARAMETERS / MAPPINGS ------------------------------------------
  
  if (source == "IEA"){
    
    mapping <- toolMappingFile("sectoral","structuremappingIO_reporting.csv")
    target = c("output")
    map <- read.csv2(mapping, stringsAsFactors = FALSE, na.strings ="" )
    #delete NAs rows
    map = map[c("io",target)] %>% na.omit()
    
    #Change the column name of the mapping
    colnames(map) = gsub("io","names_in", colnames(map))
    
    # Give description
    descript = "IEA Final Energy Data based on 2017 version of IEA Energy Balances"
    
  } else if (source == "EDGE_projections") {
    
    map = inline.data.frame(
      "names_in; output",
      "fesob;FE|Buildings|Solids",
      "fegab;FE|Buildings|Gases",
      "fehob;FE|Buildings|Liquids",
      "feheb;FE|Buildings|Heat",
      "feelb;FE|Buildings|Electricity",
      #"feh2b;FE|Buildings|Hydrogen",
      
      "fesoi;FE|Industry|Solids",
      "fegai;FE|Industry|Gases",
      "fehoi;FE|Industry|Liquids",
      "fehei;FE|Industry|Heat",
      "feeli;FE|Industry|Electricity",
      "feh2i;FE|Industry|Hydrogen",
      
      #The transport variables are based on the CES partition, because EDGE projections
      # are designed for the CES. However, the ESM, on which the FE reporting is based (remind::reportFE)
      # has a different partition of FE than the ESM. We therefore do not expect a full match
      
      "ueelTt;FE|Transport|Electricity",
      "ueHDVt;FE|Transport|Liquids|Petrol", #These variables are summed up below. The exact correspondence is not important
      "ueLDVt;FE|Transport|Liquids|Diesel"  #These variables are summed up below. The exact correspondence is not important
      
    )
    
    # Give description
    descript = "EDGE FE projections"
  }
  
  #------ PROCESS DATA ------------------------------------------
 
  # select data that have names
  x <- data[,,map$names_in]
  # rename entries of data to match the rporting names
  getNames(x) <- paste0(map$output," (EJ/yr)")
  
  if (source == "IEA"){
     # aggregate CHP and nonCHP electricity
     x <- mbind(x,setNames(x[,,"SE|Electricity|Coal|CHP (EJ/yr)"] + x[,,"SE|Electricity|Coal|nonCHP (EJ/yr)"],"SE|Electricity|Coal (EJ/yr)"))
     x <- mbind(x,setNames(x[,,"SE|Electricity|Gas|CHP (EJ/yr)"] + x[,,"SE|Electricity|Gas|nonCHP (EJ/yr)"],"SE|Electricity|Gas (EJ/yr)"))
     x <- mbind(x,setNames(x[,,"SE|Electricity|Biomass|CHP (EJ/yr)"] + x[,,"SE|Electricity|Biomass|nonCHP (EJ/yr)"],"SE|Electricity|Biomass (EJ/yr)"))
     # aggregate CHP and HP heat
     x <- mbind(x,setNames(x[,,"SE|Heat|Coal|CHP (EJ/yr)"] + x[,,"SE|Heat|Coal|HP (EJ/yr)"],"SE|Heat|Coal (EJ/yr)"))
     x <- mbind(x,setNames(x[,,"SE|Heat|Gas|CHP (EJ/yr)"] + x[,,"SE|Heat|Gas|HP (EJ/yr)"],"SE|Heat|Gas (EJ/yr)"))
     x <- mbind(x,setNames(x[,,"SE|Heat|Biomass|CHP (EJ/yr)"] + x[,,"SE|Heat|Biomass|HP (EJ/yr)"],"SE|Heat|Biomass (EJ/yr)"))
     # aggregate transport diesel and petrol to liquids
     x <- mbind(x,setNames(x[,,"FE|Transport|Liquids|Diesel|Biomass (EJ/yr)"] + x[,,"FE|Transport|Liquids|Diesel|Fossil (EJ/yr)"] + x[,,"FE|Transport|Liquids|Petrol|Biomass (EJ/yr)"] + x[,,"FE|Transport|Liquids|Petrol|Fossil (EJ/yr)"],"FE|Transport|Liquids (EJ/yr)"))
     x <- x[,,c("FE|Transport|Liquids|Diesel|Biomass (EJ/yr)","FE|Transport|Liquids|Diesel|Fossil (EJ/yr)","FE|Transport|Liquids|Petrol|Biomass (EJ/yr)","FE|Transport|Liquids|Petrol|Fossil (EJ/yr)"),invert=TRUE]
     # aggregate biomass and fossil data
     x <- mbind(x,setNames(x[,,"FE|Buildings|Gases|Biomass (EJ/yr)"] + x[,,"FE|Buildings|Gases|Fossil (EJ/yr)"],"FE|Buildings|Gases (EJ/yr)"))
     x <- x[,,c("FE|Buildings|Gases|Biomass (EJ/yr)","FE|Buildings|Gases|Fossil (EJ/yr)"),invert=TRUE]
     x <- mbind(x,setNames(x[,,"FE|Industry|Gases|Biomass (EJ/yr)"] + x[,,"FE|Industry|Gases|Fossil (EJ/yr)"],"FE|Industry|Gases (EJ/yr)"))
     x <- x[,,c("FE|Industry|Gases|Biomass (EJ/yr)","FE|Industry|Gases|Fossil (EJ/yr)"),invert=TRUE]
     x <- mbind(x,setNames(x[,,"FE|Transport|Gases|Biomass (EJ/yr)"] + x[,,"FE|Transport|Gases|Fossil (EJ/yr)"],"FE|Transport|Gases (EJ/yr)"))
     x <- x[,,c("FE|Transport|Gases|Biomass (EJ/yr)","FE|Transport|Gases|Fossil (EJ/yr)"),invert=TRUE]
     
     x <- mbind(x,setNames(x[,,"FE|Buildings|Liquids|Biomass (EJ/yr)"] + x[,,"FE|Buildings|Liquids|Fossil (EJ/yr)"],"FE|Buildings|Liquids (EJ/yr)"))
     x <- x[,,c("FE|Buildings|Liquids|Biomass (EJ/yr)","FE|Buildings|Liquids|Fossil (EJ/yr)"),invert=TRUE]
     x <- mbind(x,setNames(x[,,"FE|Industry|Liquids|Biomass (EJ/yr)"] + x[,,"FE|Industry|Liquids|Fossil (EJ/yr)"],"FE|Industry|Liquids (EJ/yr)"))
     x <- x[,,c("FE|Industry|Liquids|Biomass (EJ/yr)","FE|Industry|Liquids|Fossil (EJ/yr)"),invert=TRUE]
     
     x <- mbind(x,setNames(x[,,"FE|Buildings|Solids|Biomass (EJ/yr)"] + x[,,"FE|Buildings|Solids|Fossil (EJ/yr)"],"FE|Buildings|Solids (EJ/yr)"))
     x <- x[,,c("FE|Buildings|Solids|Biomass (EJ/yr)","FE|Buildings|Solids|Fossil (EJ/yr)"),invert=TRUE]
     x <- mbind(x,setNames(x[,,"FE|Industry|Solids|Biomass (EJ/yr)"] + x[,,"FE|Industry|Solids|Fossil (EJ/yr)"],"FE|Industry|Solids (EJ/yr)"))
     x <- x[,,c("FE|Industry|Solids|Biomass (EJ/yr)","FE|Industry|Solids|Fossil (EJ/yr)"),invert=TRUE]
     
  } else if (source == "EDGE_projections") {
    # aggregate diesel and petrol to liquids
    x <- mbind(x,setNames(x[,,"FE|Transport|Liquids|Diesel (EJ/yr)"] + x[,,"FE|Transport|Liquids|Petrol (EJ/yr)"],"FE|Transport|Liquids (EJ/yr)"))
    x <- x[,,c("FE|Transport|Liquids|Diesel (EJ/yr)","FE|Transport|Liquids|Petrol (EJ/yr)"),invert=TRUE]
  }
  
  # add more variables
  x <- mbind(x,setNames(dimSums(x[,,"FE|",pmatch=TRUE],dim=3),"FE (EJ/yr)"))
  x <- mbind(x,setNames(dimSums(x[,,"FE|",pmatch=TRUE][,,"Electricity",pmatch=TRUE],dim=3),"FE|Electricity (EJ/yr)"))
  x <- mbind(x,setNames(dimSums(x[,,"FE|",pmatch=TRUE][,,"Gases",pmatch=TRUE],dim=3),"FE|Gases (EJ/yr)"))
  x <- mbind(x,setNames(dimSums(x[,,"FE|",pmatch=TRUE][,,"Heat",pmatch=TRUE],dim=3),"FE|Heat (EJ/yr)"))
  x <- mbind(x,setNames(dimSums(x[,,"FE|",pmatch=TRUE][,,"Liquids",pmatch=TRUE],dim=3),"FE|Liquids (EJ/yr)"))
  x <- mbind(x,setNames(dimSums(x[,,"FE|",pmatch=TRUE][,,"Solids",pmatch=TRUE],dim=3),"FE|Solids (EJ/yr)"))
  # add stationary
  x <- mbind(x,setNames(x[,,"FE|Buildings|Electricity (EJ/yr)"] + x[,,"FE|Industry|Electricity (EJ/yr)"],"FE|Stationary|Electricity (EJ/yr)"))
  x <- mbind(x,setNames(x[,,"FE|Buildings|Gases (EJ/yr)"]       + x[,,"FE|Industry|Gases (EJ/yr)"],      "FE|Stationary|Gases (EJ/yr)"))
  x <- mbind(x,setNames(x[,,"FE|Buildings|Heat (EJ/yr)"]        + x[,,"FE|Industry|Heat (EJ/yr)"],       "FE|Stationary|Heat (EJ/yr)"))
  x <- mbind(x,setNames(x[,,"FE|Buildings|Liquids (EJ/yr)"]     + x[,,"FE|Industry|Liquids (EJ/yr)"],    "FE|Stationary|Liquids (EJ/yr)"))
  x <- mbind(x,setNames(x[,,"FE|Buildings|Solids (EJ/yr)"]      + x[,,"FE|Industry|Solids (EJ/yr)"],     "FE|Stationary|Solids (EJ/yr)"))
  # add total for builings
  x <- mbind(x,setNames(dimSums(x[,,"FE|",pmatch=TRUE][,,"Buildings",pmatch=TRUE],dim=3),"FE|Buildings (EJ/yr)"))
  # add total for industry
  x <- mbind(x,setNames(dimSums(x[,,"FE|",pmatch=TRUE][,,"Industry",pmatch=TRUE],dim=3),"FE|Industry (EJ/yr)"))
  # add total for transport
  x <- mbind(x,setNames(dimSums(x[,,"FE|",pmatch=TRUE][,,"Transport",pmatch=TRUE],dim=3),"FE|Transport (EJ/yr)"))
  
  return(list(x=x,weight=NULL,unit="EJ",
              description=descript))
}