Skip to content

Model Attributes Reference

This page documents the PLEXOS Model class attributes and their default values, validation rules, and descriptions.

Use this reference when setting configuration values through PlexosDB attributes, for example with add_attribute, get_attribute, and list_attributes.

NameUnitsDefault ValueValidation RuleDescription
EnabledYes/No0In (0,-1)If the model is ready to be executed
Execution Order-0>= 0Order in which to execute the Model when running in a batch.
Load Custom AssembliesYes/No-1In (0,-1)If the Model should run custom OpenPLEXOS assemblies.
Make Unique Name-0In (-1,0,1)If model output should be written to a unique filename for each execution
Objective Absolute Tolerance-0>= 0Allowable degradation for the objective when doing hierarchical multi-objective optimization for MIP models
Objective Priority-1>= 0Priority of the objective when doing hierarchical multi-objective optimization
Objective Relative Tolerance-0Between 0 And 1Allowable relative degradation for the objective when doing hierarchical multi-objective optimization for MIP models
Objective Weight-1Weight of the objective when doing blended multi-objective optimization
Output to FolderYes/No-1In (0,-1)If model output should be written to a folder under the source directory, or into the source folder itself
Random Number Seed-0Between 0 And 2147483647Random number seed for this model
Run Mode-0In (0,1)Switches between Normal and Dry run modes
Write InputYes/No0In (0,-1)If Model input should be written to the output location along with the solution.