Develop a List of GCAM Variables for Project

[ecwood]

We need a script (presumably) to create a list of all of the GCAM variables relevant to our project (for Kat - tag coming soon).

We will also want to document which variables to streamline running the GCAM scenarios later on.

[khw21]

Hi! I will take a look after this meeting :)

[ecwood]

A few questions to document:

1. If I wrote a script to dump all of the variables covered in the input/gcamdata/inst/extdata/ CSV files, would that include all of the variables we want access too?
2. Should I be looking more narrowly? (That folder includes a lot of variables that are likely out of our scope and/or well documented in literature, so less of variables and more of constants.)
3. Are there files in the input/policy or input/climate folder that I will want to build off of (i.e. with variables that I want to access) that I should also be including? (Note: those aren't built from CSV files, so we would need to EDIT those separately.)
4. Perhaps most importantly, will I need to plan to create my own XML files from scratch (i.e. not build from an example or multiple examples)? How would I come up with these variables? Would I have to program new equations into the model?

[celinasb]

Starting with the last point and moving up.

4. Let's stick to the variables that are already built into the model—they should more than suffice at this stage.
5. Let's discuss with Jill later today about how to interact with these files... We'll most likely need to edit the input/policy files but not the climate ones. 1 & 2. Let's ask Jill and/or Jevan about how we should be cataloguing variables of interest, because that's still unclear to me.

[ecwood]

Here is a revised dump of the different variable options in dac_ssp1.xml (as generated by the script from 3db1fe5, then sorted)

[
    "scenario---world---global-technology-database---location-info---sector-name",
    "scenario---world---global-technology-database---location-info---subsector-name",
    "scenario---world---global-technology-database---location-info---technology---name",
    "scenario---world---global-technology-database---location-info---technology---period---CO2---name",
    "scenario---world---global-technology-database---location-info---technology---period---lifetime",
    "scenario---world---global-technology-database---location-info---technology---period---minicam-energy-input---coefficient",
    "scenario---world---global-technology-database---location-info---technology---period---minicam-energy-input---name",
    "scenario---world---global-technology-database---location-info---technology---period---minicam-non-energy-input---input-cost",
    "scenario---world---global-technology-database---location-info---technology---period---minicam-non-energy-input---name",
    "scenario---world---global-technology-database---location-info---technology---period---profit-shutdown-decider---median-shutdown-point",
    "scenario---world---global-technology-database---location-info---technology---period---profit-shutdown-decider---name",
    "scenario---world---global-technology-database---location-info---technology---period---profit-shutdown-decider---steepness",
    "scenario---world---global-technology-database---location-info---technology---period---s-curve-shutdown-decider---half-life",
    "scenario---world---global-technology-database---location-info---technology---period---s-curve-shutdown-decider---name",
    "scenario---world---global-technology-database---location-info---technology---period---s-curve-shutdown-decider---steepness",
    "scenario---world---global-technology-database---location-info---technology---period---share-weight",
    "scenario---world---global-technology-database---location-info---technology---period---standard-capture-component---remove-fraction",
    "scenario---world---global-technology-database---location-info---technology---period---standard-capture-component---storage-market",
    "scenario---world---global-technology-database---location-info---technology---period---year",
    "scenario---world---region---PrimaryFuelCO2Coef---name",
    "scenario---world---region---PrimaryFuelCO2Coef---text",
    "scenario---world---region---energy-final-demand---base-service---text",
    "scenario---world---region---energy-final-demand---base-service---year",
    "scenario---world---region---energy-final-demand---name",
    "scenario---world---region---energy-final-demand---perCapitaBased",
    "scenario---world---region---energy-final-demand---price-elasticity---text",
    "scenario---world---region---energy-final-demand---price-elasticity---year",
    "scenario---world---region---name",
    "scenario---world---region---supplysector---input-unit",
    "scenario---world---region---supplysector---keyword---final-energy",
    "scenario---world---region---supplysector---name",
    "scenario---world---region---supplysector---output-unit",
    "scenario---world---region---supplysector---price-unit",
    "scenario---world---region---supplysector---relative-cost-logit---logit-exponent---fillout",
    "scenario---world---region---supplysector---relative-cost-logit---logit-exponent---text",
    "scenario---world---region---supplysector---relative-cost-logit---logit-exponent---year",
    "scenario---world---region---supplysector---subsector---absolute-cost-logit---logit-exponent---fillout",
    "scenario---world---region---supplysector---subsector---absolute-cost-logit---logit-exponent---text",
    "scenario---world---region---supplysector---subsector---absolute-cost-logit---logit-exponent---year",
    "scenario---world---region---supplysector---subsector---interpolation-rule---apply-to",
    "scenario---world---region---supplysector---subsector---interpolation-rule---from-year",
    "scenario---world---region---supplysector---subsector---interpolation-rule---interpolation-function---name",
    "scenario---world---region---supplysector---subsector---interpolation-rule---to-year",
    "scenario---world---region---supplysector---subsector---name",
    "scenario---world---region---supplysector---subsector---relative-cost-logit---logit-exponent---fillout",
    "scenario---world---region---supplysector---subsector---relative-cost-logit---logit-exponent---text",
    "scenario---world---region---supplysector---subsector---relative-cost-logit---logit-exponent---year",
    "scenario---world---region---supplysector---subsector---share-weight---fillout",
    "scenario---world---region---supplysector---subsector---share-weight---text",
    "scenario---world---region---supplysector---subsector---share-weight---year",
    "scenario---world---region---supplysector---subsector---stub-technology---name",
    "scenario---world---region---supplysector---subsector---stub-technology---period---CalDataOutput---calOutputValue",
    "scenario---world---region---supplysector---subsector---stub-technology---period---share-weight",
    "scenario---world---region---supplysector---subsector---stub-technology---period---year"
]

[ecwood]

Here is the dump from dac_USA_ssp2.xml: (which is equivalent to dac_USA_ssp1.xml, dac_USA_ssp3.xml, dac_USA_ssp4.xml, dac_USA_ssp5.xml)

[
    "scenario---world---region---PrimaryFuelCO2Coef---name",
    "scenario---world---region---PrimaryFuelCO2Coef---text",
    "scenario---world---region---energy-final-demand---base-service---text",
    "scenario---world---region---energy-final-demand---base-service---year",
    "scenario---world---region---energy-final-demand---delete",
    "scenario---world---region---energy-final-demand---name",
    "scenario---world---region---energy-final-demand---perCapitaBased",
    "scenario---world---region---energy-final-demand---price-elasticity---text",
    "scenario---world---region---energy-final-demand---price-elasticity---year",
    "scenario---world---region---name",
    "scenario---world---region---supplysector---delete",
    "scenario---world---region---supplysector---input-unit",
    "scenario---world---region---supplysector---keyword---final-energy",
    "scenario---world---region---supplysector---name",
    "scenario---world---region---supplysector---output-unit",
    "scenario---world---region---supplysector---price-unit",
    "scenario---world---region---supplysector---relative-cost-logit---logit-exponent---fillout",
    "scenario---world---region---supplysector---relative-cost-logit---logit-exponent---text",
    "scenario---world---region---supplysector---relative-cost-logit---logit-exponent---year",
    "scenario---world---region---supplysector---subsector---absolute-cost-logit---logit-exponent---fillout",
    "scenario---world---region---supplysector---subsector---absolute-cost-logit---logit-exponent---text",
    "scenario---world---region---supplysector---subsector---absolute-cost-logit---logit-exponent---year",
    "scenario---world---region---supplysector---subsector---interpolation-rule---apply-to",
    "scenario---world---region---supplysector---subsector---interpolation-rule---from-year",
    "scenario---world---region---supplysector---subsector---interpolation-rule---interpolation-function---name",
    "scenario---world---region---supplysector---subsector---interpolation-rule---to-year",
    "scenario---world---region---supplysector---subsector---name",
    "scenario---world---region---supplysector---subsector---relative-cost-logit---logit-exponent---fillout",
    "scenario---world---region---supplysector---subsector---relative-cost-logit---logit-exponent---text",
    "scenario---world---region---supplysector---subsector---relative-cost-logit---logit-exponent---year",
    "scenario---world---region---supplysector---subsector---share-weight---fillout",
    "scenario---world---region---supplysector---subsector---share-weight---text",
    "scenario---world---region---supplysector---subsector---share-weight---year",
    "scenario---world---region---supplysector---subsector---stub-technology---name",
    "scenario---world---region---supplysector---subsector---stub-technology---period---CalDataOutput---calOutputValue",
    "scenario---world---region---supplysector---subsector---stub-technology---period---minicam-energy-input---coefficient",
    "scenario---world---region---supplysector---subsector---stub-technology---period---minicam-energy-input---market-name",
    "scenario---world---region---supplysector---subsector---stub-technology---period---minicam-energy-input---name",
    "scenario---world---region---supplysector---subsector---stub-technology---period---share-weight",
    "scenario---world---region---supplysector---subsector---stub-technology---period---year"
]

[ecwood]

Here is the dump for carbon_tax_10_5.xml: (along with carbon_tax_15_5.xml, carbon_tax_20_5.xml, and carbon_tax_25_5.xml)

[
    "scenario---name",
    "scenario---world---region---ghgpolicy---fixedTax---text",
    "scenario---world---region---ghgpolicy---fixedTax---year",
    "scenario---world---region---ghgpolicy---market",
    "scenario---world---region---ghgpolicy---name",
    "scenario---world---region---name"
]

For carbon_tax_0.xml:

[
    "scenario---name",
    "scenario---world---region---ghgpolicy---fixedTax---fillout",
    "scenario---world---region---ghgpolicy---fixedTax---text",
    "scenario---world---region---ghgpolicy---fixedTax---year",
    "scenario---world---region---ghgpolicy---market",
    "scenario---world---region---ghgpolicy---name",
    "scenario---world---region---name"
]

For carbon_tax_0_nearterm.xml:

[
    "scenario---world---region---ghgpolicy---fixedTax---text",
    "scenario---world---region---ghgpolicy---fixedTax---year",
    "scenario---world---region---ghgpolicy---market",
    "scenario---world---region---ghgpolicy---name",
    "scenario---world---region---name"
]

[ecwood]

Here is the dump for 2025_target_finder_phasein.xml, 2025_target_finder_phasein.xml, 2040_target_finder_phasein.xml, and 2040_target_finder.xml:

[
    "scenario---world---region---linked-ghg-policy---demand-adjust---fillout",
    "scenario---world---region---linked-ghg-policy---demand-adjust---text",
    "scenario---world---region---linked-ghg-policy---demand-adjust---year",
    "scenario---world---region---linked-ghg-policy---linked-policy",
    "scenario---world---region---linked-ghg-policy---market",
    "scenario---world---region---linked-ghg-policy---name",
    "scenario---world---region---linked-ghg-policy---output-unit",
    "scenario---world---region---linked-ghg-policy---policy-name",
    "scenario---world---region---linked-ghg-policy---price-adjust---fillout",
    "scenario---world---region---linked-ghg-policy---price-adjust---text",
    "scenario---world---region---linked-ghg-policy---price-adjust---year",
    "scenario---world---region---linked-ghg-policy---price-unit",
    "scenario---world---region---linked-ghg-policy---start-year",
    "scenario---world---region---name"
]

[ecwood]

Here is the dump for forcing_target_3p7.xml, forcing_target_4p5.xml, and forcing_target_6p0.xml

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---forward-look",
    "policy-target-runner---initial-tax-guess",
    "policy-target-runner---max-iterations",
    "policy-target-runner---max-tax",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

and here is the dump for forcing_target_2p6_overshoot.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---forward-look",
    "policy-target-runner---initial-tax-guess",
    "policy-target-runner---max-iterations",
    "policy-target-runner---max-tax",
    "policy-target-runner---name",
    "policy-target-runner---overshoot---year",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

[ecwood]

Here is the dump for ghg_link_global.xml: (along with global_ffict_in_constraint.xml, global_ffict.xml, global_uct_in_constraint.xml, global_uct_spa1.xml, global_uct_spa2.xml, global_uct_spa5.xml, global_uct.xml, and linked_ghg_policy.xml)

[
    "scenario---world---region---linked-ghg-policy---demand-adjust---fillout",
    "scenario---world---region---linked-ghg-policy---demand-adjust---text",
    "scenario---world---region---linked-ghg-policy---demand-adjust---year",
    "scenario---world---region---linked-ghg-policy---linked-policy",
    "scenario---world---region---linked-ghg-policy---market",
    "scenario---world---region---linked-ghg-policy---name",
    "scenario---world---region---linked-ghg-policy---output-unit",
    "scenario---world---region---linked-ghg-policy---price-adjust---fillout",
    "scenario---world---region---linked-ghg-policy---price-adjust---text",
    "scenario---world---region---linked-ghg-policy---price-adjust---year",
    "scenario---world---region---linked-ghg-policy---price-unit",
    "scenario---world---region---name"
]

and for ghg_net0_constraint_global.xml:

[
    "scenario---world---region---ghgpolicy---constraint---text",
    "scenario---world---region---ghgpolicy---constraint---year",
    "scenario---world---region---ghgpolicy---market",
    "scenario---world---region---ghgpolicy---name",
    "scenario---world---region---name"
]

[ecwood]

For policy_target_1p9_spa1.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---max-tax",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_1p9_spa235.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---max-tax",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_1p9_spa4.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---max-tax",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_2p6_spa0.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---name",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value"
]

