Module parameters 

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.

Structs

HighsOptions

Defines the TOML table holding the sub-tables to define HiGHS options

ModelParameters

Model parameters as defined in the model.toml file.

Constants

ALLOW_DANGEROUS_OPTION_NAME

The key in model.toml which enables potentially dangerous model options.

DEFAULT_REMAINING_DEMAND_ABSOLUTE_TOLERANCE 🔒

The default value for the remaining_demand_absolute_tolerance parameter

MODEL_PARAMETERS_FILE_NAME 🔒

Statics

DANGEROUS_OPTIONS_ENABLED 🔒

Global flag indicating whether potentially dangerous model options have been enabled.

Functions

check_capacity_margin 🔒

Check that the capacity_margin parameter is valid

check_highs_options 🔒

Check the custom HiGHS options are valid.

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_remaining_demand_absolute_tolerance 🔒

check_value_of_lost_load 🔒

Check that the value_of_lost_load parameter is valid

dangerous_model_options_enabled

Whether potentially dangerous model options were enabled by the loaded config.

set_dangerous_model_options_flag 🔒

Set the global flag indicating whether potentially dangerous model options are enabled.