macrostat.models.GL06PC.GL06PC#

class macrostat.models.GL06PC.GL06PC(parameters: ~macrostat.models.GL06PC.parameters.ParametersGL06PC | None = <macrostat.models.GL06PC.parameters.ParametersGL06PC object>, variables: ~macrostat.models.GL06PC.variables.VariablesGL06PC | None = None, scenarios: ~macrostat.models.GL06PC.scenarios.ScenariosGL06PC | None = None, *args, **kwargs)[source]#

Bases: Model

PC model class for the Godley-Lavoie 2006 PC model.

__init__(parameters: ~macrostat.models.GL06PC.parameters.ParametersGL06PC | None = <macrostat.models.GL06PC.parameters.ParametersGL06PC object>, variables: ~macrostat.models.GL06PC.variables.VariablesGL06PC | None = None, scenarios: ~macrostat.models.GL06PC.scenarios.ScenariosGL06PC | None = None, *args, **kwargs)[source]#

Initialize the PC model.

Parameters:

  • parameters (ParametersGL06PC | None) – The parameters of the model. If None, default parameters will be used.

  • variables (VariablesGL06PC | None) – The variables of the model. If None, default variables will be used.

  • scenarios (ScenariosGL06PC | None) – The scenarios of the model. If None, default scenarios will be used.

Methods

__init__([parameters, variables, scenarios])

Initialize the PC model.

from_json(parameter_file, scenario_file, ...)

Initialize the model from a JSON file.

load(path)

Class method to load a model instance from a pickled file.

save(path)

Save the model object as a pickled file

simulate([scenario])

Simulate the model.

to_json(file_path, *args, **kwargs)

Convert the model to a JSON file split into parameters, scenarios, and variables.

Attributes

version

version = 'GL06PC'#