R/zchunk_L261.carbon_storage_korea.R

In rohmin9122/gcam-korea-release: Build the GCAM-Korea Input Datasets

#' module_gcam.korea_L261.carbon_storage_korea
#'
#' Generates gcam-korea input files of carbon storage resource supply curves, shareweights, technology coefficients and costs, and other carbon storage information.
#'
#' @param command API command to execute
#' @param ... other optional parameters, depending on command
#' @return Depends on \code{command}: either a vector of required inputs,
#' a vector of output names, or (if \code{command} is "MAKE") all
#' the generated outputs: \code{L261.DeleteDepRsrc_USAC_korea}, \code{L261.DeleteSubsector_USAC_korea}, \code{L261.DepRsrc_FERC_korea}, \code{L261.DepRsrcCurves_FERC_korea}, \code{L261.Supplysector_C_korea},
#' \code{L261.SubsectorLogit_C_korea}, \code{L261.SubsectorShrwtFllt_C_korea}, \code{L261.StubTech_C_korea}, \code{L261.StubTechMarket_C_korea}. The corresponding file in the
#' original data system was \code{L261.carbon_storage.R} (gcam-korea level2).
#' @details This chunk generates input files of carbon storage resource supply curves by the grid regions, and input files of logit, shareweights, and
#' technology information of carbon storage by the US states.
#' @importFrom assertthat assert_that
#' @importFrom dplyr filter mutate select
#' @importFrom tidyr gather spread
#' @author M. Roh
module_gcam.korea_L261.carbon_storage_korea <- function(command, ...) {
  if(command == driver.DECLARE_INPUTS) {
    return(c(FILE = "gcam-korea/states_subregions",
             "L161.Cstorage_korea",
             "L261.DepRsrc",
             "L261.Supplysector_C",
             "L261.SubsectorLogit_C",
             "L261.SubsectorShrwtFllt_C",
             "L261.StubTech_C",
             "L261.GlobalTechCoef_C"))
  } else if(command == driver.DECLARE_OUTPUTS) {
    return(c("L261.DeleteDepRsrc_USAC_korea",
             "L261.DeleteSubsector_USAC_korea",
             "L261.DepRsrc_FERC_korea",
             "L261.DepRsrcCurves_FERC_korea",
             "L261.Supplysector_C_korea",
             "L261.SubsectorLogit_C_korea",
             "L261.SubsectorShrwtFllt_C_korea",
             "L261.StubTech_C_korea",
             "L261.StubTechMarket_C_korea"))
  } else if(command == driver.MAKE) {

    all_data <- list(...)[[1]]

    region <- state <- stub.technology <- subresource <- subsector <- grid_region <- market.name <- minicam.energy.input <-
      Cost_1990USDtC <- MtC <- available <- coefficient <- depresource <- extractioncost <- grade <-  NULL # Silence package notes

    # Load required inputs
    states_subregions <- get_data(all_data, "gcam-korea/states_subregions")
    L161.Cstorage_korea <- get_data(all_data, "L161.Cstorage_korea")
    L261.DepRsrc <- get_data(all_data, "L261.DepRsrc")
    L261.Supplysector_C <- get_data(all_data, "L261.Supplysector_C")
    L261.SubsectorLogit_C <- get_data(all_data, "L261.SubsectorLogit_C")
    L261.SubsectorShrwtFllt_C <- get_data(all_data, "L261.SubsectorShrwtFllt_C")
    L261.StubTech_C <- get_data(all_data, "L261.StubTech_C")
    L261.GlobalTechCoef_C <- get_data(all_data, "L261.GlobalTechCoef_C")

    # Create a vector of FERC grid regions with non-zero storage curves
    # Will use this list to filter out FERC grid regions with zero storage below
    L161.Cstorage_korea %>%
      select(grid_region) %>%
      unique %>%
      arrange %>%
      unlist ->
      C_grid_regions

    # Create a vector of FERC grid regions with zero storage curve
    # States in these grid regions will be excluded from the onshare carbon storage subsector in the relevant input files below
    states_subregions %>%
      select(grid_region) %>%
      filter(!grid_region %in% C_grid_regions) %>%
      unique %>%
      unlist ->
      noC_grid_regions

    # L261.DeleteDepRsrc_USAC_korea: delete onshore carbon storage in the USA region
    # Carbon storage onshore resources are modeled at the grid level
    L261.DepRsrc %>%
      mutate(region = region) %>% # strip off attributes like title, etc.
      filter(region == gcamkorea.REGION) %>%
      select(region, depresource) ->
      L261.DeleteDepRsrc_USAC_korea

    # L261.DeleteSubsector_USAC_korea: delete onshore carbon storage subsector of carbon storage sector in the USA region
    # NOTE: leaving the offshore here so that the USA hydrogen sector has a carbon storage market
    L261.SubsectorShrwtFllt_C %>%
      mutate(region = region) %>% # strip off attributes like title, etc.
      filter(region == gcamkorea.REGION) %>%
      semi_join(L261.DepRsrc, by = c("subsector" = "depresource")) %>%
      select(one_of(c(LEVEL2_DATA_NAMES[["Subsector"]]))) ->
      L261.DeleteSubsector_USAC_korea

    # Create a vector of grid level onshare carbon storage subsector with zero storage curve
    # States in these grid regions will be excluded from the onshare carbon storage subsector in the relevant input files below
    grid_Cstorage_nonexist <- paste(noC_grid_regions, L261.DeleteDepRsrc_USAC_korea$depresource[1])

    # L261.DepRsrc_FERC_korea: onshore storage in the FERC regions
    L261.DepRsrc %>%
      filter(region == gcamkorea.REGION) %>%
      select(-region) %>%
      # Onshore storage only in the FERC regions with non-zero storage curves
      repeat_add_columns(tibble(region = C_grid_regions)) %>%
      mutate(market = region) ->
      L261.DepRsrc_FERC_korea

   # L261.DepRsrcCurves_FERC_korea: onshore storage supply curves in the FERC regions
    L161.Cstorage_korea %>%
      mutate(region = grid_region,
             depresource = L261.DepRsrc_FERC_korea$depresource[1],
             subresource = L261.DepRsrc_FERC_korea$depresource[1],
             available = round(MtC, digits = gcamkorea.DIGITS_DEPRESOURCE),
             extractioncost = round(Cost_1990USDtC, digits = gcamkorea.DIGITS_COST)) %>%
      select(region, depresource, subresource, grade, available, extractioncost) ->
      L261.DepRsrcCurves_FERC_korea

    # L261.Supplysector_C_korea: supplysector information in the states
    L261.Supplysector_C %>%
      filter(region == gcamkorea.REGION) %>%
      write_to_all_states(c(LEVEL2_DATA_NAMES[["Supplysector"]], LOGIT_TYPE_COLNAME), region_states=gcamkorea.STATES) ->
      L261.Supplysector_C_korea

    # L261.SubsectorLogit_C_korea: subsector logit information in the states
    L261.SubsectorLogit_C %>%
      filter(region == gcamkorea.REGION) %>%
      write_to_all_states(c(LEVEL2_DATA_NAMES[["SubsectorLogit"]], LOGIT_TYPE_COLNAME), region_states=gcamkorea.STATES) %>%
      left_join_error_no_match(select(states_subregions, state, grid_region), by = c("region" = "state")) %>%
      # Drop the states where no carbon storage resources may exist at the grid level
      filter(!paste(grid_region, subsector) %in% grid_Cstorage_nonexist) ->
      L261.SubsectorLogit_C_korea

    # L261.SubsectorShrwtFllt_C_korea: subsector shareweight information in the states
    L261.SubsectorShrwtFllt_C %>%
      filter(region == gcamkorea.REGION) %>%
      write_to_all_states(c(LEVEL2_DATA_NAMES[["SubsectorShrwtFllt"]]), region_states=gcamkorea.STATES) %>%
      left_join_error_no_match(select(states_subregions, state, grid_region), by = c("region" = "state")) %>%
      # Drop the states where no carbon storage resources may exist at the grid level
      filter(!paste(grid_region, subsector) %in% grid_Cstorage_nonexist) ->
      L261.SubsectorShrwtFllt_C_korea

    # L261.StubTech_C_korea: stub technology information for the states
    L261.StubTech_C %>%
      filter(region == gcamkorea.REGION) %>%
      write_to_all_states(c(LEVEL2_DATA_NAMES[["StubTech"]]), region_states=gcamkorea.STATES) %>%
      left_join_error_no_match(select(states_subregions, state, grid_region), by = c("region" = "state")) %>%
      # Drop the states where no carbon storage resources may exist at the grid level
      filter(!paste(grid_region, stub.technology) %in% grid_Cstorage_nonexist) %>%
      select(one_of(c(LEVEL2_DATA_NAMES[["StubTech"]])))->
      L261.StubTech_C_korea

    # L261.StubTechMarket_C_korea: stub technology market information for the states
    L261.StubTech_C_korea %>%
      repeat_add_columns(tibble(year = MODEL_YEARS)) %>%
      left_join_error_no_match(select(L261.GlobalTechCoef_C, -coefficient),
                               by = c("supplysector" = "sector.name", "subsector" = "subsector.name", "stub.technology" = "technology", "year")) %>%
      # Use the grid region markets
      left_join_error_no_match(select(states_subregions, state, market.name = grid_region), by = c("region" = "state")) %>%
      # Replace offshore carbon storage with the USA market
      mutate(market.name = replace(market.name, !minicam.energy.input %in% L261.DepRsrc_FERC_korea$depresource, gcamkorea.REGION)) ->
      L261.StubTechMarket_C_korea

    # Produce outputs
    L261.DeleteDepRsrc_USAC_korea %>%
      add_title("Delete onshore carbon storage in the USA region") %>%
      add_units("NA") %>%
      add_comments("Carbon storage onshore resources are modeled by grid regions") %>%
      add_legacy_name("L261.DeleteDepRsrc_USAC_korea") %>%
      add_precursors("L261.DepRsrc") ->
      L261.DeleteDepRsrc_USAC_korea

    L261.DeleteSubsector_USAC_korea %>%
      add_title("Delete onshore carbon storage subsector of carbon storage sector in the USA region") %>%
      add_units("NA") %>%
      add_comments("Keep the offshore here so that the USA hydrogen sector has a carbon storage market") %>%
      add_legacy_name("L261.DeleteSubsector_USAC_korea") %>%
      add_precursors("L261.SubsectorShrwtFllt_C",
                     "L261.DepRsrc") ->
      L261.DeleteSubsector_USAC_korea

    L261.DepRsrc_FERC_korea %>%
      add_title("Onshore storage in the FERC regions") %>%
      add_units("NA") %>%
      add_comments("Onshore storage are modeled only in the FERC regions with non-zero storage curves") %>%
      add_comments("can be multiple lines") %>%
      add_legacy_name("L261.DepRsrc_FERC_korea") %>%
      add_precursors("L161.Cstorage_korea",
                     "L261.DepRsrc") ->
      L261.DepRsrc_FERC_korea

    L261.DepRsrcCurves_FERC_korea %>%
      add_title("Onshore storage supply curves in the FERC regions") %>%
      add_units("MtC and 1990USDtC") %>%
      add_comments("Onshore carbon storage availability and extraction costs in each FERC region") %>%
      add_legacy_name("L261.DepRsrcCurves_FERC_korea") %>%
      add_precursors("L161.Cstorage_korea") %>%
      same_precursors_as("L261.DepRsrc_FERC_korea") ->
      L261.DepRsrcCurves_FERC_korea

    L261.Supplysector_C_korea %>%
      add_title("Supplysector information in the US states") %>%
      add_units("Unitless") %>%
      add_comments("The same USA region values are repeated for each state") %>%
      add_legacy_name("L261.Supplysector_C_korea") %>%
      add_precursors("L261.Supplysector_C") ->
      L261.Supplysector_C_korea

    L261.SubsectorLogit_C_korea %>%
      add_title("Subsector logit information in the states") %>%
      add_units("Unitless") %>%
      add_comments("The same USA region values are repeated for each state") %>%
      add_comments("States where no carbon storage resources may exist at the grid level are dropped") %>%
      add_legacy_name("L261.SubsectorLogit_C_korea") %>%
      add_precursors("L161.Cstorage_korea",
                     "gcam-korea/states_subregions",
                     "L261.SubsectorLogit_C") ->
      L261.SubsectorLogit_C_korea

    L261.SubsectorShrwtFllt_C_korea %>%
      add_title("Subsector shareweight information in the states") %>%
      add_units("Unitless") %>%
      add_comments("The same USA region values are repeated for each state") %>%
      add_comments("States where no carbon storage resources may exist at the grid level are dropped") %>%
      add_legacy_name("L261.SubsectorShrwtFllt_C_korea") %>%
      add_precursors("L161.Cstorage_korea",
                     "gcam-korea/states_subregions",
                     "L261.SubsectorShrwtFllt_C") ->
      L261.SubsectorShrwtFllt_C_korea

    L261.StubTech_C_korea %>%
      add_title("Stub technology information for the states") %>%
      add_units("Unitless") %>%
      add_comments("The same USA region values are repeated for each state") %>%
      add_comments("States where no carbon storage resources may exist at the grid level are dropped") %>%
      add_legacy_name("L261.StubTech_C_korea") %>%
      add_precursors("L161.Cstorage_korea",
                     "gcam-korea/states_subregions",
                     "L261.StubTech_C") ->
      L261.StubTech_C_korea

    L261.StubTechMarket_C_korea %>%
      add_title("Stub technology market information for the states") %>%
      add_units("Unitless") %>%
      add_comments("Onshore carbon storage is from the grid region markets") %>%
      add_comments("Offshore carbon storage is from the USA market") %>%
      add_legacy_name("L261.StubTechMarket_C_korea") %>%
      add_precursors("L261.GlobalTechCoef_C",
                     "L261.DepRsrc_FERC_korea") %>%
      same_precursors_as("L261.StubTech_C_korea") ->
      L261.StubTechMarket_C_korea

    return_data(L261.DeleteDepRsrc_USAC_korea, L261.DeleteSubsector_USAC_korea, L261.DepRsrc_FERC_korea,
                L261.DepRsrcCurves_FERC_korea, L261.Supplysector_C_korea, L261.SubsectorLogit_C_korea,
                L261.SubsectorShrwtFllt_C_korea, L261.StubTech_C_korea, L261.StubTechMarket_C_korea)
  } else {
    stop("Unknown command")
  }
}