gcubed.linearisation.solved_model

Module containing the complete solved-model construction path.

class SolvedModel(gcubed.base.Base):

Overview

Provides convenience methods for all classes.

All G-Cubed classes inherit from this base class.

SolvedModel( model: gcubed.model.Model, linearise_around_the_neutral_real_interest_rate: bool = True)

Overview

Solves the model.

This object takes some time to construct, as it solves the model. Therefore it can be useful to create this object and then to re-use it for multiple projections.

Arguments

model :

The model to be solved

linearise_around_the_neutral_real_interest_rate :

If `True`, the model is linearised around the neutral real interest rate.
If `False`, the model is linearised around the interest rates in the linearisation year.
Defaults to `True`.

Exceptions

Raises AssertionError if the model is not provided or is not a gcubed.model.Model or if linearise_around_the_neutral_real_interest_rate is not True or False.

Logs a warning before a major solution phase when the conservative memory estimate exceeds the effective memory available to the process, then attempts the solve using memory-minimizing block sizes.

def validate_growth_inputs( self, configuration: gcubed.model_configuration.ModelConfiguration) -> None:

Require the saved solution to match the caller's current model inputs.

Runtime loaders supply their current configuration, which can differ from the serialized configuration when a model directory was copied. Direct joblib restoration separately checks the serialized source paths.

Arguments: configuration: The configuration selected for the current run.

Raises: ValueError: If the saved solution is unbound or its growth inputs differ from the supplied configuration and source files.

linearise_around_the_neutral_real_interest_rate: bool

True if interest rates are linearised around the neutral real interest rate for the start of the baseline projections and False otherwise.

Defaults to True.

stable_manifold: gcubed.linearisation.stable_manifold.StableManifold

The stable manifold.

state_space_form: gcubed.linearisation.state_space_form.StateSpaceForm

The state space form.

model: gcubed.model.Model

The model.

parameters: gcubed.model_parameters.parameters.Parameters