Available Paramaters
Users can get a list of all available params and queries as shown
below. The parameters page lists details on each parameter, how it was
calculated and cites any sources when available.
gcamextractor::map_param_query gives a list of all
parameters and the corresponding queries used to extract that data from
GCAM. Additionally, gcamextractor::map_param_query also
groups the various parameters into higher level groups which can then be
called in the paramSelect argument of
gcamextractor to extractor all the params in those groups.
The groups also include curated parameters for particular models such as
CERF and GO.
library(gcamextractor)
gcamextractor::params # Get all params
gcamextractor::queries # Get all queries used
gcamextractor::map_param_query # Get a table of params and the relevants queries used to extract and calculate them.
Socioeconomics
Table 1: Summary of parameters for socioeconomics.
| param | query |
|---|---|
| gdpPerCapita | GDP per capita MER by region |
| gdp | GDP MER by region |
| gdpGrowthRate | GDP Growth Rate (Percent) |
| pop | Population by region |
Transport
Table 2: Summary of parameters for transport.
| param | query |
|---|---|
| transportPassengerVMTByMode | transport service output by mode |
| transportFreightVMTByMode | transport service output by mode |
| transportPassengerVMTByFuelNew | transport service output by tech (new) |
| transportFreightVMTByFuelNew | transport service output by tech (new) |
| transportPassengerVMTByFuel | transport service output by tech |
| transportFreightVMTByFuel | transport service output by tech |
| transportPassengerVMTByTech | transport service output by tech |
| transportFreightVMTByTech | transport service output by tech |
| transportPassengerGHGByMode | nonCO2 emissions by subsector |
| transportFreightGHGByMode | nonCO2 emissions by subsector |
*Passenger VMT modes: 2W and 3W, bus, car, large car and truck,
LDV, plane, and rail.
*Freight VMT modes: heavy truck, light truck, medium truck, rail,
and ship.
*Passenger VMT fuel: biofuel, electricity, fossil fuel, gas,
hydrogen, and LA-electricity.
*Freight VMT fuel: biofuel, coal, electricity, fossil fuel,
gas.
Water
Table 3: Summary of parameters for water.
| param | query |
|---|---|
| watConsumBySec | water consumption by state, sector, basin (includes desal) |
| watWithdrawBySec | water withdrawals by state, sector, basin (includes desal) |
| watWithdrawByCrop | water withdrawals by crop |
| watBioPhysCons | biophysical water demand by crop type and land region |
| watIrrWithdrawBasin | water withdrawals by water mapping source |
| watIrrConsBasin | water consumption by water mapping source |
| watSupRunoffBasin | Basin level available runoff |
| waterWithdrawROGW | Water withdrawals by water source (runoff vs. groundwater) |
*Water consumption sectors: animal, domestic, electric,
industry, irrigation, and primary.
*Water withdrawal sectors: agriculture, electricity, industry,
livestock, mining, municipal, and desalination.
*Crop: biomass, corn, fibercrop, fodderherb, miscellaneous crop,
oil crop, other grain, palm fruit, rice, root tuber, sugar crop, wheat,
and fodder grass.
Agriculture
Table 4: Summary of parameters for agriculture.
| param | query |
|---|---|
| energyPrimaryByFuelMTOE | primary energy consumption by region (direct equivalent) |
| energyPrimaryRefLiqProdMTOE | refined liquids production by subsector |
| energyFinalConsumBySecMTOE | total final energy by aggregate sector |
| energyFinalByFuelBySectorMTOE | Final energy by detailed end-use sector and fuel |
| elecByTechTWh | elec gen by gen tech cogen USA , elec gen by gen tech USA , elec gen by gen tech and cooling tech |
| elecCapByFuel | elec gen by gen tech cogen USA , elec gen by gen tech USA , elec gen by gen tech and cooling tech |
| elecFinalBySecTWh | inputs by tech |
| elecFinalByFuelTWh | Final energy by detailed end-use sector and fuel |
| transportPassengerVMTByMode | transport service output by mode |
| transportFreightVMTByMode | transport service output by mode |
| transportPassengerVMTByFuel | transport service output by tech |
| transportFreightVMTByFuel | transport service output by tech |
| watConsumBySec | water consumption by state, sector, basin (includes desal) |
| watWithdrawBySec | water withdrawals by state, sector, basin (includes desal) |
| watWithdrawByCrop | water withdrawals by crop |
| watSupRunoffBasin | Basin level available runoff |
| gdpPerCapita | GDP per capita MER by region |
| gdp | GDP MER by region |
| gdpGrowthRate | GDP Growth Rate (Percent) |
| pop | Population by region |
| agProdByCrop | ag production by tech |
| landAlloc | aggregated land allocation |
| landAllocByCrop | land allocation by crop |
| emissLUC | Land Use Change Emission (future) |
| emissCO2BySector | CO2 emissions by sector |
| agProdbyIrrRfd | ag production by tech |
| agProdBiomass | ag production by tech |
| agProdForest | ag production by tech |
| agProdByCrop | ag production by tech |
Livestock
Table 5: Summary of parameters for livestock.
| param | query |
|---|---|
| livestock_MeatDairybyTechMixed | meat and dairy production by tech |
| livestock_MeatDairybyTechPastoral | meat and dairy production by tech |
| livestock_MeatDairybyTechImports | meat and dairy production by tech |
| livestock_MeatDairybySubsector | meat and dairy production by tech |
Land Use
Table 6: Summary of parameters for land use.
| param | query |
|---|---|
| landIrrRfd | land allocation by crop and water source |
| landIrrCrop | land allocation by crop and water source |
| landRfdCrop | land allocation by crop and water source |
| landAlloc | aggregated land allocation |
| landAllocByCrop | land allocation by crop |
| landAllocDetail | detailed land allocation |
*Aggregated land type: crops, forest, natural other, natural
other grass, natural other tree, pasture, and crop
*Detailed land type: biomassGrass, biomassTree, Corn, FiberCrop,
Forest, Grassland, MiscCrop, OilCrop, OtherArableLand, OtherGrain,
PalmFruit, Pasture, ProtectedGrassland, ProtectedShrubland,
ProtectedUnmanagedForest, ProtectedUnmanagedPasture, Rice, RootTuber,
Shrubland, SugarCrop, UnmanagedForest, UnmanagedPasture, UrbanLand,
Wheat, FodderGrass, FodderHerb, RockIceDesert, and Tundra
Emissions
Table 7: Summary of parameters for emissions.
| param | query |
|---|---|
| emissGHGBySectorGWPAR5 | nonCO2 emissions by sector , nonCO2 emissions by sector USA , nonCO2 emissions by resource production, CO2 emissions by sector , Land Use Change Emission (future) , CO2 sequestration by sector |
| emissGHGBySectorNoBioGWPAR5 | nonCO2 emissions by sector , nonCO2 emissions by sector USA , nonCO2 emissions by resource production, CO2 emissions by sector (no bio) , CO2 emissions by sector , Land Use Change Emission (future) , CO2 sequestration by sector |
| emissGHGByGasGWPAR5 | nonCO2 emissions by sector , nonCO2 emissions by sector USA , nonCO2 emissions by resource production, CO2 emissions by sector , Land Use Change Emission (future) , CO2 sequestration by sector |
| emissGHGByGasNoBioGWPAR5 | nonCO2 emissions by sector , nonCO2 emissions by sector USA , nonCO2 emissions by resource production, CO2 emissions by sector (no bio) , Land Use Change Emission (future) , CO2 sequestration by sector |
| emissLUC | Land Use Change Emission (future) |
| emissCO2BySector | CO2 emissions by sector , CO2 sequestration by sector , Land Use Change Emission (future) |
| emissCO2CumGlobal2010to2100 | CO2 emissions by sector |
| emissCO2CumGlobal2010to2100RCP | CO2 emissions by sector |
| emissCO2BySectorNoBio | CO2 emissions by sector (no bio) , CO2 sequestration by sector , Land Use Change Emission (future) |
| emissGHGByResProdGWPAR5 | nonCO2 emissions by resource production |
| co2SequestrationBySector | CO2 sequestration by sector |
| emissGHGBySectorBuildingsGWPAR5 | nonCO2 emissions by sector , nonCO2 emissions by sector USA , CO2 emissions by sector (no bio) |
| emissGHGBySectorTransportGWPAR5 | nonCO2 emissions by subsector, CO2 emissions by subsector |
| emissGHGBySectorIndustryGWPAR5 | nonCO2 emissions by subsector, CO2 emissions by subsector |
| emissGHGBySectorPowerGWPAR5 | CO2 emissions by sector , nonCO2 emissions by sector |
Electricity
Table 8: Summary of parameters for electricity.
| param | query | gcamdata |
|---|---|---|
| elecByTechTWh | elec gen by gen tech cogen USA , elec gen by gen tech USA , elec gen by gen tech and cooling tech | no |
| elecCapByFuel | elec gen by gen tech cogen USA , elec gen by gen tech USA , elec gen by gen tech and cooling tech | no |
| elecFinalBySecTWh | inputs by tech | no |
| elecFinalByFuelTWh | Final energy by detailed end-use sector and fuel | no |
| elecConsumByDemandSectorTWh | elec consumption by demand sector | no |
| elecLoadBySegmentGW | elec gen by segment (grid level) | /outputs/L102.load_segments_gcamusa |
*Fuel: biomass, coal, gas, geothermal, hydro, nuclear, refined
liquids, solar, and wind.
*Final electricity sectors: building, industry, and
transport.
elecByTechTWh
elecByTechTWh uses “elec gen by gen tech and cooling
tech” query and converts electricity generation of GCAM raw output from
EJ to TWh:
\[elecByTechTWh = elecByTechEJ_{GCAM}
\times convEJ2TWh\] where convEJ2TWh is the
conversion constant from EJ to TWh, 1 EJ = 277.7778 TWh.
gcamextractor::readgcam also aggregates “rooftop_pv” into
“solar” category in the technology subsector (shown in “class1”
colomn).
library(gcamextractor)
dataGCAM <- gcamextractor::readgcam(dataProjFile = gcamextractor::example_GCAMv52_2050_proj,
paramsSelect = 'elecByTechTWh',
regionsSelect = 'USA',
folder = "my_output_folder")elecCapByFuel
elecCapByFuel calculates electricity capacity (GW) based
on the output from elecByTechTWh:
\[elecCapByFuel = \frac{elecByTechTWh \times 1000}{8760 \times gcamCapacityFactor}\]
gcamCapacityFactor is calculated as an average of the
capacity factors of the technologies within each subsector (See Table GCAM Capacity Factors) based
on the data from:
- Global technology capacity factor from “GCAM-FOLDER\input\gcamdata\inst\extdata\energy\A23.globaltech_capacity_factor.csv”
- USA renewable technology capacity factors by States from “GCAM-FOLDER\input\gcamdata\inst\extdata\gcam-usa\NREL_us_re_capacity_factors.csv”
- Hydrogen fuel cell capacity factor from https://www.eia.gov/todayinenergy/detail.php?id=35872 and https://www.nrel.gov/analysis/tech-cap-factor.html
Exceptions in calculating gcamCapacityFactor
include:
- For “solar” capacity factor the CSP_storage capacity factor value of 0.65 was excluded from the average.
- The “hydro” capacity factor was sourced from Global CCS Institute “Renewable power generation costs in 2012: an overview” - 5.2 Capacity factors for hydropower, since hydropower is calculated endogenously within GCAM.
- No cogeneration capacity factor “n CHP” was given.
- rooftop_pv was assumed the same as solar average (5) grid_storage assumed to have a high cap factor equal to that of nuclear
Table GCAM Capacity Factors: Averaged capacity factor for electricity generation by generation technology.
| Subsector (class1) | Average capacity factor from 1971 to 2100 |
|---|---|
| coal | 0.8125 |
| gas | 0.816667 |
| oil | 0.816667 |
| biomass | 0.825 |
| nuclear | 0.9 |
| geothermal | 0.9 |
| hydro | 0.5 |
| wind | 0.37 |
| solar | 0.216667 |
| rooftop_pv | 0.216667 |
| hydrogen | 0.8 |
| grid_storage | 0.9 |
library(gcamextractor)
dataGCAM <- gcamextractor::readgcam(dataProjFile = gcamextractor::example_GCAMv52_2050_proj,
paramsSelect = 'elecCapByFuel',
regionsSelect = 'USA',
folder = "my_output_folder")Energy
Table 9: Summary of parameters for energy.
| param | query |
|---|---|
| energyPrimaryByFuelEJ | primary energy consumption by region (direct equivalent) |
| energyPrimaryRefLiqProdEJ | refined liquids production by subsector |
| energyFinalConsumBySecEJ | total final energy by aggregate sector |
| energyFinalByFuelBySectorEJ | Final energy by detailed end-use sector and fuel |
| energyFinalSubsecByFuelTranspEJ | transport final energy by fuel |
| energyFinalSubsecByFuelBuildEJ | building final energy by fuel |
| energyFinalSubsecByFuelIndusEJ | industry final energy by fuel |
| energyFinalSubsecBySectorBuildEJ | building final energy by subsector |
| energyFinalConsumByIntlShpAvEJ | transport final energy by mode and fuel |
| energyPrimaryByFuelMTOE | primary energy consumption by region (direct equivalent) |
| energyPrimaryRefLiqProdMTOE | refined liquids production by subsector |
| energyFinalConsumBySecMTOE | total final energy by aggregate sector |
| energyFinalByFuelBySectorMTOE | Final energy by detailed end-use sector and fuel |
| energyFinalByFuelBySectorTWh | Final energy by detailed end-use sector and fuel |
| energyFinalbyFuelMTOE | Final energy by detailed end-use sector and fuel |
| energyFinalSubsecByFuelTranspMTOE | transport final energy by fuel |
| energyFinalSubsecByFuelBuildMTOE | building final energy by fuel |
| energyFinalSubsecByFuelIndusMTOE | industry final energy by fuel |
| energyFinalSubsecBySectorBuildMTOE | building final energy by subsector |
| energyFinalConsumByIntlShpAvMTOE | transport final energy by mode and fuel |
| energyPrimaryByFuelTWh | primary energy consumption by region (direct equivalent) |
| energyPrimaryRefLiqProdTWh | refined liquids production by subsector |
| energyFinalConsumBySecTWh | total final energy by aggregate sector |
| energyFinalbyFuelTWh | Final energy by detailed end-use sector and fuel |
| energyFinalSubsecByFuelTranspTWh | transport final energy by fuel |
| energyFinalSubsecByFuelBuildTWh | building final energy by fuel |
| energyFinalSubsecByFuelIndusTWh | industry final energy by fuel |
| energyFinalSubsecBySectorBuildTWh | building final energy by subsector |
| energyFinalConsumByIntlShpAvTWh | transport final energy by mode and fuel |
| energyFinalConsumBySecEJNoFeedstock | total final energy by sector |
| energyFinalByFuelEJNoFeedstock | Final energy by detailed end-use sector and fuel |
*Final energy sectors: building, industry, transport, transport
international aviation, and transport international ship.
*Building final energy subsectors: commercial cooling and heating,
commercial others, residential cooling and heating, and residential
others.
*Final energy fuel: biomass, coal, electricity, gas, hydrogen,
liquids, liquids av, liquids shp, and other.
Data for Specific Models
CERF
Use cerf for the paramSelect argument in
gcamextractor to extract the relevant variables needed for
the CERF model (https://github.com/IMMM-SFA/cerf).
library(gcamextractor)
path_to_gcam_database <- "E:/gcamfolder/output/database_ref" # Change to your path.
path_to_gcam_projfile <- "E:/my_proj_file.proj" # Change to your .proj file path.
path_to_gcamdata_folder <- "E:/gcamfolder/input/gcamdata"
gcamextractor::params # view available parameters
dataGCAM <- gcamextractor::readgcam(gcamdatabase = path_to_gcam_database,
dataProjFile = path_to_gcam_projfile # Optional. Or cerf_proj_file.proj
gcamdata_folder = path_to_gcamdata_folder,
paramsSelect = "cerf",
folder = "cerf") # Set to "All" to read in all available params
df <- dataGCAM$data; df
dfParam <- dataGCAM$dataAggParam; dfParam
dfClass1 <- dataGCAM$dataAggClass1; dfClass1
dfClass2 <- dataGCAM$dataAggClass1; dfClass2The parameters extracted for CERF are as follows with links to the relevant parameters explanation:
| Parameter | Description | Unit | Queries | GCAM.version.tested | gcamdata.files |
|---|---|---|---|---|---|
| elec_lifetime_yr | Technology Lifetime (Yr) | year | NA | v5.3 |
|
| elec_lifetime_scurve_yr | Base year S-Curve Lifetime, Steepness, half life |
|
NA | v5.3 |
|
| elec_capacity_factor_usa_in | Capacity Factor assumptions for US States by investment segments (baseline, intermediate, subpeak, peak | None | elec investment capacity factor | v5.3 | None |
| elec_variable_om_2015USDperMWh | Variable OnM cost (2015 USD/MWh) | 2015 USD/MWh | elec operating costs by tech and vintage | v5.3 | None |
| elec_variable_om_escl_rate_2015USDperMWh | Variable OnM cost escalation rate (fraction) | 2015 USD/MWh | elec operating costs by tech and vintage | v5.3 | None |
| elec_fuel_price_2015USDperMBTU | Fuel Price (2015 USD/MBTU) | 2015 USD/MBTU | prices by sector | v5.3 | None |
| elec_fuel_price_escl_rate_2015USDperMBTU | Fuel Price Escalation Rate (fraction) | 2015 USD/MBTU | prices by sector | v5.3 | None |
| elec_cap_usa_GW | Installed Capacity in GW | GW | elec capacity by tech and vintage | v5.3 | None |
| energy_fuel_co2_content_tonsperMBTU | Fuel CO2 Content (Tons per MBTU) | Tons per MBTU | NA | v5.3 |
|
| elec_carbon_capture_rate_fraction | Carbon Capture Rate (fraction) | Fraction | NA | v5.3 |
|
| elec_carbon_capture_escl_rate_fraction | Carbon Capture Escalation Rate (fraction) | Fraction | NA | v5.3 |
|
| elec_heat_rate_BTUperkWh | Heat Rate (BTU per kWh) | BTU per kWh | elec coeff | v5.3 | None |
GO
Use cerf for the paramSelect argument in
gcamextractor to extract the relevant variables needed for
the CERF model (https://github.com/IMMM-SFA/cerf).
library(gcamextractor)
path_to_gcam_database <- "E:/gcamfolder/output/database_ref" # Change to your path.
path_to_gcam_projfile <- "E:/my_proj_file.proj" # (OPTIONAL) Change to your .proj file path.
gcamextractor::params # view available parameters
dataGCAM <- gcamextractor::readgcam(gcamdatabase = path_to_gcam_database,
dataProjFile = path_to_gcam_projfile # Optional. Or go_proj_file.proj
paramsSelect = "go",
folder = "go") # Set to "All" to read in all available params
df <- dataGCAM$data; df
dfParam <- dataGCAM$dataAggParam; dfParam
dfClass1 <- dataGCAM$dataAggClass1; dfClass1
dfClass2 <- dataGCAM$dataAggClass1; dfClass2The parameters extracted for GO are as follows with links to the relevant parameters explanation:
| Parameter | Description | Unit | Queries | GCAM.version.tested | gcamdata.files |
|---|---|---|---|---|---|
| elec_fuel_price_2015USDperMBTU | Fuel Price (2015 USD/MBTU) | 2015 USD/MBTU | prices by sector | v5.3 | None |
| elec_heat_rate_MBTUperMWh | Heat Rate (MBTU per MWh) | MBTU per MWh | elec coeff | v5.3 | None |