Expand description
Read and validate model parameters from model.toml.
This module defines the ModelParameters struct and helpers for loading and
validating the model.toml configuration used by the model. Validation
functions ensure sensible numeric ranges and invariants for runtime use.
Macrosยง
Structsยง
- Model
Parameters - Model parameters as defined in the
model.tomlfile.
Constantsยง
- ALLOW_
BROKEN_ OPTION_ NAME - The key in
model.tomlwhich enables known-broken model options. - MODEL_
PARAMETERS_ ๐FILE_ NAME
Staticsยง
- BROKEN_
OPTIONS_ ๐ALLOWED - Global flag indicating whether broken model options have been enabled.
Functionsยง
- broken_
model_ options_ allowed - Return whether broken model options were enabled by the loaded config.
- check_
capacity_ ๐margin - Check that the
capacity_marginparameter is valid - check_
max_ ๐ironing_ out_ iterations - Check that the
max_ironing_out_iterationsparameter is valid - check_
milestone_ ๐years - Check that the
milestone_yearsparameter is valid - check_
price_ ๐tolerance - Check the
price_toleranceparameter is valid - check_
value_ ๐of_ lost_ load - Check that the
value_of_lost_loadparameter is valid - default_
candidate_ ๐asset_ capacity - default_
capacity_ ๐limit_ factor - default_
capacity_ ๐margin - default_
max_ ๐ironing_ out_ iterations - default_
mothball_ ๐years - default_
price_ ๐tolerance - default_
value_ ๐of_ lost_ load - set_
broken_ ๐model_ options_ flag - Set the global flag indicating whether broken model options are allowed.