G-Cubed Available derived variables
The G-Cubed package currently registers the 56 derived-variable prefixes listed below. They can be selected by name with create_derivations(...) or in a build 199 setup chartpack’s derivations list.
Registration means that the calculation is included in the package. It does not mean that every definition applies to every G-Cubed model: validation still checks the model’s sets, input variables, parameters and any definition-specific requirements.
See Derived variables for complete setup and Python recipes, execution details and instructions for creating a new definition.
Ask the installed package for its catalogue
The registry is the authoritative source for the installed G-Cubed version:
from gcubed.derivations import available_definition_prefixes
for prefix in available_definition_prefixes():
print(prefix)
To inspect registered metadata as a dataframe:
from gcubed.derivations import available_definition_prefixes
from gcubed.derivations import create_derivations
prefixes = available_definition_prefixes()
details = create_derivations(prefixes).definition_details
print(details.to_string(index=False))
definition_details includes each definition’s label, units, deviation units, domain sets, required model prefixes, derived dependencies and description.
Growth rates
Growth rates use annual log differences multiplied by 100. The first projection year is empty because there is no preceding year inside the reporting frame.
| Prefix | Generated rows | Calculation | Required inputs |
|---|---|---|---|
CONSUMPTIONGROWTH | CONSUMPTIONGROWTH(region) | Growth in total consumption | CONP |
GDPNGROWTH | GDPNGROWTH(region) | Growth in nominal GDP | GDPN |
GDPRGROWTH | GDPRGROWTH(region) | Growth in real GDP | GDPR |
INVESTMENTGROWTH | INVESTMENTGROWTH(region) | Growth in total investment | INVT |
OUTPUTGROWTH | OUTPUTGROWTH(region) | Growth in total output | OUTP |
SECTOROUTPUTGROWTH | SECTOROUTPUTGROWTH(sector,region) | Growth in sector output | OUP |
Bond rates
These definitions compound annual short rates over the stated maturity.
| Prefix | Generated rows | Calculation | Required inputs |
|---|---|---|---|
NBOND02 | NBOND02(region) | 2-year nominal bond rate | INTN |
NBOND05 | NBOND05(region) | 5-year nominal bond rate | INTN |
NBOND10 | NBOND10(region) | 10-year nominal bond rate | INTN |
RBOND02 | RBOND02(region) | 2-year real bond rate | INTR |
RBOND05 | RBOND05(region) | 5-year real bond rate | INTR |
RBOND10 | RBOND10(region) | 10-year real bond rate | INTR |
Fiscal variables
| Prefix | Generated rows | Calculation | Required inputs |
|---|---|---|---|
BONDSHARE | BONDSHARE(region) | Government debt as a percentage of real GDP | BOND, GDPR |
DEBTTOGDPRATIO | DEBTTOGDPRATIO(region) | Government debt divided by real GDP | BOND, GDPR |
DEFISHARE | DEFISHARE(region) | Government deficit as a percentage of real GDP | DEFI, GDPR |
GOVISHARE | GOVISHARE(region) | Interest on government debt as a percentage of real GDP | GOVI, GDPR |
GOVTSHARE | GOVTSHARE(region) | Total government spending as a percentage of real GDP | GOVT, GDPR |
TAXLSHARE | TAXLSHARE(region) | Lump-sum tax revenue as a percentage of real GDP | TAXL, GDPR |
TAXMCP | TAXMCP(region) | Tariff revenue converted to current prices | TAXM, PRID |
TAXMSUM | TAXMSUM(region) | Cumulative tariff revenue over projection years | TAXM |
TAXMSUMCP | TAXMSUMCP(region) | Cumulative tariff revenue at current prices | TAXM, PRID |
TAXTSHARE | TAXTSHARE(region) | Total tax revenue as a percentage of real GDP | TAXT, GDPR |
TRANSHARE | TRANSHARE(region) | Government transfers as a percentage of real GDP | TRAN, GDPR |
BONDSHARE and DEBTTOGDPRATIO are separate registered prefixes for the same debt-to-real-GDP concept. Use the prefix expected by the chartpack or downstream analysis.
Trade and current-price variables
| Prefix | Generated rows | Calculation | Required inputs |
|---|---|---|---|
BTBAL | BTBAL(destination,origin) | Bilateral exports minus imports in US dollars | IMP, REXN |
EXQN | EXQN(good,region) | Exports by good converted to current prices | EXQ, PRID |
EXQTN | EXQTN(region) | Total exports converted to current prices | EXQT, PRID |
IMQG | IMQG(region) | Real imports summed over non-service goods | IMQ |
IMQGN | IMQGN(region) | Non-service goods imports at current prices | IMQ, PRID |
IMQN | IMQN(good,region) | Imports by good converted to current prices | IMQ, PRID |
IMQT2 | IMQT2(region) | Value of imports at destination; deviations are percentage changes | IMQT |
IMQTN | IMQTN(region) | Total imports converted to current prices | IMQT, PRID |
Production, output and wages
| Prefix | Generated rows | Calculation | Required inputs |
|---|---|---|---|
CAPITALINTENSITY | CAPITALINTENSITY(standard sector,region) | Capital use as a percentage of domestic production | CAP, OUP |
ENERGYINTENSITY | ENERGYINTENSITY(standard sector,region) | Energy inputs as a percentage of domestic production | ENT, OUP |
KTOL | KTOL(standard sector,region) | Capital-to-labour ratio | CAP, LAB |
LABORINTENSITY | LABORINTENSITY(standard sector,region) | Labour use as a percentage of domestic production | LAB, OUP |
MATERIALINTENSITY | MATERIALINTENSITY(standard sector,region) | Material inputs as a percentage of domestic production | OIN, OUP |
SECTOROUTPUTSHARE | SECTOROUTPUTSHARE(sector,region) | Sector output as a percentage of total regional output | OUP, OUTP |
SECTORREALWAGE | SECTORREALWAGE(sector,region) | Nominal wages divided by sector producer prices | WAGE, PRP |
SECTOR_OUTPUT_SHARES | SECTOR_OUTPUT_SHARES(good,region) | Value share of sectoral output | OUG, PRD, OUTP, PRID |
YONL | YONL(region) | Total output-to-labour ratio | LABO, OUTP |
Regional shares, world totals and saving
| Prefix | Generated rows | Calculation | Required inputs |
|---|---|---|---|
REGION_CONP_SHARE_OF_REGION_RGDP | REGION_CONP_SHARE_OF_REGION_RGDP(region) | Regional consumption as a share of regional real GDP | CONP, GDPR |
REGION_GCET_SHARE_OF_REGION_RGDP | REGION_GCET_SHARE_OF_REGION_RGDP(region) | Government consumption expenditure as a share of regional real GDP | GCET, GDPR |
REGION_INVP_SHARE_OF_REGION_RGDP | REGION_INVP_SHARE_OF_REGION_RGDP(region) | Regional investment as a share of regional real GDP | INVP, GDPR |
REGION_NGDP_SHARE_OF_WORLD_NGDP | REGION_NGDP_SHARE_OF_WORLD_NGDP(region) | Regional nominal GDP as a share of world nominal GDP | GDPN |
REGION_RGDP_SHARE_OF_WORLD_RGDP | REGION_RGDP_SHARE_OF_WORLD_RGDP(region) | Regional real GDP as a share of world real GDP | GDPR |
REGION_TBAL_SHARE_OF_REGION_RGDP | REGION_TBAL_SHARE_OF_REGION_RGDP(region) | Regional trade balance as a share of regional real GDP | TBAL, GDPR |
TOTALINVESTMENTBYSECTORS | TOTALINVESTMENTBYSECTORS(region) | Investment summed over sectors | INV, INVP, REALGROSSDOMESTICPRODUCT |
TOTALNOMINALDOMESTICSAVINGS | TOTALNOMINALDOMESTICSAVINGS(region) | Total nominal domestic saving | INVT, PRII, PRID, CURN, DEFN |
TOTALNOMINALDOMESTIC_NON_GOVERNMENTSAVINGS | TOTALNOMINALDOMESTIC_NON_GOVERNMENTSAVINGS(region) | Nominal domestic non-government saving | INVT, PRII, PRID, CURN |
TOTALREALDOMESTICSAVINGS | TOTALREALDOMESTICSAVINGS(region) | Total real domestic saving | INVT, PRII, PRID, CURR, REXN, DEFI |
TOTALSTOCKMARKETVALUE | TOTALSTOCKMARKETVALUE(region) | Sector stock-market values summed and reported relative to regional real GDP | STM, STMT, GDPR, REALGROSSDOMESTICPRODUCT |
WORLD_NOMINAL_GROSSDOMESTICPRODUCT | WORLD_NOMINAL_GROSSDOMESTICPRODUCT(region) | World nominal GDP, repeated over the regional output domain | GDPN |
WORLD_REAL_GROSSDOMESTICPRODUCT | WORLD_REAL_GROSSDOMESTICPRODUCT(region) | World real GDP, repeated over the regional output domain | GDPR |
The world totals deliberately emit one row per region even though each row contains the same world value. This preserves their registered regional output domain for charting.
Emissions and unemployment
| Prefix | Generated rows | Calculation | Required inputs |
|---|---|---|---|
EMCOW | EMCOW(region) | Global CO2 emissions converted from carbon and repeated by region | EMIS |
EMISSION_SHARES | EMISSION_SHARES(region) | Each region’s share of global CO2 emissions | EMCO, EMIS |
UNRATE | UNRATE(region) | Unemployment rate from the unemployment satellite model | LABX, LABO, OUTP, ROGY, WAGE, PRID, LAB, SHL, SHY |
UNRATE has additional model and parameter requirements beyond the input-prefix list. Let the runner validate it against the selected model before reporting.
Use a prefix in a report
This minimal Python example selects two built-ins:
from gcubed.derivations import create_derivations
derivations = create_derivations([
"GDPRGROWTH",
"UNRATE",
])
Pass derivations to the runner and to generate_all_simulation_results(...). Then select generated rows such as GDPRGROWTH(USA) or UNRATE(USA) in the chartpack. The complete workflow appears in the derived-variable recipes.