gcubed.model

This module contains the Model class, used to load:

  • the model configuration
  • the details of the model equations expressed in the SYM files
  • the model database
  • the IO tables
  • the model parameters
  • the exogenous variable baseline effective labor productivity details
  • the exogenous variable energy efficiency adjustments
class Model(gcubed.base.Base):

Encapsulates all of the information about a Model, sufficient to generate baseline projections.

Model(configuration: gcubed.model_configuration.ModelConfiguration)

Constructor

Cause the model to load based on the information in its configuration.

Arguments

configuration (ModelConfiguration): the configuration details for the model being created.

configuration: gcubed.model_configuration.ModelConfiguration

The model configuration.

sym_data: gcubed.sym_data.SymData

The data provided by SYM about variables and parameters.

database: gcubed.data.database.Database

The model database.

parameters: gcubed.model_parameters.parameters.Parameters

The model parameter values, set by the user and calibrated from the model database and IO tables.

effective_labour_productivity: gcubed.exogenous_adjustments.effective_labour_productivity.EffectiveLabourProductivity

The effective labour productivity growth projections underpinning levels projections that reflect long-run growth prospects.

autonomous_energy_usage_efficiency: gcubed.exogenous_adjustments.autonomous_energy_usage_efficiency.AutonomousEnergyUsageEfficiency

The energy usage efficiency improvement rate projections for each sector in each region. These impact projections for energy requirements by region and sector.

def create_exogenous_growth_and_efficiency_adjustments(self):

Overview

Create a CSV file containing the exogenous variable projections and save them into a CSV file in the data directory. The name of the CSV file is specified in the model configuration.

The projections capture:

  • effective labour productivity projections (based on population and productivity growth rates in each region)
  • energy efficiency improvement projections (based on projections of autonomous energy efficiency improvements)

Exceptions

Raises an exception if the first-projection-year exogenous variable values include NaNs.

Inherited Members
gcubed.base.Base
zeros
load_data
get_year_labels
log_calling_stack