G-Cubed
Python G-Cubed 5.0.2.0 · build 1
Generation details
Source revision
4c4a95aded1b5ca5e8f9c292ad8250440cd9c18b (modified inputs)
Source fingerprint
e2c719b38e03c6b1748f10e26bc1caf1ead5674dd1beee6628a6ccf7b90fd39b
Generated (UTC)
2026-11-11T03:06:22.844261+00:00
Generator
pdoc 16.0.0, CPython 3.14.8
Generation metadata

gcubed.model_parameters.default_policy

Default baseline setup policy for model parameter generation.

DEFAULT_TECHNOLOGY_ADVANCEMENT_RATE: float = 0.0
DEFAULT_TECHNOLOGY_CATCHUP_RATE: float = 2.0
DEFAULT_TECHNOLOGY_GAP: float = 100.0
DEFAULT_AUTONOMOUS_ENERGY_EFFICIENCY_IMPROVEMENT_RATE: float = 0.0
class ModelConfigurationLike(typing.Protocol):

Model configuration attributes needed to choose baseline defaults.

ModelConfigurationLike(*args, **kwargs)
gtap_country_mapping_column_label: str
gtap_commodity_mapping_column_label: str
ember_generation_mapping_column_label: str
has_electricity_distribution_and_generation_sectors: bool
@dataclass(frozen=True)
class DefaultBaselineSetupPolicy:

Label-driven defaults for baseline data and user parameter generation.

technology_advancement_rate is a percentage-point deviation from the configured common growth rate, so its default is zero.

DefaultBaselineSetupPolicy( gtap_country_mapping_column_label: str, gtap_commodity_mapping_column_label: str, ember_generation_mapping_column_label: str | None, technology_advancement_rate: float, technology_catchup_rate: float, technology_gap: float, autonomous_energy_efficiency_improvement_rate: float)
gtap_country_mapping_column_label: str
gtap_commodity_mapping_column_label: str
ember_generation_mapping_column_label: str | None
technology_advancement_rate: float
technology_catchup_rate: float
technology_gap: float
autonomous_energy_efficiency_improvement_rate: float
sector_parameter_mapping_label: str

Mapping label used for sector-ordered default parameter vectors.

def default_baseline_setup_policy( model_configuration: ModelConfigurationLike, *, technology_advancement_rate: float = 0.0, technology_catchup_rate: float = 2.0, technology_gap: float = 100.0, autonomous_energy_efficiency_improvement_rate: float = 0.0) -> DefaultBaselineSetupPolicy:

Return the label-driven default setup policy for a model configuration.