Module parameters

Source
Expand description

Defines the ModelParameters struct, which represents the contents of model.toml.

Macrosยง

define_param_default ๐Ÿ”’
define_unit_param_default ๐Ÿ”’

Structsยง

ModelParameters
Model parameters as defined in the model.toml file.
PricingStrategyVisitor ๐Ÿ”’

Enumsยง

PricingStrategy
The strategy used for calculating commodity prices

Constantsยง

ALLOW_BROKEN_OPTION_NAME
The name of the option used to gate other, broken options.
MODEL_PARAMETERS_FILE_NAME ๐Ÿ”’

Staticsยง

BROKEN_OPTIONS_ALLOWED ๐Ÿ”’
Whether broken options have been enabled by an option in the model config file

Functionsยง

broken_model_options_allowed
Whether broken model options have been enabled in the config file or not
check_max_ironing_out_iterations ๐Ÿ”’
Check that the max_ironing_out_iterations parameter is valid
check_milestone_years ๐Ÿ”’
Check that the milestone_years parameter is valid
check_price_tolerance ๐Ÿ”’
Check the price_tolerance parameter is valid
check_value_of_lost_load ๐Ÿ”’
Check that the value_of_lost_load parameter is valid
default_candidate_asset_capacity ๐Ÿ”’
default_capacity_limit_factor ๐Ÿ”’
default_max_ironing_out_iterations ๐Ÿ”’
default_price_tolerance ๐Ÿ”’
default_value_of_lost_load ๐Ÿ”’