For policy_target_2p6_spa1.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---initial-tax-guess",
    "policy-target-runner---max-tax",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_2p6_spa23.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---initial-tax-guess",
    "policy-target-runner---max-tax",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_2p6_spa4.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---initial-tax-guess",
    "policy-target-runner---max-tax",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_2p6_spa5.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---initial-tax-guess",
    "policy-target-runner---max-tax",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_3p4_spa0.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---name",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value"
]

For policy_target_3p7_spa1.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_3p7_spa235.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---max-tax",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_3p7_spa4.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_4p5_spa0.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---name",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value"
]

For policy_target_4p5_spa1.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---forward-look",
    "policy-target-runner---max-iterations",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_4p5_spa23.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---forward-look",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_4p5_spa4.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---forward-look",
    "policy-target-runner---max-iterations",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_4p5_spa5.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_6p0_spa0.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---name",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value"
]

For policy_target_6p0_spa1.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_6p0_spa235.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]

For policy_target_6p0_spa4.xml:

[
    "policy-target-runner---first-tax-year",
    "policy-target-runner---name",
    "policy-target-runner---path-discount-rate",
    "policy-target-runner---target-tolerance",
    "policy-target-runner---target-type",
    "policy-target-runner---target-value",
    "policy-target-runner---tax-name"
]