Options

The following properties are part of the command options

%growth	Set default annual growth rate, percent, for loads with no growth curve specified. Default is 2.5.
%mean	Percent mean to use for global load multiplier. Default is 65%.
%Normal	For step control of solution process: Pops control actions off the control queue according to the present control mode rules. Dispatches contol actions to proper control element "DoPendingAction" handlers.
%stddev	Percent Standard deviation to use for global load multiplier. Default is 9%.
ActiveActor	Gets/Sets the number of the active actor, if the value is * (set active actor=*), the commands send after this instruction will be aplied to all the actors.
ActorProgress	Gets progress (%) for all the actors when performing a task
Addtype	{Generator \| Capacitor} Default is Generator. Type of device for AutoAdd Mode.
ADiakoptics	{YES/TRUE \| NO/FALSE} Activates the A-Diakoptics solution algorithm for using spatial parallelization on the feeder. This parameter only affects Actor 1, no matter from which actor is called. When activated (True), OpenDSS will start the initialization routine for the A-Diakoptics solution mode
Algorithm	{Normal \| Newton \| NCIM} Solution algorithm type. Normal is a fixed point iteration that is a little quicker than the Newton iteration. Normal is adequate for most radial distribution circuits. Newton is more robust for circuits that are difficult to solve.NCIM or the N Conductor Current Injection Method is a Newton-Raphson based method to be used for Transmission like cases.
Allocationfactors	Sets the connected kVA allocation factors for all loads in the active circuit to the value given.
Allowduplicates	{YES/TRUE \| NO/FALSE} Default is No. Flag to indicate if it is OK to have devices of same name in the same class. If No, then a New command is treated as an Edit command. If Yes, then a New command will always result in a device being added.
Autobuslist	Array of bus names to include in AutoAdd searches. Or, you can specify a text file holding the names, one to a line, by using the syntax (file=filename) instead of the actual array elements. Default is null, which results in the program using either the buses in the EnergyMeter object zones or, if no EnergyMeters, all the buses, which can make for lengthy solution times. Examples: Set autobuslist=(bus1, bus2, bus3, ... ) Set autobuslist=(file=buslist.txt)
Basefrequency	Default = 60. Set the fundamental frequency for harmonic solution and the default base frequency for all impedance quantities. Side effect: also changes the value of the solution frequency. Saved as default for next circuit.
Bus	Set Active Bus by name. Can also be done with Select and SetkVBase commands and the "Set Terminal=" option. The bus connected to the active terminal becomes the active bus. See Zsc and Zsc012 commands.
CapkVAR	Size of capacitor, kVAR, to automatically add to system. Default is 600.0.
CapMarkerCode	Alignfile [file=]filename. Aligns DSS script files in columns for easier reading.
CapMarkerSize	Size of Capacitor marker. Default is 3.
Casename	Name of case for yearly simulations with demand interval data. Becomes the name of the subdirectory under which all the year data are stored. Default = circuit name Side Effect: Sets the prefix for output files
Cfactors	Sets the CFactors for for all loads in the active circuit to the value given.
circuit	Set the active circuit by name.
Cktmodel	{Multiphase \| Positive} Default = Multiphase. Designates whether circuit model is to interpreted as a normal multi-phase model or a positive-sequence only model
class	Synonym for Type=. (See above)
ConcatenateReports	Activates/Deactivates the option for concatenate the reports generated by the existing actors, if Yes, everytime the usera show/export monitor command the report will include the data generated by all the actors, otherwise the report will containThe data generated by the active actor
Controlmode	{OFF \| STATIC \|EVENT \| TIME} Default is "STATIC". Control mode for the solution. Set to OFF to prevent controls from changing. STATIC = Time does not advance. Control actions are executed in order of shortest time to act until all actions are cleared from the control queue. Use this mode for power flow solutions which may require several regulator tap changes per solution. EVENT = solution is event driven. Only the control actions nearest in time are executed and the time is advanced automatically to the time of the event. TIME = solution is time driven. Control actions are executed when the time for the pending action is reached or surpassed. Controls may reset and may choose not to act when it comes their time. Use TIME mode when modeling a control externally to the DSS and a solution mode such as DAILY or DUTYCYCLE that advances time, or set the time (hour and sec) explicitly from the external program.
Coverage	Percentage of coverage expected when estimating the longest paths on the circuit for tearing, the default coverage is the 90% (0.9), this value cannot exceed 1.0. When used with the "Set" command is used for the algorithm for estimating the paths within the circuit but when the "get" command is used after executing the tear_circuit command it will deliver the actual coverage after running the algorithm
CPU	(default -1)Gets/Sets the CPU to be used by the active actor. If negative (-1) means that the actor affinity is to all the CPUs and will be executed in the first available CPU and will be realocated into another CPU dynamically if the operating system requires it. By setting a CPU number for an actor will force the actor to be executed only on the specific CPU.
Daisysize	Default is 1.0. Relative size (a multiplier applied to default size) of daisy circles on daisy plot.
Datapath	Set the data path for files written or read by the DSS. Defaults to the user documents folder. If the DataPath is not writable, output files will be written to the user application data folder. May be Null. Executes a CHDIR to this path if non-null. Does not require a circuit defined.
DefaulBaseFrequency	Set Default Base Frequency, Hz. Side effect: Sets solution Frequency and default Circuit Base Frequency. This value is saved when the DSS closes down.
DefaultDaily	Default daily load shape name. Default value is "default", which is a 24-hour curve defined when the DSS is started.
DefaultYearly	Default yearly load shape name. Default value is "default", which is a 24-hour curve defined when the DSS is started.
DemandInterval	{YES/TRUE \| NO/FALSE} Default = no. Set for keeping demand interval data for daily, yearly, etc, simulations. Side Effect: Resets all meters!!!
DIVerbose	{YES/TRUE \| NO/FALSE} Default = FALSE. Set to Yes/True if you wish a separate demand interval (DI) file written for each meter. Otherwise, only the totalizing meters are written.
DSSVInstalled	Returns Yes/No if the OpenDSS Viewer installation is detected in the local machine (Read Only)
EarthModel	One of {Carson \| FullCarson \| Deri*}. Default is Deri, which isa fit to the Full Carson that works well into high frequencies. "Carson" is the simplified Carson method that is typically used for 50/60 Hz power flow programs. Applies only to Line objects that use LineGeometry objects to compute impedances.
editor	Set the command string required to start up the editor preferred by the user. Does not require a circuit defined.
element	Sets the active DSS element by name. You can use the complete object spec (class.name) or just the name. if full name is specifed, class becomes the active class, also.
emergvmaxpu	Maximum permissible per unit voltage for emergency (contingency) conditions. Default is 1.08.
emergvminpu	Minimum permissible per unit voltage for emergency (contingency) conditions. Default is 0.90.
EventLogDefault	{YES/TRUE \| NO/FALSE*} Sets/gets the default for the eventlog. After changing this flags the model needs to be recompiled to take effect.
frequency	Sets the frequency for the solution of the active circuit.
FuseMarkerCode	Numeric marker code (0..47 see Users Manual) for Fuse elements. Default is 25.
FuseMarkerSize	Size of Fuse marker. Default is 1.
Genkw	Size of generator, kW, to automatically add to system. Default is 1000.0
Genmult	Global multiplier for the kW output of every generator in the circuit. Default is 1.0. Applies to all but Autoadd solution modes. Ignored for generators designated as Status=Fixed.
Genpf	Power factor of generator to assume for automatic addition. Default is 1.0.
GISColor	Color : A Hex string defining 24 bit color in RGB format, e.g. , red = FF0000
GISCoords	[Coords] : An array of doubles defining the longitud and latitude for an area to be used as refrence for the OpenDSS-GIS related commands, long1, lat1, long2, lat2
GISInstalled	Returns Yes/No if the OpenDSS GIS installation is detected in the local machine (Read Only)
GISThickness	Thickness: An integer defining the thickness (default = 3)
h	Alternate name for time step size.
Harmonics	{ALL \| (list of harmonics) } Default = ALL. Array of harmonics for which to perform a solution in Harmonics mode. If ALL, then solution is performed for all harmonics defined in spectra currently being used. Otherwise, specify a more limited list such as: Set Harmonics=(1 5 7 11 13)
hour	Sets the hour used for the start time of the solution.
IgnoreGenQLimits	{YES/TRUE \| NO/FALSE*} Use this flag to indicate if you want to ignore the Q limits for generators during an NCIM solution. The default is NO/FALSE, signaling that generators will always respect their Q generation/absorption limits.
KeepList	Array of bus names to keep when performing circuit reductions. You can specify a text file holding the names, one to a line, by using the syntax (file=filename) instead of the actual array elements. Command is cumulative (reset keeplist first). Reduction algorithm may keep other buses automatically. Examples: Reset Keeplist (sets all buses to FALSE (no keep)) Set KeepList=(bus1, bus2, bus3, ... ) Set KeepList=(file=buslist.txt)
KeepLoad	Keeploads = Y/N option for ReduceOption Laterals option
LDCurve	Set Load-Duration Curve. Global load multiplier is defined by this curve for LD1 and LD2 solution modes. Default is Nil.
LineTypes	(Read only) Returns the list of line types available in the code for reference. These line types apply to lines, line codes, and line geometry objects.
LinkBranches	Get/set the names of the link branches used for tearing the circuit after initializing using set ADiakoptics = True. Using this instruction will set the Active Actor = 1 If ADiakoptics is not initialized, this instruction will return an error message
Loadmodel	{Powerflow \| Admittance} depending on the type of solution you wish to perform. If admittance, a non-iterative, direct solution is done with all loads and generators modeled by their equivalent admittance.
Loadmult	Global load multiplier for this circuit. Does not affect loads designated to be "fixed". All other base kW values are multiplied by this number. Defaults to 1.0 when the circuit is created. As with other values, it always stays at the last value to which it was set until changed again.
LoadShapeClass	={Daily \| Yearly \| Duty \| None*} Default loadshape class to use for mode=time and mode=dynamic simulations. Loads and generators, etc., will follow this shape as time is advanced. Default value is None. That is, Load will not vary with time.
Log	{YES/TRUE \| NO/FALSE} Default = FALSE. Significant solution events are added to the Event Log, primarily for debugging.
LongLineCorrection	{YES/TRUE \| NO/FALSE*} Defines whether the long-line correctlion is applied or not. Long-line correction only affects lines modelled with sequence components.
Lossregs	Which EnergyMeter register(s) to use for Losses in AutoAdd Mode. May be one or more registers. if more than one, register values are summed together. Array of integer values > 0. Defaults to 13 (for Zone kWh Losses). for a list of EnergyMeter register numbers, do the "Show Meters" command after defining a circuit.
Lossweight	Weighting factor for Losses in AutoAdd functions. Defaults to 1.0. Autoadd mode minimizes (Lossweight * Losses + UEweight * UE). If you wish to ignore Losses, set to 0. This applies only when there are EnergyMeter objects. Otherwise, AutoAdd mode minimizes total system losses.
MarkCapacitors	{YES/TRUE \| NO/FALSE} Default is NO. Mark Capacitor locations with a symbol. See CapMarkerCode.
Markercode	Number code for node marker on circuit plots. Number from 0 to 47. Default is 16 (open circle). 24 is solid circle. Try other values for other symbols. See also Nodewidth
MarkFuses	{YES/TRUE \| NO/FALSE} Default is NO. Mark Fuse locations with a symbol. See FuseMarkerCode and FuseMarkerSize.
MarkPVSystems	{YES/TRUE \| NO/FALSE} Default is NO. Mark PVSystem locations with a symbol. See PVMarkerCode and PVMarkerSize.
MarkReclosers	{YES/TRUE \| NO/FALSE} Default is NO. Mark Recloser locations with a symbol. See RecloserMarkerCode and RecloserMarkerSize.
MarkRegulators	{YES/TRUE \| NO/FALSE} Default is NO. Mark Regulator locations with a symbol. See RegMarkerCode.
MarkRelays	{YES/TRUE \| NO/FALSE} Default is NO. Mark Relay locations with a symbol. See RelayMarkerCode and RelayMarkerSize.
MarkStorage	{YES/TRUE \| NO/FALSE} Default is NO. Mark Storage locations with a symbol. See StoreMarkerCode and StoreMarkerSize.
Markswithces	{YES/TRUE \| NO/FALSE} Default is NO. Mark lines that are switches or are isolated with a symbol. See SwitchMarkerCode.
Marktransformers	{YES/TRUE \| NO/FALSE} Default is NO. Mark transformer locations with a symbol. See TransMarkerCode. The coordinate of one of the buses for winding 1 or 2 must be defined for the symbol to show
Maxcontroliter	Max control iterations per solution. Default is 10.
maxiterations	Sets the maximum allowable iterations for power flow solutions. Default is 15.
MinIterations	Minimum number of iterations required for a solution. Default is 2.
mode	Set the solution Mode: One of Snapshot, Daily, Yearly (follow Yearly curve), DIrect, DUtycycle, Time, ( see LoadShapeClass option) DYnamic, ( see LoadShapeClass option) Harmonic, HarmonicT, (sequential Harmonic Mode) M1 (Monte Carlo 1), M2 (Monte Carlo 2), M3 (Monte Carlo 3), Faultstudy, MF (monte carlo fault study) Peakday, LD1 (load-duration 1) LD2 (load-duration 2) AutoAdd (see AddType) YearlyVQ (Yearly Vector Quantiaztion) DutyVQ (Duty Vector Quantiaztion) Side effect: setting the Mode propergy resets all monitors and energy meters. It also resets the time step, etc. to defaults for each mode. After the initial reset, the user must explicitly reset the monitors and/or meters until another Set Mode= command.
NCIMQGain	{1.0*} Use this option to set a gain for the reactive power compensation provided by PV buses (generator model 3) when using the NCIM solution algorithm. The default value is 1.0.
NeglectLoadY	{YES/TRUE \| NO/FALSE} Default is NO. For Harmonic solution, neglect the Load shunt admittance branch that can siphon off some of the Load injection current. If YES, the current injected from the LOAD at harmonic frequencies will be nearly ideal.
Nodewidth	Width of node marker. Default=1. See MarkerCode
normvmaxpu	Maximum permissible per unit voltage for normal conditions. Default is 1.05.
normvminpu	Minimum permissible per unit voltage for normal conditions. Default is 0.95.
Num_SubCircuits	This is the number of subcircuits in which the circuit will be torn when executing the tear_circuit command, by default is the number of local CPUs - 1
NumActors	Delivers the number of Actors created by the user, 1 is the default
Numallociterations	Default is 2. Maximum number of iterations for load allocations for each time the AllocateLoads or Estimate command is given.
NUMANodes	Delivers the number of Non-uniform memory access nodes (NUMA Nodes) available on the machine (read Only). This information is vital when workingwith processor clusters (HPC). It will help you know the number of processors in the cluster
number	Number of solutions or time steps to perform for each Solve command. Defaults for selected modes: Daily = 24 Yearly = 8760 Duty = 100
NumCores	Delivers the number of physical processors (Cores) available on the computer. If your computers processor has less than 64 cores, this number should be equal to the half of the available CPUs, otherise the number should be the same (Read Only)
NumCPUs	Delivers the number of threads (CPUs) available on the machine (read Only)
object	Synonym for Element=. (See above)
OpenDSSViewer	Activates/Deactivates the extended version of the plot command for figures with the OpenDSS Viewer.
Overloadreport	{YES/TRUE \| NO/FALSE} Default = FALSE. For yearly solution mode, sets overload reporting on/off. DemandInterval must be set to true for this to have effect.
Parallel	Activates/Deactivates the parallel machine in OpenDSS, if deactivated OpenDSS will behave sequentially
Pricecurve	Sets the PRICESHAPE object to use to obtain for price signal. Default is none (null string). If none, price signal either remains constant or is set by an external process using Set Price= option. Curve is defined as a PRICESHAPE in actual values (not normalized) and should be defined to correspond to the type of analysis being performed (daily, yearly, etc.).
Pricesignal	Sets the present price signal ($/MWh) for the circuit. Default value is 25.
ProcessTime	The time in microseconds to execute the solve process in the most recent time step or solution (read only)
PVMarkerCode	Numeric marker code (0..47 see Users Manual) for PVSystems and PVSystem. Default is 15.
PVMarkerSize	Size of PVsystem and PVSystem markers. Default is 1.
QueryLog	{YES/TRUE \| NO/FALSE} Default = FALSE. When set to TRUE/YES, clears the query log file and thereafter appends the time-stamped Result string contents to the log file after a query command, ?.
random	One of [Uniform \| Gaussian \| Lognormal \| None ] for Monte Carlo Variables.
RecloserMarkerCode	Numeric marker code (0..47 see Users Manual) for Recloser elements. Default is 17. (color=Lime)
RecloserMarkerSize	Size of Recloser marker. Default is 5.
Recoder	{YES/TRUE \| NO/FALSE} Default = FALSE. Opens DSSRecorder.DSS in DSS install folder and enables recording of all commands that come through the text command interface. Closed by either setting to NO/FALSE or exiting the program. When closed by this command, the file name can be found in the Result. Does not require a circuit defined.
ReduceOption	{ Default or [null] \| Shortlines [Zmag=nnn] \| MergeParallel \| BreakLoops \| Switches \| Ends \| Laterals} Strategy for reducing feeders. Default is to eliminate all dangling end buses and buses without load, caps, or taps. "Shortlines [Zmag=0.02]" merges short branches with impedance less than Zmag (default = 0.02 ohms) "MergeParallel" merges lines that have been found to be in parallel "Breakloops" disables one of the lines at the head of a loop. "Ends" eliminates dangling ends only. "Switches" merges switches with downline lines and eliminates dangling switches. "Laterals [Keepload=Yes*/No]" uses the Remove command to eliminate 1-phase laterals and optionally lump the load back to the 2- or 3-phase feeder (default behavior). Marking buses with "Keeplist" will prevent their elimination.
RegistryUpdate	{YES/TRUE \| NO/FALSE} Default is Yes. Update Windows Registry values upon exiting. You might want to turn this off if you temporarily change fonts or DefaultBaseFrequency, for example.
RegMarkerCode	Numeric marker code (0..47 see Users Manual) for Regulators. Default is 17. (red)
RegMarkerSize	Size of Regulator marker. Default is 5.
RelayMarkerCode	Numeric marker code (0..47 see Users Manual) for Relay elements. Default is 17. (Color=Lime)
RelayMarkerSize	Size of Relay marker. Default is 5.
SampleEnergyMeters	{YES/TRUE \| NO/FALSE} Overrides default value for sampling EnergyMeter objects at the end of the solution loop. Normally Time and Duty modes do not automatically sample EnergyMeters whereas Daily, Yearly, M1, M2, M3, LD1 and LD2 modes do. Use this Option to turn sampling on or off
SeasonRating	{YES/TRUE \| NO/FALSE} Default = FALSE. Enables/disables the seasonal selection of the rating for determining if an element is overloaded. When enabled, the energy meter will look for the rating (NormAmps) using the SeasonSignal to evaluate if the PDElement is overloaded
SeasonSignal	It is the name of the XY curve defining the ratings seasonal change for the PDElements in the model when performing QSTS simulations. The seasonal ratings need to be definedat the PDElement or at the general object definition such as linecodes, lineGeometry, etc.
sec	Sets the seconds from the hour for the start time of the solution.
ShowExport	{YES/TRUE \| NO/FALSE} Default = FALSE. If YES/TRUE will automatically show the results of an Export Command after it is written.
ShowReports	{YES/TRUE \| NO/FALSE} Default = TRUE. If YES/TRUE will automatically show the results of a Show Command after it is written.
StateVar	Reads or Writes the value of the given state variable for the given PCE. Depending on the access mode (read/write) the syntax may vary. For writing the variable use the following syntax: set StateVar = myObjName myVarName myValue Where myObjName corresponds to the class and object name, for example, if you want to refer to generator Gen1, then myObjName will be Generator.Gen1. myVarName is the name of the state variable and myValue is the value to assign. For reading the state variable use the following syntax: get StateVar myObjName myVarName The reading structure will return the value in the results tab.
StepSize	Sets the time step size for the active circuit. Default units are s. May also be specified in minutes or hours by appending "m" or "h" to the value. For example: StepSize=.25h StepSize=15m StepSize=900s
StepTime	Process time + meter sampling time in microseconds for most recent time step - (read only)
StoreMarkerCode	Numeric marker code (0..47 see Users Manual) for Storage elements. Default is 9.
StoreMarkerSize	Size of Storage marker. Default is 1.
Switchmarkercode	Numeric marker code for lines with switches or are isolated from the circuit. Default is 4. See markswitches option.
Terminal	Set the active terminal of the active circuit element. May also be done with Select command.
time	Specify the solution start time as an array: time=(hour, secs)
tolerance	Sets the solution tolerance. Default is 0.0001.
TotalTime	The accumulated time in microseconds to solve the circuit since the last reset. Set this value to reset the accumulator.
Tracecontrol	{YES/TRUE \| NO/FALSE} Set to YES to trace the actions taken in the control queue. Creates a file named TRACE_CONTROLQUEUE.CSV in the default directory. The names of all circuit elements taking an action are logged.
TransMarkerCode	Numeric marker code (0..47 see Users Manual) for transformers. Default is 35. See markstransformers option.
TransMarkerSize	Size of transformer marker. Default is 1.
Trapezoidal	{YES/TRUE \| NO/FALSE} Default is "No/False". Specifies whether to use trapezoidal integration for accumulating energy meter registers. Applies to EnergyMeter and Generator objects. Default method simply multiplies the present value of the registers times the width of the interval (Euler). Trapezoidal is more accurate when there are sharp changes in a load shape or unequal intervals. Trapezoidal is automatically used for some load-duration curve simulations where the interval size varies considerably. Keep in mind that for Trapezoidal, you have to solve one more point than the number of intervals. That is, to do a Daily simulation on a 24-hr load shape, you would set Number=25 to force a solution at the first point again to establish the last (24th) interval. Note: Set Mode= resets Trapezoidal to No/False. Set this to Yes/True AFTER setting the Mode option.
type	Sets the active DSS class type. Same as Class=...
UEregs	Which EnergyMeter register(s) to use for UE in AutoAdd Mode. May be one or more registers. if more than one, register values are summed together. Array of integer values > 0. Defaults to 11 (for Load EEN). for a list of EnergyMeter register numbers, do the "Show Meters" command after defining a circuit.
UEweight	Weighting factor for UE/EEN in AutoAdd functions. Defaults to 1.0. Autoadd mode minimizes (Lossweight * Losses + UEweight * UE). If you wish to ignore UE, set to 0. This applies only when there are EnergyMeter objects. Otherwise, AutoAdd mode minimizes total system losses.
UseMyLinkBranches	{YES/TRUE \| NO/FALSE*} Set/get the boolean flag for indicating to the tearing algorithm the source of the link branches for tearing the model into sub-circuits. If FALSE, OpenDSS will use METIS for estimating the link branches to be used based on the number of sub-circuits given by the user through the command "set Num_SubCircuits".Otherwise, OpenDSS will use the list of link branches given by the user with the command "set LinkBranches"
Voltagesbases	Define legal bus voltage bases for this circuit. Enter an array of the legal voltage bases, in phase-to-phase voltages, for example: set voltagebases=".208, .480, 12.47, 24.9, 34.5, 115.0, 230.0" When the CalcVoltageBases command is issued, a snapshot solution is performed with no load injections and the bus base voltage is set to the nearest legal voltage base. The defaults are as shown in the example above.
Voltexceptionreport	{YES/TRUE \| NO/FALSE} Default = FALSE. For yearly solution mode, sets voltage exception reporting on/off. DemandInterval must be set to true for this to have effect.
year	Sets the Year (integer number) to be used for the solution. for certain solution types, this determines the growth multiplier.
Zmag	Sets the Zmag option (in Ohms) for ReduceOption Shortlines option. Lines have less line mode impedance are reduced.
Zonelock	{YES/TRUE \| NO/FALSE} Default is No. if No, then meter zones are recomputed each time there is a change in the circuit. If Yes, then meter zones are not recomputed unless they have not yet been computed. Meter zones are normally recomputed on Solve command following a circuit change.

© 2024 Electric Power Research Institute (EPRI), Inc. All rights reserved. Electric Power Research Institute and EPRI are registered marks of the Electric Power Research Institute, Inc. in the U.S. and worldwide.