gcubed.constants

Defines a singleton class, Constants, that provides access to all constants.

class Constants:

Overview

This is a singleton class.

Most of the constants in GCUBED are variable names and prefixes.

VERSION: int

The version of the G-Cubed Python implementation.

BUILD: int

The build of the G-Cubed Python implementation.

DELTA: float

The delta used to compute numeric derivatives when linearising the model. This delta matches the value used in the Ox implementation of G-Cubed.

ROGY_PREFIX: str

The ROGY (potential output growth rate) variable prefix.

INFP_PREFIX: str

The INFP (inflation rate in PRID) variable prefix.

INFX_PREFIX: str

The INFX (inflation rate target) variable prefix.

PRID_PREFIX: str

The PRID (weighted price of domestic output) variable prefix.

REXC_PREFIX: str

The REXC variable prefix.

WAGE_PREFIX: str

The wage variable prefix.

NOMINAL_GDP_PREFIX: str

The nominal GDP variable prefix.

REAL_GDP_PREFIX: str

The real GDP variable prefix, LGDPR.

GDPR_PREFIX: str

The GDPR variable prefix.

GDPN_PREFIX: str

The GDPN variable prefix.

TRAN_PREFIX: str

The TRAN variable prefix (transfers to households).

USA_GDP_RATIO_PREFIX: str

The ratio of nominal local GDP to nominal USA GDP, both measured in the USD currency. These variables are used to convert variables expressed as a percentage of local GDP to a percentage of USA GDP. They are also used in the calibration of the ashr parameters describing international financial asset holdings by each region.

REAL_INTEREST_RATE_PREFIX: str

The real interest rate variable prefix.

NOMINAL_INTEREST_RATE_PREFIX: str

The nominal interest rate variable prefix.

ALL_REAL_INTEREST_RATE_PREFIXES: list[str]

The real interest rate variable prefixes.

These are the prefixes of the variables that are set equal to the neutral real interest rate (set in the model configuration, ModelConfiguration.neutral_real_interest_rate) when doing linearisation of the model and when determining the adjustments to make to equate projections to observed data when doing the baseline projections.

  • INTF is the real short-run interest rate.
  • INTR is the 'risk-adjusted' real short-run interest rate, controlled by the central bank, equal to INTF plus RISR - an exogenous risk-premium in the yield curve. Note that RISR is typically zero in the databases and would be used to run simulation experiments.
ALL_NOMINAL_INTEREST_RATE_PREFIXES: list[str]

The nominal interest rate variable prefixes.

These are the prefixes of the variables that are set equal to the neutral real interest rate plus the expected inflation rate when doing linearisation of the model and when determining the adjustments to make to equate projections to observed data when doing the baseline projections.

  • INTN is the nominal short-run interest rate, controlled by the central bank.
ALL_LAGGED_NOMINAL_INTEREST_RATE_PREFIXES: list[str]

The lagged nominal interest rate variable prefixes.

These are the prefixes of the variables that are set equal to the neutral real interest rate plus the expected inflation rate when doing linearisation of the model and when determining the adjustments to make to equate projections to observed data when doing the baseline projections.

Note that with the removal of INTL, there are no longer any of these variables in G-Cubed models from build 181 onwards.

BOND_RATE_PREFIXES: list[str]

The long bond rate (real and nominal) variable prefixes.

STATE_LEAD_VARIABLES: list[str]

The state vector lead (stl variable types in SYM) variable prefixes.

UNITS_THAT_IMPLY_DIVISION_BY_USA_GDP: list[str]

The units of GDP that indicate that the variable values are divided by USA nominal GDP, expressed in USD.

UNITS_THAT_IMPLY_DIVISION_BY_LOCAL_GDP: list[str]

The units of GDP that indicate that the variable values are divided by local nominal GDP, expressed in USD. These units are of interest because we can multiply by ratio of local GDP to US GDP to convert the variable so that it is instead divided by US GDP.

MODELS_WITH_ELECTRICITY_GENERATION_SECTORS: list[str]

The models that have fully articulated electricity generation sectors.