gcubed.data.linearisation_database

This module contains the LinearisationDatabase class, used for model linearisation.

class LinearisationDatabase(gcubed.data.database.Database):

Overview

Provides convenience methods for all classes.

All G-Cubed classes inherit from this base class.

LinearisationDatabase( database: gcubed.data.database.Database, base_year: int, allowed_missing_logged_variable_names: Collection[str] = ())

Constructor

Manage loading and provision of linearisation database.

Encapsulates all of the information about the linearisation data used by a Model.

Note that this data differs from that used for model calibration in that the data for gdp unit variables has been scaled by the GDP ratio for each region to the US.

Arguments

database: the database that this linearisation database was derived from.

base_year: the base year for the database.

allowed_missing_logged_variable_names: active logged values that are intentionally calculated by a later database-generation stage. Missing values are retained for these rows; negative and infinite values remain invalid.

Exceptions

Raises ValueError when logged observations are invalid, except for explicitly deferred missing rows.

sym_data: gcubed.sym_data.SymData

The SYM processor output

configuration: gcubed.model_configuration.ModelConfiguration

The model configuration details

logged_zero_preparation_policy_version: str

Version of the logged-zero preparation applied to this database.

logged_zero_preparation_diagnostics: pandas.DataFrame

Return substitution provenance without exposing mutable internal state.

def rebase(self):

Rebase a database so indices have a new base year. This can be used to convert the database used for calibration to a database with the base year equal to the start year for projections (eg. 2011 to 2018).

Note that this script draws on the approach in the G-Cubed utilities/rebasedata.ox script.

Arguments

 new_base_year (int): a YYYY formatted new base year for the database.

Exceptions

Exception is thrown if the database does not contain data for the new base year.

Exception is thrown if the database does not contain data for the year after the new base year if the model has lagged index variables.

Inherited Members

gcubed.data.database.Database: data; variables_count; years_count; years_column_names; base_year; first_available_year; last_available_year; store_data; has_actual_exchange_rates; exchange_rate_anchors; normalise_actual_exchange_rates_for_solver; restore_actual_exchange_rates; export_to_csv; rhs_variable_value_for_vector; rhs_vector_value; get_data_and_varmap_indices; get_data_and_varmap_indices_for_variables; get_data_and_varmap_indices_for_state_lead_variables; get_data; get_data_for_variables_with_prefix; update_data; has_data; has_data_for_all_projection_years; set_up_gdp_ratio_scaling_factor; gdp_ratio_scaling_factor; gdp_ratio_scaling_factor_for_variable; value; set_value; save
gcubed.base.Base: zeros; load_data; get_year_labels; log_calling_stack