Struct ModelParameters

pub struct ModelParameters {
    pub milestone_years: Vec<u32>,
    pub allow_broken_options: bool,
    pub candidate_asset_capacity: Capacity,
    pub pricing_strategy: PricingStrategy,
    pub capacity_limit_factor: Dimensionless,
    pub value_of_lost_load: MoneyPerFlow,
    pub max_ironing_out_iterations: u32,
    pub price_tolerance: Dimensionless,
}

Model parameters as defined in the model.toml file.

NOTE: If you add or change a field in this struct, you must also update the schema in schemas/input/model.yaml.

Fields

milestone_years: Vec<u32>

Milestone years

allow_broken_options: bool

Allow known-broken options to be enabled.

candidate_asset_capacity: Capacity

The (small) value of capacity given to candidate assets.

Don’t change unless you know what you’re doing.

pricing_strategy: PricingStrategy

Defines the strategy used for calculating commodity prices

capacity_limit_factor: Dimensionless

Affects the maximum capacity that can be given to a newly created asset.

It is the proportion of maximum capacity that could be required across time slices.

value_of_lost_load: MoneyPerFlow

The cost applied to unmet demand.

Currently this only applies to the LCOX appraisal.

max_ironing_out_iterations: u32

The maximum number of iterations to run the “ironing out” step of agent investment for

price_tolerance: Dimensionless

The relative tolerance for price convergence in the ironing out loop

Implementations

impl ModelParameters

pub fn from_path<P: AsRef<Path>>(model_dir: P) -> Result<ModelParameters>

Read a model file from the specified directory.

Arguments

• model_dir - Folder containing model configuration files

Returns

The model file contents as a ModelParameters struct or an error if the file is invalid

fn validate(&self) -> Result<()>

Validate parameters after reading in file

Trait Implementations

impl Debug for ModelParameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModelParameters

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ModelParameters

fn eq(&self, other: &ModelParameters) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ModelParameters