gcubed.projections.projections
This module contains the Projections class, used as a base class
for generating baseline and simulation projections. It provides access
to all forms of projections.
Base class for Simulation Projections and for Baseline Projections.
Arguments
stable_manifold: The stable manifold used for projecting the model.
previous_projections: The previous projections (baseline or simulation layer or other)
or None if these projections have no previous projections.
Exceptions
Raises an exception if the stable manifold has not been supplied correctly.
Raises an exception if the stable manifold has not converged.
True if the projections are baseline projections rather than some other kind of projections.
The baseline projections that underpin these projections. If these projections are baseline projections then this property is this instance.
The previous projections (baseline projections
or projections based on application of a simulation layer)
or None if these projections are baseline projections.
The solved model used for projecting the model.
The stable manifold used for projecting the model.
The state-space form of the linearised model.
The linearisation database used as the starting point for the projections.
Returns the list of years for projections from the event year through to and including the projection end year.
Returns the ordered list of 4 digit (YYYY) year column labels for the projections.
Returns the ordered list of 4 digit (YYYY) year publishable projection column labels for the projections.
Returns the dataframe of the original database and the projections for all variables in the model.
This splicing of the database onto the database projections is intended to be used for diagnostic purposes only.
Exceptions
Raises an exception if the combined database and projections are not yet available.
Returns the dataframe of projections for all variables in the model in forms that are consistent with the values contained in the original model database.
Exceptions
Raises an exception if the database projections are not yet available.
Overview
This property gives access to the publishable projections, generated from the database projections.
Publishable projections are generated for human consumption only. They are not reused for model or simulation calculations.
The publishable projections must be associated with the publication_units
of measurement that are available from the sym_data variable summary.
Key changes from the database projections are:
Real GDP scaling
LGDPR database projections are hypothetical projections of real GDP for each region, under the assumption that each region is in steady state and is growing at its steady state growth rate.
This steady-state growth has path has been eliminated from the path for effective labor productivity to ensure that the model settles down to a steady state in which there is no growth when the model is being solved. This steady-state growth path needs to be restored and this is where that restoration occurs.
Multiply database projections for all variables with GDP units by the LGDPR projections for the region to which the variable belongs.
Also multiply database projections for all variables with reference country GDP units by the LGDPR projections for the reference country region.
Dollar unit conversion (obsolete now that dollars units are not used.)
Conversion from cents (dollars * 100) representation to dollars
for data with dollars units.
Aggregate consistency adjustments (optional)
Ensure that macroeconomic aggregates have components consistent with aggregates.
Returns
The dataframe of publishable level projections for all variables in the model, converted to the publishable units of measurement.
Exceptions
Raises an exception if the publishable projections cannot be generated.
The yxr initial values used to start the projections process.
Exceptions
Raises an exception if the initial values contain NaNs.
Raises an exception if the initial values are not yet available.
Get yxr variable projection values of the projection years as a dataframe.
Get exz variable projection values of the projection years as a dataframe.
A dataframe (not a numpy array) that contains the exogenous variable projection values for all of the projection years from the original first projection year through to the last projection year, as a dataframe.
The exogenous variable projections for the years before the first projection year of this projections object are retained because they can be necessary in the event of a subsequent model relinearisation.
Exceptions
Raises an exception if the exogenous variable projections contain NaN values.
The constant adjustments to long bond rates (real and nominal) in the first (base) projection year to ensure projections equal observed values.
Database projections along with annotations for units and variable descriptions.
Combined database and projections along with annotations for units and variable descriptions.
Publication projections along with annotations for units and variable descriptions.
Charting projections along with annotations for set member descriptions and prefix.