Skip to content

Diagnostic Attributes Reference

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

To look at the open access PLEXOS documentation, go to PLEXOS Diagnostic Index.

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

NameUnitsDefault ValueValidation RuleDescription
AlgebraicYes/No0In (0,-1)Write LP files in algebraic format
AnnuitiesYes/No0In (0,-1)Write diagnostics for annuity calculations
ATC ReportsYes/No0In (0,-1)Write ATC min, ATC max, and most limiting elements for ATC to diagnostic files.
Bertrand PricingYes/No0In (0,-1)Write diagnostics for the Bertrand pricing algorithm
Bid-Cost Mark-upYes/No0In (0,-1)Write diagnostics for RSI bid cost markup calculations
Binary FilesYes/No0In (0,-1)Write math programs to disk in binary format
Binding ContingenciesYes/No0In (0,-1)Write diagnostics for binding Contingency constraints
Clear ExistingYes/No-1In (0,-1)Clear (delete) existing diagnostic files from the solution folder.
Computer InformationYes/No-1In (0,-1)Output computer information.
Congestion ChargesYes/No0In (0,-1)Write diagnostics for Node.[Congestion Charge] calculations
Constraint DecompositionYes/No0In (0,-1)Write diagnostics for constraint decomposition in MT Schedule
Constraint RolloverYes/No0In (0,-1)Write diagnostics for constraint RHS carry-over in ST Schedule
Data File ReadYes/No0In (0,-1)Output data file information to log file.
Database LoadYes/No0In (0,-1)Output the database loading process to log file.
Decimal Places LP-6>= 0Generic writer decimal places for LP file writing
Decimal Places SOL-6>= 0Generic writer decimal places for SOL file writing
Embedded LossesYes/No0In (0,-1)Write diagnostics for embedded loss iterations
Feasibility Repair WeightYes/No0In (0,-1)Write the weights used in feasibility repair for each variable/constraint class
Future Cost FunctionYes/No0In (0,-1)Write diagnostics for the future cost function.
Generic NamesYes/No0In (0,-1)Use generic names in math program files
Heat RateYes/No0In (0,-1)Write diagnostics for Generator Heat Rate curve fitting and non-convex corrections.
Historical SamplingYes/No0In (0,-1)Write the historical samples.
IISYes/No0In (0,-1)Compute the irreducibly inconsistent set (IIS) for each infeasibility and write to disk in text format
Infeasibility LP FilesYes/No0In (0,-1)Write infeasible and repaired math programs to disk in text format
Infeasibility MPS FilesYes/No0In (0,-1)Write infeasible and repaired math programs to disk in MPS format
InterleavedYes/No0In (0,-1)Write diagnostics for Model Interleaved run mode
Interruption SharingYes/No0In (0,-1)Write diagnostics for interruption sharing
Levelized Company CostsYes/No0In (0,-1)Write diagnostics for LT Plan Company Levelized Costs
LicensingYes/No0In (0,-1)Writes details of licenses checked out
LP FilesYes/No0In (0,-1)Write math programs to disk in LP text format
LP ProgressYes/No0In (0,-1)Show progress messages from the LP/QP solver
Marginal Expansion IncrementMW1000Increment used for load in the region marginal expansion unit diagnostic.
Marginal Expansion UnitYes/No0In (0,-1)Run algorithm to calculate the marginal generating unit for expansion (LT Plan).
Marginal Loss ChargesYes/No0In (0,-1)Write diagnostics for Node.[Marginal Loss Charge] calculations
Marginal UnitYes/No0In (0,-1)Execute region marginal unit diagnostic (this is an active diagnostic)
Marginal Unit IncrementMW-1Increment used for load in the marginal unit diagnostic.
Marginal Unit Transmission Detail-0In (0,1)Transmission area for marginal unit diagnostic
Max Infeasibility Log Lines--1>= -1Maximum number of infeasibility diagnostic lines written to the screen and log file.
MIP ProgressYes/No0In (0,-1)Show progress messages from the MIP solver
Monitored IterationsYes/No0In (0,-1)Print messages for every iteration of row/column monitoring
Monitored Iterations SummaryYes/No0In (0,-1)Print a summery message after iterations of row/column monitoring
MPS FilesYes/No0In (0,-1)Write math programs to disk in MPS text format
Network TraversalYes/No0In (0,-1)Invokes network reduction algorithm which can improve performance on large-scale networks.
New EntryYes/No0In (0,-1)Write diagnostics for MT Schedule new entry calculations
NPVYes/No0In (0,-1)Write diagnostics for LT Plan NPV of optimal plan
Objective FunctionYes/No0In (0,-1)Write diagnostics for non-zero terms in the objective function.
OutagesYes/No0In (0,-1)Write diagnostics for generator and line outages
Performance SummaryYes/No-1In (0,-1)Print performance summary at the completion of each simulation phase.
Random Number SeedYes/No0In (0,-1)Write out the Random Number Seed used for each Generator and Line
Region SupplyYes/No0In (0,-1)Execute region supply diagnostic (this is an active diagnostic)
Revenue RecoveryYes/No0In (0,-1)Write diagnostics for the LRMC recovery algorithm
Sample From-1>= 1Limit diagnostic file writing to sample numbers starting at this number.
Sample ReductionYes/No0In (0,-1)Write diagnostics for reduced sample periods and periods mapping by sampled chronology.
Sample SummaryYes/No0In (0,-1)Print summary for each sample of a multi-sample run.
Sample To--1>= -1Limit diagnostic file writing to sample numbers ending at this number (-1 means infinity).
Sample WeightsYes/No0In (0,-1)Write diagnostics for the sample weights
Scenario TreeYes/No0In (0,-1)Write diagnostics for the scenario tree
SDDP ConvergenceYes/No0In (0,-1)Write SDDP convergence diagnostic file
Shift FactorsYes/No0In (0,-1)Write the computed shift factors (PTDF) to a diagnostic file
Skip Zero ValuesYes/No0In (0,-1)Generic writer will print only non-zero valued primal and dual variables in SOL files
Solution FilesYes/No0In (0,-1)Write math program solutions to disk in text format
Solution StatusYes/No0In (0,-1)Status of the solution to each mathematical programming problem.
Solver SummaryYes/No0In (0,-1)Print a summary of the solution status, objective function value, etc for each mathematical program solved.
Sort Row Column NamesYes/No0In (0,-1)Generic writer will sort row and columns names
Standardize NamesYes/No0In (0,-1)Generic writer will standardize names in LP and SOL files
Step From-1>= 1Limit diagnostic file writing to step numbers starting at this number.
Step SummaryYes/No0In (0,-1)Print summary for each step of a multi-step run.
Step To--1>= -1Limit diagnostic file writing to step numbers ending at this number (-1 means infinity).
Storage DecompositionYes/No0In (0,-1)Write diagnostics for storage decomposition
Strip Model NameYes/No0In (0,-1)Generic writer will strip out the Model name from LP and SOL files
Summary Exact ConditioningYes/No0In (0,-1)Report exact basis condition number (if available) in the solver summary.
Task ComponentsYes/No0In (0,-1)Print a summary of the formulation elements by class.
Task SizeYes/No0In (0,-1)Print the size of the optimization task.
TimesYes/No-1In (0,-1)Print the time taken for each activity.
Transmission LossesYes/No0In (0,-1)Write diagnostics for convergence of the quadratic loss method
Transmission TopologyYes/No0In (0,-1)Write a summary of the transmission topology to the log
Uniform PricingYes/No0In (0,-1)Write diagnostics for uplift and Uniform Pricing
Unit CommitmentYes/No0In (0,-1)Write diagnostics for the Rounded Relaxation unit commitment algorithm
Unserved EnergyYes/No0In (0,-1)Write diagnostics each time USE occurs at a node
Use Generic WriterYes/No0In (0,-1)Use generic writer for LP and solution files
Zero Tolerance LP-0>= 0Generic writer zero value tolerance for LP file writing
Zero Tolerance SOL-0>= 0Generic writer zero value tolerance for SOL file writing