The new DSS.Obj API

This represents a work-in-progress effort to expose all OpenDSS data classes to the end user without requiring frequent string manipulation. All data is available using native Python types and wrapper objects.

A new batch API is also integrated, allowing easy manipulation of multiple objects of the same type in a consistent manner.

Changes are expected to adjust naming of the properties. New features are also planned.

TODO: add minimal examples and links to further examples

This module exposes base objects for the pythonic Obj and Batch interfaces from DSS C-API. These interfaces are unique to DSS Extensions, they are not present in the official OpenDSS.

This is still under development and the final implementation might differ in some aspects.

Copyright (c) 2021-2022 Paulo Meira Copyright (c) 2021-2022 DSS Extensions contributors

Classes

AutoAddDeviceType(value) AutoAdd Device Type (DSS enumeration)
AutoTrans(api_util, ptr)
AutoTransBatch(api_util, **kwargs)
BatchFloat64ArrayProxy(batch, idx)
BatchInt32ArrayProxy(batch, idx)
CNData(api_util, ptr)
CNDataBatch(api_util, **kwargs)
CapControl(api_util, ptr)
CapControlBatch(api_util, **kwargs)
Capacitor(api_util, ptr)
CapacitorBatch(api_util, **kwargs)
CircuitModel(value) Circuit Model (DSS enumeration)
Connection(DSS enumeration)
ControlMode(value) Control Mode (DSS enumeration)
CoreType(value) Core Type (DSS enumeration)
DSSBatch(api_util, **kwargs)
DSSObj(api_util, ptr)
DimensionUnits(value) Dimension Units (DSS enumeration)
ESPVLControl(api_util, ptr)
ESPVLControlBatch(api_util, **kwargs)
EarthModel(value) Earth Model (DSS enumeration)
EnergyMeter(api_util, ptr)
EnergyMeterBatch(api_util, **kwargs)
ExpControl(api_util, ptr)
ExpControlBatch(api_util, **kwargs)
Fault(api_util, ptr)
FaultBatch(api_util, **kwargs)
Fuse(api_util, ptr)
FuseBatch(api_util, **kwargs)
GICLine(api_util, ptr)
GICLineBatch(api_util, **kwargs)
GICTransformer(api_util, ptr)
GICTransformerBatch(api_util, **kwargs)
GICsource(api_util, ptr)
GICsourceBatch(api_util, **kwargs)
GenDispatcher(api_util, ptr)
GenDispatcherBatch(api_util, **kwargs)
Generator(api_util, ptr)
GeneratorBatch(api_util, **kwargs)
GrowthShape(api_util, ptr)
GrowthShapeBatch(api_util, **kwargs)
IDSSObj(iobj, cls_idx, obj_cls, batch_cls)
IObj(api_util)
IndMach012(api_util, ptr)
IndMach012Batch(api_util, **kwargs)
InvControl(api_util, ptr)
InvControlBatch(api_util, **kwargs)
Isource(api_util, ptr)
IsourceBatch(api_util, **kwargs)
Line(api_util, ptr)
LineBatch(api_util, **kwargs)
LineCode(api_util, ptr)
LineCodeBatch(api_util, **kwargs)
LineGeometry(api_util, ptr)
LineGeometryBatch(api_util, **kwargs)
LineSpacing(api_util, ptr)
LineSpacingBatch(api_util, **kwargs)
LineType(value) Line Type (DSS enumeration)
Load(api_util, ptr)
LoadBatch(api_util, **kwargs)
LoadShape(api_util, ptr)
LoadShapeBatch(api_util, **kwargs)
LoadShapeClass(value) Load Shape Class (DSS enumeration)
LoadSolutionModel(value) Load Solution Model (DSS enumeration)
Monitor(api_util, ptr)
MonitorBatch(api_util, **kwargs)
MonitoredPhase(value) Monitored Phase (DSS enumeration)
PVSystem(api_util, ptr)
PVSystemBatch(api_util, **kwargs)
PhaseSequence(value) Phase Sequence (DSS enumeration)
PriceShape(api_util, ptr)
PriceShapeBatch(api_util, **kwargs)
RandomType(value) Random Type (DSS enumeration)
Reactor(api_util, ptr)
ReactorBatch(api_util, **kwargs)
Recloser(api_util, ptr)
RecloserBatch(api_util, **kwargs)
RegControl(api_util, ptr)
RegControlBatch(api_util, **kwargs)
Relay(api_util, ptr)
RelayBatch(api_util, **kwargs)
ScanType(value) Scan Type (DSS enumeration)
Sensor(api_util, ptr)
SensorBatch(api_util, **kwargs)
SequenceType(value) Sequence Type (DSS enumeration)
SolutionAlgorithm(value) Solution Algorithm (DSS enumeration)
SolutionMode(value) Solution Mode (DSS enumeration)
Spectrum(api_util, ptr)
SpectrumBatch(api_util, **kwargs)
Storage(api_util, ptr)
StorageBatch(api_util, **kwargs)
StorageController(api_util, ptr)
StorageControllerBatch(api_util, **kwargs)
SwtControl(api_util, ptr)
SwtControlBatch(api_util, **kwargs)
TCC_Curve(api_util, ptr)
TCC_CurveBatch(api_util, **kwargs)
TSData(api_util, ptr)
TSDataBatch(api_util, **kwargs)
TShape(api_util, ptr)
TShapeBatch(api_util, **kwargs)
Transformer(api_util, ptr)
TransformerBatch(api_util, **kwargs)
UPFC(api_util, ptr)
UPFCBatch(api_util, **kwargs)
UPFCControl(api_util, ptr)
UPFCControlBatch(api_util, **kwargs)
VCCS(api_util, ptr)
VCCSBatch(api_util, **kwargs)
VSConverter(api_util, ptr)
VSConverterBatch(api_util, **kwargs)
Vsource(api_util, ptr)
VsourceBatch(api_util, **kwargs)
WireData(api_util, ptr)
WireDataBatch(api_util, **kwargs)
XYcurve(api_util, ptr)
XYcurveBatch(api_util, **kwargs)
XfmrCode(api_util, ptr)
XfmrCodeBatch(api_util, **kwargs)
class dss.IObj.AutoAddDeviceType(value)

AutoAdd Device Type (DSS enumeration)

Capacitor = 2
Generator = 1
class dss.IObj.AutoTrans(api_util, ptr)
class AutoTransConnection(value)

AutoTrans: Connection (DSS enumeration for AutoTrans)

delta = 1
ll = 1
ln = 0
series = 2
wye = 0
y = 0
WdgCurrents()

(Read only) Makes winding currents available via return on query (? AutoTrans.TX.WdgCurrents). Order: Phase 1, Wdg 1, Wdg 2, …, Phase 2 …

DSS property name: WdgCurrents, DSS property index: 40.

Return type
str
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 48.

property Core: CoreType

{Shell*|5-leg|3-Leg|1-phase|core-1-phase|4-leg} Core Type. Used for GIC analysis in auxiliary programs. Not used inside OpenDSS.

DSS property name: Core, DSS property index: 11.

Return type
CoreType
property Core_str: str

{Shell*|5-leg|3-Leg|1-phase|core-1-phase|4-leg} Core Type. Used for GIC analysis in auxiliary programs. Not used inside OpenDSS.

DSS property name: Core, DSS property index: 11.

Return type
str
property LeadLag: PhaseSequence

{Lead | Lag (default) | ANSI (default) | Euro } Designation in mixed Delta-wye connections the relationship between HV to LV winding. Default is ANSI 30 deg lag, e.g., Dy1 of Yd1 vector group. To get typical European Dy11 connection, specify either “lead” or “Euro”

DSS property name: LeadLag, DSS property index: 39.

Return type
PhaseSequence
property LeadLag_str: str

{Lead | Lag (default) | ANSI (default) | Euro } Designation in mixed Delta-wye connections the relationship between HV to LV winding. Default is ANSI 30 deg lag, e.g., Dy1 of Yd1 vector group. To get typical European Dy11 connection, specify either “lead” or “Euro”

DSS property name: LeadLag, DSS property index: 39.

Return type
str
property MaxTap: ndarray[Any, dtype[float64]]

Max per unit tap for the active winding. Default is 1.10

DSS property name: MaxTap, DSS property index: 31.

Return type
ndarray[Any, dtype[float64]]
property MinTap: ndarray[Any, dtype[float64]]

Min per unit tap for the active winding. Default is 0.90

DSS property name: MinTap, DSS property index: 32.

Return type
ndarray[Any, dtype[float64]]
property NumTaps: ndarray[Any, dtype[int32]]

Total number of taps between min and max tap. Default is 32 (16 raise and 16 lower taps about the neutral position). The neutral position is not counted.

DSS property name: NumTaps, DSS property index: 33.

Return type
ndarray[Any, dtype[int32]]
property Rdcohms: ndarray[Any, dtype[float64]]

Winding dc resistance in OHMS. Specify this for GIC analysis. From transformer test report (divide by number of phases). Defaults to 85% of %R property (the ac value that includes stray losses).

DSS property name: Rdcohms, DSS property index: 10.

Return type
ndarray[Any, dtype[float64]]
property XHT: float

Use this to specify the percent reactance, H-T (winding 1 to winding 3). Use for 3-winding AutoTranss only. On the kVA base of winding 1(H-X).

DSS property name: XHT, DSS property index: 18.

Return type
float
property XHX: float

Use this to specify the percent reactance, H-L (winding 1 to winding 2). Use for 2- or 3-winding AutoTranss. On the kVA base of winding 1(H-X).

DSS property name: XHX, DSS property index: 17.

Return type
float
property XRConst: bool

={Yes|No} Default is NO. Signifies whether or not the X/R is assumed contant for harmonic studies.

DSS property name: XRConst, DSS property index: 38.

Return type
bool
property XSCarray: ndarray[Any, dtype[float64]]

Use this to specify the percent reactance between all pairs of windings as an array. All values are on the kVA base of winding 1. The order of the values is as follows:

(x12 13 14… 23 24.. 34 ..)

There will be n(n-1)/2 values, where n=number of windings.

DSS property name: XSCarray, DSS property index: 20.

Return type
ndarray[Any, dtype[float64]]
property XXT: float

Use this to specify the percent reactance, L-T (winding 2 to winding 3). Use for 3-winding AutoTranss only. On the kVA base of winding 1(H-X).

DSS property name: XXT, DSS property index: 19.

Return type
float
property basefreq: float

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 46.

Return type
float
property bus: List[str]

Bus connection spec for this winding.

DSS property name: bus, DSS property index: 4.

Return type
List[str]
property buses: List[str]

Use this to specify all the bus connections at once using an array. Example:

New AutoTrans.T1 buses=[Hbus, Xbus]

DSS property name: buses, DSS property index: 12.

Return type
List[str]
property conn: List[AutoTransConnection]

Connection of this winding {Series, wye*, Delta, LN, LL }. Default is “wye” with the neutral solidly grounded. For AutoTrans, Winding 1 is always Series and Winding 2 (the Common winding) is always Wye. If only 2 windings, no need to specify connections.

DSS property name: conn, DSS property index: 5.

Return type
List[AutoTransConnection]
property conn_str: List[str]

Connection of this winding {Series, wye*, Delta, LN, LL }. Default is “wye” with the neutral solidly grounded. For AutoTrans, Winding 1 is always Series and Winding 2 (the Common winding) is always Wye. If only 2 windings, no need to specify connections.

DSS property name: conn, DSS property index: 5.

Return type
List[str]
property conns: List[AutoTransConnection]

Use this to specify all the Winding connections at once using an array. Example:

New AutoTrans.T1 buses=[Hbus, Xbus] ~ conns=(series, wye)

DSS property name: conns, DSS property index: 13.

Return type
List[AutoTransConnection]
property conns_str: List[str]

Use this to specify all the Winding connections at once using an array. Example:

New AutoTrans.T1 buses=[Hbus, Xbus] ~ conns=(series, wye)

DSS property name: conns, DSS property index: 13.

Return type
List[str]
property emergamps: float

Maximum or emerg current.

DSS property name: emergamps, DSS property index: 42.

Return type
float
property emerghkVA: float

Emergency (contingency) kVA rating of H winding (winding 1+2). Usually 140% - 150% ofmaximum nameplate rating, depending on load shape. Defaults to 150% of kVA rating of Winding 1.

DSS property name: emerghkVA, DSS property index: 29.

Return type
float
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 47.

Return type
bool
property faultrate: float

Failure rate per year.

DSS property name: faultrate, DSS property index: 43.

Return type
float
property flrise: float

Temperature rise, deg C, for full load. Default is 65.

DSS property name: flrise, DSS property index: 24.

Return type
float
property hsrise: float

Hot spot temperature rise, deg C. Default is 15.

DSS property name: hsrise, DSS property index: 25.

Return type
float
property kV: ndarray[Any, dtype[float64]]

For 2-or 3-phase, enter phase-phase kV rating. Otherwise, kV rating of the actual winding. Specify H terminal kV rating for Series winding.

DSS property name: kV, DSS property index: 6.

Return type
ndarray[Any, dtype[float64]]
property kVA: ndarray[Any, dtype[float64]]

Base kVA rating of the winding. Side effect: forces change of max normal and emerg kVA ratings.If 2-winding AutoTrans, forces other winding to same value. When winding 1 is defined, all other windings are defaulted to the same rating and the first two winding resistances are defaulted to the %loadloss value.

DSS property name: kVA, DSS property index: 7.

Return type
ndarray[Any, dtype[float64]]
property kVAs: ndarray[Any, dtype[float64]]

Use this to specify the kVA ratings of all windings at once using an array.

DSS property name: kVAs, DSS property index: 15.

Return type
ndarray[Any, dtype[float64]]
property kVs: ndarray[Any, dtype[float64]]

Use this to specify the kV ratings of all windings at once using an array. Example:

New AutoTrans.T1 buses=[Hbus, Xbus] ~ conns=(series, wye) ~ kvs=(115, 12.47)

See kV= property for voltage rules.

DSS property name: kVs, DSS property index: 14.

Return type
ndarray[Any, dtype[float64]]
property m: float

m Exponent for thermal properties in IEEE C57. Typically 0.9 - 1.0

DSS property name: m, DSS property index: 23.

Return type
float
property n: float

n Exponent for thermal properties in IEEE C57. Typically 0.8.

DSS property name: n, DSS property index: 22.

Return type
float
property normamps: float

Normal rated current.

DSS property name: normamps, DSS property index: 41.

Return type
float
property normhkVA: float

Normal maximum kVA rating of H winding (winding 1+2). Usually 100% - 110% ofmaximum nameplate rating, depending on load shape. Defaults to 110% of kVA rating of Winding 1.

DSS property name: normhkVA, DSS property index: 28.

Return type
float
property pctR: ndarray[Any, dtype[float64]]

Percent ac resistance this winding. This value is for the power flow model.Is derived from the full load losses in the transformer test report.

DSS property name: %R, DSS property index: 9.

Return type
ndarray[Any, dtype[float64]]
property pctRs: ndarray[Any, dtype[float64]]

Use this property to specify all the winding ac %resistances using an array. Example:

New AutoTrans.T1 buses=[Hibus, lowbus] ~ %Rs=(0.2 0.3)

DSS property name: %Rs, DSS property index: 37.

Return type
ndarray[Any, dtype[float64]]
property pctimag: float

Percent magnetizing current. Default=0.0. Magnetizing branch is in parallel with windings in each phase. Also, see “ppm_antifloat”.

DSS property name: %imag, DSS property index: 35.

Return type
float
property pctloadloss: float

Percent load loss at full load. The %R of the High and Low windings (1 and 2) are adjusted to agree at rated kVA loading.

DSS property name: %loadloss, DSS property index: 26.

Return type
float
property pctnoloadloss: float

Percent no load losses at rated excitatation voltage. Default is 0. Converts to a resistance in parallel with the magnetizing impedance in each winding.

DSS property name: %noloadloss, DSS property index: 27.

Return type
float
property pctperm: float

Percent of failures that become permanent.

DSS property name: pctperm, DSS property index: 44.

Return type
float
property phases: int

Number of phases this AutoTrans. Default is 3.

DSS property name: phases, DSS property index: 1.

Return type
int
property ppm_antifloat: float

Default=1 ppm. Parts per million of AutoTrans winding VA rating connected to ground to protect against accidentally floating a winding without a reference. If positive then the effect is adding a very large reactance to ground. If negative, then a capacitor.

DSS property name: ppm_antifloat, DSS property index: 36.

Return type
float
property repair: float

Hours to repair.

DSS property name: repair, DSS property index: 45.

Return type
float
property sub: bool

={Yes|No} Designates whether this AutoTrans is to be considered a substation.Default is No.

DSS property name: sub, DSS property index: 30.

Return type
bool
property subname: str

Substation Name. Optional. Default is null. If specified, printed on plots

DSS property name: subname, DSS property index: 34.

Return type
str
property tap: ndarray[Any, dtype[float64]]

Per unit tap that this winding is on.

DSS property name: tap, DSS property index: 8.

Return type
ndarray[Any, dtype[float64]]
property taps: ndarray[Any, dtype[float64]]

Use this to specify the p.u. tap of all windings at once using an array.

DSS property name: taps, DSS property index: 16.

Return type
ndarray[Any, dtype[float64]]
property thermal: float

Thermal time constant of the AutoTrans in hours. Typically about 2.

DSS property name: thermal, DSS property index: 21.

Return type
float
property wdg: int

Set this = to the number of the winding you wish to define. Then set the values for this winding. Winding 1 is always the Series winding. Winding 2 is always Common winding (wye connected). Repeat for each winding. Alternatively, use the array collections (buses, kVAs, etc.) to define the windings. Note: reactances are BETWEEN pairs of windings; they are not the property of a single winding.

DSS property name: wdg, DSS property index: 3.

Return type
int
property windings: int

Number of windings, this AutoTranss. (Also is the number of terminals) Default is 2. This property triggers memory allocation for the AutoTrans and will cause other properties to revert to default values.

DSS property name: windings, DSS property index: 2.

Return type
int
class dss.IObj.AutoTransBatch(api_util, **kwargs)
WdgCurrents()

(Read only) Makes winding currents available via return on query (? AutoTrans.TX.WdgCurrents). Order: Phase 1, Wdg 1, Wdg 2, …, Phase 2 …

DSS property name: WdgCurrents, DSS property index: 40.

Return type
List[str]
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 48.

property Core: BatchInt32ArrayProxy

{Shell*|5-leg|3-Leg|1-phase|core-1-phase|4-leg} Core Type. Used for GIC analysis in auxiliary programs. Not used inside OpenDSS.

DSS property name: Core, DSS property index: 11.

Return type
BatchInt32ArrayProxy
property Core_str: str

{Shell*|5-leg|3-Leg|1-phase|core-1-phase|4-leg} Core Type. Used for GIC analysis in auxiliary programs. Not used inside OpenDSS.

DSS property name: Core, DSS property index: 11.

Return type
str
property LeadLag: BatchInt32ArrayProxy

{Lead | Lag (default) | ANSI (default) | Euro } Designation in mixed Delta-wye connections the relationship between HV to LV winding. Default is ANSI 30 deg lag, e.g., Dy1 of Yd1 vector group. To get typical European Dy11 connection, specify either “lead” or “Euro”

DSS property name: LeadLag, DSS property index: 39.

Return type
BatchInt32ArrayProxy
property LeadLag_str: str

{Lead | Lag (default) | ANSI (default) | Euro } Designation in mixed Delta-wye connections the relationship between HV to LV winding. Default is ANSI 30 deg lag, e.g., Dy1 of Yd1 vector group. To get typical European Dy11 connection, specify either “lead” or “Euro”

DSS property name: LeadLag, DSS property index: 39.

Return type
str
property MaxTap: List[ndarray[Any, dtype[float64]]]

Max per unit tap for the active winding. Default is 1.10

DSS property name: MaxTap, DSS property index: 31.

Return type
List[ndarray[Any, dtype[float64]]]
property MinTap: List[ndarray[Any, dtype[float64]]]

Min per unit tap for the active winding. Default is 0.90

DSS property name: MinTap, DSS property index: 32.

Return type
List[ndarray[Any, dtype[float64]]]
property NumTaps: List[ndarray[Any, dtype[int32]]]

Total number of taps between min and max tap. Default is 32 (16 raise and 16 lower taps about the neutral position). The neutral position is not counted.

DSS property name: NumTaps, DSS property index: 33.

Return type
List[ndarray[Any, dtype[int32]]]
property Rdcohms: List[ndarray[Any, dtype[float64]]]

Winding dc resistance in OHMS. Specify this for GIC analysis. From transformer test report (divide by number of phases). Defaults to 85% of %R property (the ac value that includes stray losses).

DSS property name: Rdcohms, DSS property index: 10.

Return type
List[ndarray[Any, dtype[float64]]]
property XHT: BatchFloat64ArrayProxy

Use this to specify the percent reactance, H-T (winding 1 to winding 3). Use for 3-winding AutoTranss only. On the kVA base of winding 1(H-X).

DSS property name: XHT, DSS property index: 18.

Return type
BatchFloat64ArrayProxy
property XHX: BatchFloat64ArrayProxy

Use this to specify the percent reactance, H-L (winding 1 to winding 2). Use for 2- or 3-winding AutoTranss. On the kVA base of winding 1(H-X).

DSS property name: XHX, DSS property index: 17.

Return type
BatchFloat64ArrayProxy
property XRConst: List[bool]

={Yes|No} Default is NO. Signifies whether or not the X/R is assumed contant for harmonic studies.

DSS property name: XRConst, DSS property index: 38.

Return type
List[bool]
property XSCarray: List[ndarray[Any, dtype[float64]]]

Use this to specify the percent reactance between all pairs of windings as an array. All values are on the kVA base of winding 1. The order of the values is as follows:

(x12 13 14… 23 24.. 34 ..)

There will be n(n-1)/2 values, where n=number of windings.

DSS property name: XSCarray, DSS property index: 20.

Return type
List[ndarray[Any, dtype[float64]]]
property XXT: BatchFloat64ArrayProxy

Use this to specify the percent reactance, L-T (winding 2 to winding 3). Use for 3-winding AutoTranss only. On the kVA base of winding 1(H-X).

DSS property name: XXT, DSS property index: 19.

Return type
BatchFloat64ArrayProxy
property basefreq: BatchFloat64ArrayProxy

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 46.

Return type
BatchFloat64ArrayProxy
property bus: List[List[str]]

Bus connection spec for this winding.

DSS property name: bus, DSS property index: 4.

Return type
List[List[str]]
property buses: List[List[str]]

Use this to specify all the bus connections at once using an array. Example:

New AutoTrans.T1 buses=[Hbus, Xbus]

DSS property name: buses, DSS property index: 12.

Return type
List[List[str]]
property conn: List[ndarray[Any, dtype[int32]]]

Connection of this winding {Series, wye*, Delta, LN, LL }. Default is “wye” with the neutral solidly grounded. For AutoTrans, Winding 1 is always Series and Winding 2 (the Common winding) is always Wye. If only 2 windings, no need to specify connections.

DSS property name: conn, DSS property index: 5.

Return type
List[ndarray[Any, dtype[int32]]]
property conn_str: List[List[str]]

Connection of this winding {Series, wye*, Delta, LN, LL }. Default is “wye” with the neutral solidly grounded. For AutoTrans, Winding 1 is always Series and Winding 2 (the Common winding) is always Wye. If only 2 windings, no need to specify connections.

DSS property name: conn, DSS property index: 5.

Return type
List[List[str]]
property conns: List[ndarray[Any, dtype[int32]]]

Use this to specify all the Winding connections at once using an array. Example:

New AutoTrans.T1 buses=[Hbus, Xbus] ~ conns=(series, wye)

DSS property name: conns, DSS property index: 13.

Return type
List[ndarray[Any, dtype[int32]]]
property conns_str: List[List[str]]

Use this to specify all the Winding connections at once using an array. Example:

New AutoTrans.T1 buses=[Hbus, Xbus] ~ conns=(series, wye)

DSS property name: conns, DSS property index: 13.

Return type
List[List[str]]
property emergamps: BatchFloat64ArrayProxy

Maximum or emerg current.

DSS property name: emergamps, DSS property index: 42.

Return type
BatchFloat64ArrayProxy
property emerghkVA: BatchFloat64ArrayProxy

Emergency (contingency) kVA rating of H winding (winding 1+2). Usually 140% - 150% ofmaximum nameplate rating, depending on load shape. Defaults to 150% of kVA rating of Winding 1.

DSS property name: emerghkVA, DSS property index: 29.

Return type
BatchFloat64ArrayProxy
property enabled: List[bool]

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 47.

Return type
List[bool]
property faultrate: BatchFloat64ArrayProxy

Failure rate per year.

DSS property name: faultrate, DSS property index: 43.

Return type
BatchFloat64ArrayProxy
property flrise: BatchFloat64ArrayProxy

Temperature rise, deg C, for full load. Default is 65.

DSS property name: flrise, DSS property index: 24.

Return type
BatchFloat64ArrayProxy
property hsrise: BatchFloat64ArrayProxy

Hot spot temperature rise, deg C. Default is 15.

DSS property name: hsrise, DSS property index: 25.

Return type
BatchFloat64ArrayProxy
property kV: List[ndarray[Any, dtype[float64]]]

For 2-or 3-phase, enter phase-phase kV rating. Otherwise, kV rating of the actual winding. Specify H terminal kV rating for Series winding.

DSS property name: kV, DSS property index: 6.

Return type
List[ndarray[Any, dtype[float64]]]
property kVA: List[ndarray[Any, dtype[float64]]]

Base kVA rating of the winding. Side effect: forces change of max normal and emerg kVA ratings.If 2-winding AutoTrans, forces other winding to same value. When winding 1 is defined, all other windings are defaulted to the same rating and the first two winding resistances are defaulted to the %loadloss value.

DSS property name: kVA, DSS property index: 7.

Return type
List[ndarray[Any, dtype[float64]]]
property kVAs: List[ndarray[Any, dtype[float64]]]

Use this to specify the kVA ratings of all windings at once using an array.

DSS property name: kVAs, DSS property index: 15.

Return type
List[ndarray[Any, dtype[float64]]]
property kVs: List[ndarray[Any, dtype[float64]]]

Use this to specify the kV ratings of all windings at once using an array. Example:

New AutoTrans.T1 buses=[Hbus, Xbus] ~ conns=(series, wye) ~ kvs=(115, 12.47)

See kV= property for voltage rules.

DSS property name: kVs, DSS property index: 14.

Return type
List[ndarray[Any, dtype[float64]]]
property m: BatchFloat64ArrayProxy

m Exponent for thermal properties in IEEE C57. Typically 0.9 - 1.0

DSS property name: m, DSS property index: 23.

Return type
BatchFloat64ArrayProxy
property n: BatchFloat64ArrayProxy

n Exponent for thermal properties in IEEE C57. Typically 0.8.

DSS property name: n, DSS property index: 22.

Return type
BatchFloat64ArrayProxy
property normamps: BatchFloat64ArrayProxy

Normal rated current.

DSS property name: normamps, DSS property index: 41.

Return type
BatchFloat64ArrayProxy
property normhkVA: BatchFloat64ArrayProxy

Normal maximum kVA rating of H winding (winding 1+2). Usually 100% - 110% ofmaximum nameplate rating, depending on load shape. Defaults to 110% of kVA rating of Winding 1.

DSS property name: normhkVA, DSS property index: 28.

Return type
BatchFloat64ArrayProxy
property pctR: List[ndarray[Any, dtype[float64]]]

Percent ac resistance this winding. This value is for the power flow model.Is derived from the full load losses in the transformer test report.

DSS property name: %R, DSS property index: 9.

Return type
List[ndarray[Any, dtype[float64]]]
property pctRs: List[ndarray[Any, dtype[float64]]]

Use this property to specify all the winding ac %resistances using an array. Example:

New AutoTrans.T1 buses=[Hibus, lowbus] ~ %Rs=(0.2 0.3)

DSS property name: %Rs, DSS property index: 37.

Return type
List[ndarray[Any, dtype[float64]]]
property pctimag: BatchFloat64ArrayProxy

Percent magnetizing current. Default=0.0. Magnetizing branch is in parallel with windings in each phase. Also, see “ppm_antifloat”.

DSS property name: %imag, DSS property index: 35.

Return type
BatchFloat64ArrayProxy
property pctloadloss: BatchFloat64ArrayProxy

Percent load loss at full load. The %R of the High and Low windings (1 and 2) are adjusted to agree at rated kVA loading.

DSS property name: %loadloss, DSS property index: 26.

Return type
BatchFloat64ArrayProxy
property pctnoloadloss: BatchFloat64ArrayProxy

Percent no load losses at rated excitatation voltage. Default is 0. Converts to a resistance in parallel with the magnetizing impedance in each winding.

DSS property name: %noloadloss, DSS property index: 27.

Return type
BatchFloat64ArrayProxy
property pctperm: BatchFloat64ArrayProxy

Percent of failures that become permanent.

DSS property name: pctperm, DSS property index: 44.

Return type
BatchFloat64ArrayProxy
property phases: BatchInt32ArrayProxy

Number of phases this AutoTrans. Default is 3.

DSS property name: phases, DSS property index: 1.

Return type
BatchInt32ArrayProxy
property ppm_antifloat: BatchFloat64ArrayProxy

Default=1 ppm. Parts per million of AutoTrans winding VA rating connected to ground to protect against accidentally floating a winding without a reference. If positive then the effect is adding a very large reactance to ground. If negative, then a capacitor.

DSS property name: ppm_antifloat, DSS property index: 36.

Return type
BatchFloat64ArrayProxy
property repair: BatchFloat64ArrayProxy

Hours to repair.

DSS property name: repair, DSS property index: 45.

Return type
BatchFloat64ArrayProxy
property sub: List[bool]

={Yes|No} Designates whether this AutoTrans is to be considered a substation.Default is No.

DSS property name: sub, DSS property index: 30.

Return type
List[bool]
property subname: List[str]

Substation Name. Optional. Default is null. If specified, printed on plots

DSS property name: subname, DSS property index: 34.

Return type
List[str]
property tap: List[ndarray[Any, dtype[float64]]]

Per unit tap that this winding is on.

DSS property name: tap, DSS property index: 8.

Return type
List[ndarray[Any, dtype[float64]]]
property taps: List[ndarray[Any, dtype[float64]]]

Use this to specify the p.u. tap of all windings at once using an array.

DSS property name: taps, DSS property index: 16.

Return type
List[ndarray[Any, dtype[float64]]]
property thermal: BatchFloat64ArrayProxy

Thermal time constant of the AutoTrans in hours. Typically about 2.

DSS property name: thermal, DSS property index: 21.

Return type
BatchFloat64ArrayProxy
property wdg: BatchInt32ArrayProxy

Set this = to the number of the winding you wish to define. Then set the values for this winding. Winding 1 is always the Series winding. Winding 2 is always Common winding (wye connected). Repeat for each winding. Alternatively, use the array collections (buses, kVAs, etc.) to define the windings. Note: reactances are BETWEEN pairs of windings; they are not the property of a single winding.

DSS property name: wdg, DSS property index: 3.

Return type
BatchInt32ArrayProxy
property windings: BatchInt32ArrayProxy

Number of windings, this AutoTranss. (Also is the number of terminals) Default is 2. This property triggers memory allocation for the AutoTrans and will cause other properties to revert to default values.

DSS property name: windings, DSS property index: 2.

Return type
BatchInt32ArrayProxy
class dss.IObj.BatchFloat64ArrayProxy(batch, idx)
to_array()
class dss.IObj.BatchInt32ArrayProxy(batch, idx)
to_array()
class dss.IObj.CNData(api_util, ptr)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 22.

property Capradius: float

Equivalent conductor radius for capacitance calcs. Specify this for bundled conductors. Defaults to same value as radius. Define Diam or Radius property first.

DSS property name: Capradius, DSS property index: 21.

Return type
float
property DiaCable: float

Diameter over cable; same units as radius; no default.

DSS property name: DiaCable, DSS property index: 8.

Return type
float
property DiaIns: float

Diameter over insulation layer; same units as radius; no default. Establishes outer radius for capacitance calculation.

DSS property name: DiaIns, DSS property index: 7.

Return type
float
property DiaStrand: float

Diameter of a concentric neutral strand; same units as core conductor radius; no default.

DSS property name: DiaStrand, DSS property index: 2.

Return type
float
property EpsR: float

Insulation layer relative permittivity; default is 2.3.

DSS property name: EpsR, DSS property index: 5.

Return type
float
property GMRac: float

GMR at 60 Hz. Defaults to .7788*radius if not specified.

DSS property name: GMRac, DSS property index: 12.

Return type
float
property GMRunits: DimensionUnits

Units for GMR: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: GMRunits, DSS property index: 13.

Return type
DimensionUnits
property GMRunits_str: str

Units for GMR: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: GMRunits, DSS property index: 13.

Return type
str
property GmrStrand: float

Geometric mean radius of a concentric neutral strand; same units as core conductor GMR; defaults to 0.7788 * CN strand radius.

DSS property name: GmrStrand, DSS property index: 3.

Return type
float
property InsLayer: float

Insulation layer thickness; same units as radius; no default. With DiaIns, establishes inner radius for capacitance calculation.

DSS property name: InsLayer, DSS property index: 6.

Return type
float
property Rac: float

Resistance at 60 Hz per unit length. Defaults to 1.02*Rdc if not specified.

DSS property name: Rac, DSS property index: 10.

Return type
float
property Ratings: ndarray[Any, dtype[float64]]

An array of ratings to be used when the seasonal ratings flag is True. It can be used to insert multiple ratings to change during a QSTS simulation to evaluate different ratings in lines.

DSS property name: Ratings, DSS property index: 20.

Return type
ndarray[Any, dtype[float64]]
property Rdc: float

dc Resistance, ohms per unit length (see Runits). Defaults to Rac/1.02 if not specified.

DSS property name: Rdc, DSS property index: 9.

Return type
float
property Rstrand: float

AC resistance of a concentric neutral strand; same units as core conductor resistance; no default.

DSS property name: Rstrand, DSS property index: 4.

Return type
float
property Runits: DimensionUnits

Length units for resistance: ohms per {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: Runits, DSS property index: 11.

Return type
DimensionUnits
property Runits_str: str

Length units for resistance: ohms per {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: Runits, DSS property index: 11.

Return type
str
property Seasons: int

Defines the number of ratings to be defined for the wire, to be used only when defining seasonal ratings using the “Ratings” property.

DSS property name: Seasons, DSS property index: 19.

Return type
int
property diam: float

Diameter; Alternative method for entering radius.

DSS property name: diam, DSS property index: 18.

Return type
float
property emergamps: float

Emergency ampacity, amperes. Defaults to 1.5 * Normal Amps if not specified.

DSS property name: emergamps, DSS property index: 17.

Return type
float
property k: int

Number of concentric neutral strands; default is 2

DSS property name: k, DSS property index: 1.

Return type
int
property normamps: float

Normal ampacity, amperes. Defaults to Emergency amps/1.5 if not specified.

DSS property name: normamps, DSS property index: 16.

Return type
float
property radius: float

Outside radius of conductor. Defaults to GMR/0.7788 if not specified.

DSS property name: radius, DSS property index: 14.

Return type
float
property radunits: DimensionUnits

Units for outside radius: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: radunits, DSS property index: 15.

Return type
DimensionUnits
property radunits_str: str

Units for outside radius: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: radunits, DSS property index: 15.

Return type
str
class dss.IObj.CNDataBatch(api_util, **kwargs)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 22.

property Capradius: BatchFloat64ArrayProxy

Equivalent conductor radius for capacitance calcs. Specify this for bundled conductors. Defaults to same value as radius. Define Diam or Radius property first.

DSS property name: Capradius, DSS property index: 21.

Return type
BatchFloat64ArrayProxy
property DiaCable: BatchFloat64ArrayProxy

Diameter over cable; same units as radius; no default.

DSS property name: DiaCable, DSS property index: 8.

Return type
BatchFloat64ArrayProxy
property DiaIns: BatchFloat64ArrayProxy

Diameter over insulation layer; same units as radius; no default. Establishes outer radius for capacitance calculation.

DSS property name: DiaIns, DSS property index: 7.

Return type
BatchFloat64ArrayProxy
property DiaStrand: BatchFloat64ArrayProxy

Diameter of a concentric neutral strand; same units as core conductor radius; no default.

DSS property name: DiaStrand, DSS property index: 2.

Return type
BatchFloat64ArrayProxy
property EpsR: BatchFloat64ArrayProxy

Insulation layer relative permittivity; default is 2.3.

DSS property name: EpsR, DSS property index: 5.

Return type
BatchFloat64ArrayProxy
property GMRac: BatchFloat64ArrayProxy

GMR at 60 Hz. Defaults to .7788*radius if not specified.

DSS property name: GMRac, DSS property index: 12.

Return type
BatchFloat64ArrayProxy
property GMRunits: BatchInt32ArrayProxy

Units for GMR: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: GMRunits, DSS property index: 13.

Return type
BatchInt32ArrayProxy
property GMRunits_str: str

Units for GMR: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: GMRunits, DSS property index: 13.

Return type
str
property GmrStrand: BatchFloat64ArrayProxy

Geometric mean radius of a concentric neutral strand; same units as core conductor GMR; defaults to 0.7788 * CN strand radius.

DSS property name: GmrStrand, DSS property index: 3.

Return type
BatchFloat64ArrayProxy
property InsLayer: BatchFloat64ArrayProxy

Insulation layer thickness; same units as radius; no default. With DiaIns, establishes inner radius for capacitance calculation.

DSS property name: InsLayer, DSS property index: 6.

Return type
BatchFloat64ArrayProxy
property Rac: BatchFloat64ArrayProxy

Resistance at 60 Hz per unit length. Defaults to 1.02*Rdc if not specified.

DSS property name: Rac, DSS property index: 10.

Return type
BatchFloat64ArrayProxy
property Ratings: List[ndarray[Any, dtype[float64]]]

An array of ratings to be used when the seasonal ratings flag is True. It can be used to insert multiple ratings to change during a QSTS simulation to evaluate different ratings in lines.

DSS property name: Ratings, DSS property index: 20.

Return type
List[ndarray[Any, dtype[float64]]]
property Rdc: BatchFloat64ArrayProxy

dc Resistance, ohms per unit length (see Runits). Defaults to Rac/1.02 if not specified.

DSS property name: Rdc, DSS property index: 9.

Return type
BatchFloat64ArrayProxy
property Rstrand: BatchFloat64ArrayProxy

AC resistance of a concentric neutral strand; same units as core conductor resistance; no default.

DSS property name: Rstrand, DSS property index: 4.

Return type
BatchFloat64ArrayProxy
property Runits: BatchInt32ArrayProxy

Length units for resistance: ohms per {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: Runits, DSS property index: 11.

Return type
BatchInt32ArrayProxy
property Runits_str: str

Length units for resistance: ohms per {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: Runits, DSS property index: 11.

Return type
str
property Seasons: BatchInt32ArrayProxy

Defines the number of ratings to be defined for the wire, to be used only when defining seasonal ratings using the “Ratings” property.

DSS property name: Seasons, DSS property index: 19.

Return type
BatchInt32ArrayProxy
property diam: BatchFloat64ArrayProxy

Diameter; Alternative method for entering radius.

DSS property name: diam, DSS property index: 18.

Return type
BatchFloat64ArrayProxy
property emergamps: BatchFloat64ArrayProxy

Emergency ampacity, amperes. Defaults to 1.5 * Normal Amps if not specified.

DSS property name: emergamps, DSS property index: 17.

Return type
BatchFloat64ArrayProxy
property k: BatchInt32ArrayProxy

Number of concentric neutral strands; default is 2

DSS property name: k, DSS property index: 1.

Return type
BatchInt32ArrayProxy
property normamps: BatchFloat64ArrayProxy

Normal ampacity, amperes. Defaults to Emergency amps/1.5 if not specified.

DSS property name: normamps, DSS property index: 16.

Return type
BatchFloat64ArrayProxy
property radius: BatchFloat64ArrayProxy

Outside radius of conductor. Defaults to GMR/0.7788 if not specified.

DSS property name: radius, DSS property index: 14.

Return type
BatchFloat64ArrayProxy
property radunits: BatchInt32ArrayProxy

Units for outside radius: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: radunits, DSS property index: 15.

Return type
BatchInt32ArrayProxy
property radunits_str: str

Units for outside radius: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: radunits, DSS property index: 15.

Return type
str
class dss.IObj.CapControl(api_util, ptr)
class CapControlType(value)

CapControl: Type (DSS enumeration for CapControl)

Current = 0
PowerFactor = 4
Time = 3
Voltage = 1
kvar = 2
Reset(value)

{Yes | No} If Yes, forces Reset of this CapControl.

DSS property name: Reset, DSS property index: 22.

like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 25.

property CTPhase: Union[MonitoredPhase, int]

Number of the phase being monitored for CURRENT control or one of {AVG | MAX | MIN} for all phases. Default=1. If delta or L-L connection, enter the first or the two phases being monitored [1-2, 2-3, 3-1]. Must be less than the number of phases. Does not apply to kvar control which uses all phases by default.

DSS property name: CTPhase, DSS property index: 15.

Return type
Union[MonitoredPhase, int]
property CTPhase_str: str

Number of the phase being monitored for CURRENT control or one of {AVG | MAX | MIN} for all phases. Default=1. If delta or L-L connection, enter the first or the two phases being monitored [1-2, 2-3, 3-1]. Must be less than the number of phases. Does not apply to kvar control which uses all phases by default.

DSS property name: CTPhase, DSS property index: 15.

Return type
str
property CTratio: float

Ratio of the CT from line amps to control ampere setting for current and kvar control types.

DSS property name: CTratio, DSS property index: 6.

Return type
float
property DeadTime: float

Dead time after capacitor is turned OFF before it can be turned back ON. Default is 300 sec.

DSS property name: DeadTime, DSS property index: 14.

Return type
float
property Delay: float

Time delay, in seconds, from when the control is armed before it sends out the switching command to turn ON. The control may reset before the action actually occurs. This is used to determine which capacity control will act first. Default is 15. You may specify any floating point number to achieve a model of whatever condition is necessary.

DSS property name: Delay, DSS property index: 9.

Return type
float
property DelayOFF: float

Time delay, in seconds, for control to turn OFF when present state is ON. Default is 15.

DSS property name: DelayOFF, DSS property index: 13.

Return type
float
property EventLog: bool

{Yes/True* | No/False} Default is YES for CapControl. Log control actions to Eventlog.

DSS property name: EventLog, DSS property index: 18.

Return type
bool
property OFFsetting: float

Value at which the control arms to switch the capacitor OFF. (See help for ONsetting)For Time control, is OK to have Off time the next day ( < On time)

DSS property name: OFFsetting, DSS property index: 8.

Return type
float
property ONsetting: float

Value at which the control arms to switch the capacitor ON (or ratchet up a step).

Type of Control:

Current: Line Amps / CTratio Voltage: Line-Neutral (or Line-Line for delta) Volts / PTratio kvar: Total kvar, all phases (3-phase for pos seq model). This is directional. PF: Power Factor, Total power in monitored terminal. Negative for Leading. Time: Hrs from Midnight as a floating point number (decimal). 7:30am would be entered as 7.5.

DSS property name: ONsetting, DSS property index: 7.

Return type
float
property PTPhase: Union[MonitoredPhase, int]

Number of the phase being monitored for VOLTAGE control or one of {AVG | MAX | MIN} for all phases. Default=1. If delta or L-L connection, enter the first or the two phases being monitored [1-2, 2-3, 3-1]. Must be less than the number of phases. Does not apply to kvar control which uses all phases by default.

DSS property name: PTPhase, DSS property index: 16.

Return type
Union[MonitoredPhase, int]
property PTPhase_str: str

Number of the phase being monitored for VOLTAGE control or one of {AVG | MAX | MIN} for all phases. Default=1. If delta or L-L connection, enter the first or the two phases being monitored [1-2, 2-3, 3-1]. Must be less than the number of phases. Does not apply to kvar control which uses all phases by default.

DSS property name: PTPhase, DSS property index: 16.

Return type
str
property PTratio: float

Ratio of the PT that converts the monitored voltage to the control voltage. Default is 60. If the capacitor is Wye, the 1st phase line-to-neutral voltage is monitored. Else, the line-to-line voltage (1st - 2nd phase) is monitored.

DSS property name: PTratio, DSS property index: 5.

Return type
float
property UserData: str

String (in quotes or parentheses if necessary) that gets passed to the user-written CapControl model Edit function for defining the data required for that model.

DSS property name: UserData, DSS property index: 20.

Return type
str
property UserModel: str

Name of DLL containing user-written CapControl model, overriding the default model. Set to “none” to negate previous setting.

DSS property name: UserModel, DSS property index: 19.

Return type
str
property VBus: str

Name of bus to use for voltage override function. Default is bus at monitored terminal. Sometimes it is useful to monitor a bus in another location to emulate various DMS control algorithms.

DSS property name: VBus, DSS property index: 17.

Return type
str
property Vmax: float

Maximum voltage, in volts. If the voltage across the capacitor divided by the PTRATIO is greater than this voltage, the capacitor will switch OFF regardless of other control settings. Default is 126 (goes with a PT ratio of 60 for 12.47 kV system).

DSS property name: Vmax, DSS property index: 11.

Return type
float
property Vmin: float

Minimum voltage, in volts. If the voltage across the capacitor divided by the PTRATIO is less than this voltage, the capacitor will switch ON regardless of other control settings. Default is 115 (goes with a PT ratio of 60 for 12.47 kV system).

DSS property name: Vmin, DSS property index: 12.

Return type
float
property VoltOverride: bool

{Yes | No} Default is No. Switch to indicate whether VOLTAGE OVERRIDE is to be considered. Vmax and Vmin must be set to reasonable values if this property is Yes.

DSS property name: VoltOverride, DSS property index: 10.

Return type
bool
property basefreq: float

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 23.

Return type
float
property capacitor: str

Name of Capacitor element which the CapControl controls. No Default; Must be specified.Do not specify the full object name; “Capacitor” is assumed for the object class. Example:

Capacitor=cap1

DSS property name: capacitor, DSS property index: 3.

Return type
str
property capacitor_obj: Capacitor

Name of Capacitor element which the CapControl controls. No Default; Must be specified.Do not specify the full object name; “Capacitor” is assumed for the object class. Example:

Capacitor=cap1

DSS property name: capacitor, DSS property index: 3.

Return type
Capacitor
property element: str

Full object name of the circuit element, typically a line or transformer, to which the capacitor control’s PT and/or CT are connected.There is no default; must be specified.

DSS property name: element, DSS property index: 1.

Return type
str
property element_obj: DSSObj

Full object name of the circuit element, typically a line or transformer, to which the capacitor control’s PT and/or CT are connected.There is no default; must be specified.

DSS property name: element, DSS property index: 1.

Return type
DSSObj
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 24.

Return type
bool
property pctMinkvar: float

For PF control option, min percent of total bank kvar at which control will close capacitor switch. Default = 50.

DSS property name: pctMinkvar, DSS property index: 21.

Return type
float
property terminal: int

Number of the terminal of the circuit element to which the CapControl is connected. 1 or 2, typically. Default is 1.

DSS property name: terminal, DSS property index: 2.

Return type
int
property type: CapControlType

{Current | voltage | kvar | PF | time } Control type. Specify the ONsetting and OFFsetting appropriately with the type of control. (See help for ONsetting)

DSS property name: type, DSS property index: 4.

Return type
CapControlType
property type_str: str

{Current | voltage | kvar | PF | time } Control type. Specify the ONsetting and OFFsetting appropriately with the type of control. (See help for ONsetting)

DSS property name: type, DSS property index: 4.

Return type
str
class dss.IObj.CapControlBatch(api_util, **kwargs)
Reset(value)

{Yes | No} If Yes, forces Reset of this CapControl.

DSS property name: Reset, DSS property index: 22.

like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 25.

property CTPhase: BatchInt32ArrayProxy

Number of the phase being monitored for CURRENT control or one of {AVG | MAX | MIN} for all phases. Default=1. If delta or L-L connection, enter the first or the two phases being monitored [1-2, 2-3, 3-1]. Must be less than the number of phases. Does not apply to kvar control which uses all phases by default.

DSS property name: CTPhase, DSS property index: 15.

Return type
BatchInt32ArrayProxy
property CTPhase_str: str

Number of the phase being monitored for CURRENT control or one of {AVG | MAX | MIN} for all phases. Default=1. If delta or L-L connection, enter the first or the two phases being monitored [1-2, 2-3, 3-1]. Must be less than the number of phases. Does not apply to kvar control which uses all phases by default.

DSS property name: CTPhase, DSS property index: 15.

Return type
str
property CTratio: BatchFloat64ArrayProxy

Ratio of the CT from line amps to control ampere setting for current and kvar control types.

DSS property name: CTratio, DSS property index: 6.

Return type
BatchFloat64ArrayProxy
property DeadTime: BatchFloat64ArrayProxy

Dead time after capacitor is turned OFF before it can be turned back ON. Default is 300 sec.

DSS property name: DeadTime, DSS property index: 14.

Return type
BatchFloat64ArrayProxy
property Delay: BatchFloat64ArrayProxy

Time delay, in seconds, from when the control is armed before it sends out the switching command to turn ON. The control may reset before the action actually occurs. This is used to determine which capacity control will act first. Default is 15. You may specify any floating point number to achieve a model of whatever condition is necessary.

DSS property name: Delay, DSS property index: 9.

Return type
BatchFloat64ArrayProxy
property DelayOFF: BatchFloat64ArrayProxy

Time delay, in seconds, for control to turn OFF when present state is ON. Default is 15.

DSS property name: DelayOFF, DSS property index: 13.

Return type
BatchFloat64ArrayProxy
property EventLog: List[bool]

{Yes/True* | No/False} Default is YES for CapControl. Log control actions to Eventlog.

DSS property name: EventLog, DSS property index: 18.

Return type
List[bool]
property OFFsetting: BatchFloat64ArrayProxy

Value at which the control arms to switch the capacitor OFF. (See help for ONsetting)For Time control, is OK to have Off time the next day ( < On time)

DSS property name: OFFsetting, DSS property index: 8.

Return type
BatchFloat64ArrayProxy
property ONsetting: BatchFloat64ArrayProxy

Value at which the control arms to switch the capacitor ON (or ratchet up a step).

Type of Control:

Current: Line Amps / CTratio Voltage: Line-Neutral (or Line-Line for delta) Volts / PTratio kvar: Total kvar, all phases (3-phase for pos seq model). This is directional. PF: Power Factor, Total power in monitored terminal. Negative for Leading. Time: Hrs from Midnight as a floating point number (decimal). 7:30am would be entered as 7.5.

DSS property name: ONsetting, DSS property index: 7.

Return type
BatchFloat64ArrayProxy
property PTPhase: BatchInt32ArrayProxy

Number of the phase being monitored for VOLTAGE control or one of {AVG | MAX | MIN} for all phases. Default=1. If delta or L-L connection, enter the first or the two phases being monitored [1-2, 2-3, 3-1]. Must be less than the number of phases. Does not apply to kvar control which uses all phases by default.

DSS property name: PTPhase, DSS property index: 16.

Return type
BatchInt32ArrayProxy
property PTPhase_str: str

Number of the phase being monitored for VOLTAGE control or one of {AVG | MAX | MIN} for all phases. Default=1. If delta or L-L connection, enter the first or the two phases being monitored [1-2, 2-3, 3-1]. Must be less than the number of phases. Does not apply to kvar control which uses all phases by default.

DSS property name: PTPhase, DSS property index: 16.

Return type
str
property PTratio: BatchFloat64ArrayProxy

Ratio of the PT that converts the monitored voltage to the control voltage. Default is 60. If the capacitor is Wye, the 1st phase line-to-neutral voltage is monitored. Else, the line-to-line voltage (1st - 2nd phase) is monitored.

DSS property name: PTratio, DSS property index: 5.

Return type
BatchFloat64ArrayProxy
property UserData: List[str]

String (in quotes or parentheses if necessary) that gets passed to the user-written CapControl model Edit function for defining the data required for that model.

DSS property name: UserData, DSS property index: 20.

Return type
List[str]
property UserModel: List[str]

Name of DLL containing user-written CapControl model, overriding the default model. Set to “none” to negate previous setting.

DSS property name: UserModel, DSS property index: 19.

Return type
List[str]
property VBus: List[str]

Name of bus to use for voltage override function. Default is bus at monitored terminal. Sometimes it is useful to monitor a bus in another location to emulate various DMS control algorithms.

DSS property name: VBus, DSS property index: 17.

Return type
List[str]
property Vmax: BatchFloat64ArrayProxy

Maximum voltage, in volts. If the voltage across the capacitor divided by the PTRATIO is greater than this voltage, the capacitor will switch OFF regardless of other control settings. Default is 126 (goes with a PT ratio of 60 for 12.47 kV system).

DSS property name: Vmax, DSS property index: 11.

Return type
BatchFloat64ArrayProxy
property Vmin: BatchFloat64ArrayProxy

Minimum voltage, in volts. If the voltage across the capacitor divided by the PTRATIO is less than this voltage, the capacitor will switch ON regardless of other control settings. Default is 115 (goes with a PT ratio of 60 for 12.47 kV system).

DSS property name: Vmin, DSS property index: 12.

Return type
BatchFloat64ArrayProxy
property VoltOverride: List[bool]

{Yes | No} Default is No. Switch to indicate whether VOLTAGE OVERRIDE is to be considered. Vmax and Vmin must be set to reasonable values if this property is Yes.

DSS property name: VoltOverride, DSS property index: 10.

Return type
List[bool]
property basefreq: BatchFloat64ArrayProxy

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 23.

Return type
BatchFloat64ArrayProxy
property capacitor: List[str]

Name of Capacitor element which the CapControl controls. No Default; Must be specified.Do not specify the full object name; “Capacitor” is assumed for the object class. Example:

Capacitor=cap1

DSS property name: capacitor, DSS property index: 3.

Return type
List[str]
property capacitor_obj: List[str]

Name of Capacitor element which the CapControl controls. No Default; Must be specified.Do not specify the full object name; “Capacitor” is assumed for the object class. Example:

Capacitor=cap1

DSS property name: capacitor, DSS property index: 3.

Return type
List[str]
property element: List[str]

Full object name of the circuit element, typically a line or transformer, to which the capacitor control’s PT and/or CT are connected.There is no default; must be specified.

DSS property name: element, DSS property index: 1.

Return type
List[str]
property element_obj: List[str]

Full object name of the circuit element, typically a line or transformer, to which the capacitor control’s PT and/or CT are connected.There is no default; must be specified.

DSS property name: element, DSS property index: 1.

Return type
List[str]
property enabled: List[bool]

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 24.

Return type
List[bool]
property pctMinkvar: BatchFloat64ArrayProxy

For PF control option, min percent of total bank kvar at which control will close capacitor switch. Default = 50.

DSS property name: pctMinkvar, DSS property index: 21.

Return type
BatchFloat64ArrayProxy
property terminal: BatchInt32ArrayProxy

Number of the terminal of the circuit element to which the CapControl is connected. 1 or 2, typically. Default is 1.

DSS property name: terminal, DSS property index: 2.

Return type
BatchInt32ArrayProxy
property type: BatchInt32ArrayProxy

{Current | voltage | kvar | PF | time } Control type. Specify the ONsetting and OFFsetting appropriately with the type of control. (See help for ONsetting)

DSS property name: type, DSS property index: 4.

Return type
BatchInt32ArrayProxy
property type_str: str

{Current | voltage | kvar | PF | time } Control type. Specify the ONsetting and OFFsetting appropriately with the type of control. (See help for ONsetting)

DSS property name: type, DSS property index: 4.

Return type
str
class dss.IObj.Capacitor(api_util, ptr)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 21.

property Harm: ndarray[Any, dtype[float64]]

ARRAY of harmonics to which each step is tuned. Zero is interpreted as meaning zero reactance (no filter). Default is zero.

DSS property name: Harm, DSS property index: 11.

Return type
ndarray[Any, dtype[float64]]
property Numsteps: int

Number of steps in this capacitor bank. Default = 1. Forces reallocation of the capacitance, reactor, and states array. Rules: If this property was previously =1, the value in the kvar property is divided equally among the steps. The kvar property does not need to be reset if that is accurate. If the Cuf or Cmatrix property was used previously, all steps are set to the value of the first step. The states property is set to all steps on. All filter steps are set to the same harmonic. If this property was previously >1, the arrays are reallocated, but no values are altered. You must SUBSEQUENTLY assign all array properties.

DSS property name: Numsteps, DSS property index: 12.

Return type
int
property R: ndarray[Any, dtype[float64]]

ARRAY of series resistance in each phase (line), ohms. Default is 0.0

DSS property name: R, DSS property index: 9.

Return type
ndarray[Any, dtype[float64]]
property XL: ndarray[Any, dtype[float64]]

ARRAY of series inductive reactance(s) in each phase (line) for filter, ohms at base frequency. Use this OR “h” property to define filter. Default is 0.0.

DSS property name: XL, DSS property index: 10.

Return type
ndarray[Any, dtype[float64]]
property basefreq: float

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 19.

Return type
float
property bus1: str

Name of first bus of 2-terminal capacitor. Examples: bus1=busname bus1=busname.1.2.3

If only one bus specified, Bus2 will default to this bus, Node 0, and the capacitor will be a Yg shunt bank.

DSS property name: bus1, DSS property index: 1.

Return type
str
property bus2: str

Name of 2nd bus. Defaults to all phases connected to first bus, node 0, (Shunt Wye Connection) except when Bus2 explicitly specified.

Not necessary to specify for delta (LL) connection.

DSS property name: bus2, DSS property index: 2.

Return type
str
property cmatrix: ndarray[Any, dtype[float64]]

Nodal cap. matrix, lower triangle, microfarads, of the following form:

cmatrix=”c11 | -c21 c22 | -c31 -c32 c33”

All steps are assumed the same if this property is used.

DSS property name: cmatrix, DSS property index: 7.

Return type
ndarray[Any, dtype[float64]]
property conn: Connection

={wye | delta |LN |LL} Default is wye, which is equivalent to LN

DSS property name: conn, DSS property index: 6.

Return type
Connection
property conn_str: str

={wye | delta |LN |LL} Default is wye, which is equivalent to LN

DSS property name: conn, DSS property index: 6.

Return type
str
property cuf: ndarray[Any, dtype[float64]]

ARRAY of Capacitance, each phase, for each step, microfarads. See Rules for NumSteps.

DSS property name: cuf, DSS property index: 8.

Return type
ndarray[Any, dtype[float64]]
property emergamps: float

Maximum or emerg current.

DSS property name: emergamps, DSS property index: 15.

Return type
float
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 20.

Return type
bool
property faultrate: float

Failure rate per year.

DSS property name: faultrate, DSS property index: 16.

Return type
float
property kv: float

For 2, 3-phase, kV phase-phase. Otherwise specify actual can rating.

DSS property name: kv, DSS property index: 5.

Return type
float
property kvar: ndarray[Any, dtype[float64]]

Total kvar, if one step, or ARRAY of kvar ratings for each step. Evenly divided among phases. See rules for NUMSTEPS.

DSS property name: kvar, DSS property index: 4.

Return type
ndarray[Any, dtype[float64]]
property normamps: float

Normal rated current.

DSS property name: normamps, DSS property index: 14.

Return type
float
property pctperm: float

Percent of failures that become permanent.

DSS property name: pctperm, DSS property index: 17.

Return type
float
property phases: int

Number of phases.

DSS property name: phases, DSS property index: 3.

Return type
int
property repair: float

Hours to repair.

DSS property name: repair, DSS property index: 18.

Return type
float
property states: ndarray[Any, dtype[int32]]

ARRAY of integers {1|0} states representing the state of each step (on|off). Defaults to 1 when reallocated (on). Capcontrol will modify this array as it turns steps on or off.

DSS property name: states, DSS property index: 13.

Return type
ndarray[Any, dtype[int32]]
class dss.IObj.CapacitorBatch(api_util, **kwargs)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 21.

property Harm: List[ndarray[Any, dtype[float64]]]

ARRAY of harmonics to which each step is tuned. Zero is interpreted as meaning zero reactance (no filter). Default is zero.

DSS property name: Harm, DSS property index: 11.

Return type
List[ndarray[Any, dtype[float64]]]
property Numsteps: BatchInt32ArrayProxy

Number of steps in this capacitor bank. Default = 1. Forces reallocation of the capacitance, reactor, and states array. Rules: If this property was previously =1, the value in the kvar property is divided equally among the steps. The kvar property does not need to be reset if that is accurate. If the Cuf or Cmatrix property was used previously, all steps are set to the value of the first step. The states property is set to all steps on. All filter steps are set to the same harmonic. If this property was previously >1, the arrays are reallocated, but no values are altered. You must SUBSEQUENTLY assign all array properties.

DSS property name: Numsteps, DSS property index: 12.

Return type
BatchInt32ArrayProxy
property R: List[ndarray[Any, dtype[float64]]]

ARRAY of series resistance in each phase (line), ohms. Default is 0.0

DSS property name: R, DSS property index: 9.

Return type
List[ndarray[Any, dtype[float64]]]
property XL: List[ndarray[Any, dtype[float64]]]

ARRAY of series inductive reactance(s) in each phase (line) for filter, ohms at base frequency. Use this OR “h” property to define filter. Default is 0.0.

DSS property name: XL, DSS property index: 10.

Return type
List[ndarray[Any, dtype[float64]]]
property basefreq: BatchFloat64ArrayProxy

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 19.

Return type
BatchFloat64ArrayProxy
property bus1: List[str]

Name of first bus of 2-terminal capacitor. Examples: bus1=busname bus1=busname.1.2.3

If only one bus specified, Bus2 will default to this bus, Node 0, and the capacitor will be a Yg shunt bank.

DSS property name: bus1, DSS property index: 1.

Return type
List[str]
property bus2: List[str]

Name of 2nd bus. Defaults to all phases connected to first bus, node 0, (Shunt Wye Connection) except when Bus2 explicitly specified.

Not necessary to specify for delta (LL) connection.

DSS property name: bus2, DSS property index: 2.

Return type
List[str]
property cmatrix: List[ndarray[Any, dtype[float64]]]

Nodal cap. matrix, lower triangle, microfarads, of the following form:

cmatrix=”c11 | -c21 c22 | -c31 -c32 c33”

All steps are assumed the same if this property is used.

DSS property name: cmatrix, DSS property index: 7.

Return type
List[ndarray[Any, dtype[float64]]]
property conn: BatchInt32ArrayProxy

={wye | delta |LN |LL} Default is wye, which is equivalent to LN

DSS property name: conn, DSS property index: 6.

Return type
BatchInt32ArrayProxy
property conn_str: str

={wye | delta |LN |LL} Default is wye, which is equivalent to LN

DSS property name: conn, DSS property index: 6.

Return type
str
property cuf: List[ndarray[Any, dtype[float64]]]

ARRAY of Capacitance, each phase, for each step, microfarads. See Rules for NumSteps.

DSS property name: cuf, DSS property index: 8.

Return type
List[ndarray[Any, dtype[float64]]]
property emergamps: BatchFloat64ArrayProxy

Maximum or emerg current.

DSS property name: emergamps, DSS property index: 15.

Return type
BatchFloat64ArrayProxy
property enabled: List[bool]

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 20.

Return type
List[bool]
property faultrate: BatchFloat64ArrayProxy

Failure rate per year.

DSS property name: faultrate, DSS property index: 16.

Return type
BatchFloat64ArrayProxy
property kv: BatchFloat64ArrayProxy

For 2, 3-phase, kV phase-phase. Otherwise specify actual can rating.

DSS property name: kv, DSS property index: 5.

Return type
BatchFloat64ArrayProxy
property kvar: List[ndarray[Any, dtype[float64]]]

Total kvar, if one step, or ARRAY of kvar ratings for each step. Evenly divided among phases. See rules for NUMSTEPS.

DSS property name: kvar, DSS property index: 4.

Return type
List[ndarray[Any, dtype[float64]]]
property normamps: BatchFloat64ArrayProxy

Normal rated current.

DSS property name: normamps, DSS property index: 14.

Return type
BatchFloat64ArrayProxy
property pctperm: BatchFloat64ArrayProxy

Percent of failures that become permanent.

DSS property name: pctperm, DSS property index: 17.

Return type
BatchFloat64ArrayProxy
property phases: BatchInt32ArrayProxy

Number of phases.

DSS property name: phases, DSS property index: 3.

Return type
BatchInt32ArrayProxy
property repair: BatchFloat64ArrayProxy

Hours to repair.

DSS property name: repair, DSS property index: 18.

Return type
BatchFloat64ArrayProxy
property states: List[ndarray[Any, dtype[int32]]]

ARRAY of integers {1|0} states representing the state of each step (on|off). Defaults to 1 when reallocated (on). Capcontrol will modify this array as it turns steps on or off.

DSS property name: states, DSS property index: 13.

Return type
List[ndarray[Any, dtype[int32]]]
class dss.IObj.CircuitModel(value)

Circuit Model (DSS enumeration)

Multiphase = 0
Positive = 1
class dss.IObj.Connection(DSS enumeration)
delta = 1
ll = 1
ln = 0
wye = 0
y = 0
class dss.IObj.ControlMode(value)

Control Mode (DSS enumeration)

Event = 1
MultiRate = 3
Off = -1
Static = 0
Time = 2
class dss.IObj.CoreType(value)

Core Type (DSS enumeration)

core_1_phase = 9
five_leg = 5
four_leg = 4
one_phase = 1
shell = 0
three_leg = 3
class dss.IObj.DSSBatch(api_util, **kwargs)
to_json(options=0)

Returns the data (as a list) of the elements in a batch as a JSON-encoded string.

The options parameter contains bit-flags to toggle specific features. See Obj_ToJSON (C-API) for more, or DSSObj.to_json in Python.

Additionally, the ExcludeDisabled flag can be used to excluded disabled elements from the output.

(API Extension)

property name: List[str]
Return type
List[str]
class dss.IObj.DSSObj(api_util, ptr)
to_json(options=0)

Returns an element’s data as a JSON-encoded string.

The options parameter contains bit-flags to toggle specific features.

By default (options = 0), only the properties explicitly set. The properties are returned in the order they are set in the input. As a reminder, OpenDSS is sensitive to the order of the properties.

The options bit-flags are available in the DSSJSONFlags enum. Values used by this function are:

  • Full: if set, all properties are returned, ordered by property index instead.
  • SkipRedundant: if used with Full, all properties except redundant and unused ones are returned.
  • EnumAsInt: enumerated properties are returned as integer values instead of strings.
  • FullNames: any element reference will use the full name ({class name}.{element name}) even if not required.
  • Pretty: more whitespace is used in the output for a “prettier” format.

NOT IMPLEMENTED YET: - State: include run-time state information - Debug: include debug information

Other bit-flags are reserved for future uses. Please use DSSJSONFlags enum to avoid potential conflicts.

(API Extension)

property name: str
Return type
str
class dss.IObj.DimensionUnits(value)

Dimension Units (DSS enumeration)

cm = 7
ft = 5
inch = 6
kft = 2
km = 3
m = 4
meter = 4
mi = 1
miles = 1
mm = 8
none = 0
class dss.IObj.ESPVLControl(api_util, ptr)
class ESPVLControlType(value)

ESPVLControl: Type (DSS enumeration for ESPVLControl)

LocalController = 2
SystemController = 1
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 14.

property Element: str

Full object name of the circuit element, typically a line or transformer, which the control is monitoring. There is no default; must be specified.

DSS property name: Element, DSS property index: 1.

Return type
str
property Element_obj: DSSObj

Full object name of the circuit element, typically a line or transformer, which the control is monitoring. There is no default; must be specified.

DSS property name: Element, DSS property index: 1.

Return type
DSSObj
property LocalControlList: List[str]

Array list of ESPVLControl local controller objects to be dispatched by System Controller. If not specified, all ESPVLControl devices with type=local in the circuit not attached to another controller are assumed to be part of this controller’s fleet.

DSS property name: LocalControlList, DSS property index: 6.

Return type
List[str]
property LocalControlWeights: ndarray[Any, dtype[float64]]

Array of proportional weights corresponding to each ESPVLControl local controller in the LocalControlList.

DSS property name: LocalControlWeights, DSS property index: 7.

Return type
ndarray[Any, dtype[float64]]
property PVSystemList: List[str]

Array list of PVSystem objects to be dispatched by a Local Controller.

DSS property name: PVSystemList, DSS property index: 8.

Return type
List[str]
property PVSystemWeights: ndarray[Any, dtype[float64]]

Array of proportional weights corresponding to each PVSystem in the PVSystemList.

DSS property name: PVSystemWeights, DSS property index: 9.

Return type
ndarray[Any, dtype[float64]]
property StorageList: List[str]

Array list of Storage objects to be dispatched by Local Controller.

DSS property name: StorageList, DSS property index: 10.

Return type
List[str]
property StorageWeights: ndarray[Any, dtype[float64]]

Array of proportional weights corresponding to each Storage object in the StorageControlList.

DSS property name: StorageWeights, DSS property index: 11.

Return type
ndarray[Any, dtype[float64]]
property Terminal: int

Number of the terminal of the circuit element to which the ESPVLControl control is connected. 1 or 2, typically. Default is 1. Make sure you have the direction on the power matching the sign of kWLimit.

DSS property name: Terminal, DSS property index: 2.

Return type
int
property Type: ESPVLControlType

Type of controller. 1= System Controller; 2= Local controller.

DSS property name: Type, DSS property index: 3.

Return type
ESPVLControlType
property Type_str: str

Type of controller. 1= System Controller; 2= Local controller.

DSS property name: Type, DSS property index: 3.

Return type
str
property basefreq: float

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 12.

Return type
float
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 13.

Return type
bool
property kWBand: float

Bandwidth (kW) of the dead band around the target limit.No dispatch changes are attempted if the power in the monitored terminal stays within this band.

DSS property name: kWBand, DSS property index: 4.

Return type
float
property kvarlimit: float

Max kvar to be delivered through the element. Uses same dead band as kW.

DSS property name: kvarlimit, DSS property index: 5.

Return type
float
class dss.IObj.ESPVLControlBatch(api_util, **kwargs)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 14.

property Element: List[str]

Full object name of the circuit element, typically a line or transformer, which the control is monitoring. There is no default; must be specified.

DSS property name: Element, DSS property index: 1.

Return type
List[str]
property Element_obj: List[str]

Full object name of the circuit element, typically a line or transformer, which the control is monitoring. There is no default; must be specified.

DSS property name: Element, DSS property index: 1.

Return type
List[str]
property LocalControlList: List[List[str]]

Array list of ESPVLControl local controller objects to be dispatched by System Controller. If not specified, all ESPVLControl devices with type=local in the circuit not attached to another controller are assumed to be part of this controller’s fleet.

DSS property name: LocalControlList, DSS property index: 6.

Return type
List[List[str]]
property LocalControlWeights: List[ndarray[Any, dtype[float64]]]

Array of proportional weights corresponding to each ESPVLControl local controller in the LocalControlList.

DSS property name: LocalControlWeights, DSS property index: 7.

Return type
List[ndarray[Any, dtype[float64]]]
property PVSystemList: List[List[str]]

Array list of PVSystem objects to be dispatched by a Local Controller.

DSS property name: PVSystemList, DSS property index: 8.

Return type
List[List[str]]
property PVSystemWeights: List[ndarray[Any, dtype[float64]]]

Array of proportional weights corresponding to each PVSystem in the PVSystemList.

DSS property name: PVSystemWeights, DSS property index: 9.

Return type
List[ndarray[Any, dtype[float64]]]
property StorageList: List[List[str]]

Array list of Storage objects to be dispatched by Local Controller.

DSS property name: StorageList, DSS property index: 10.

Return type
List[List[str]]
property StorageWeights: List[ndarray[Any, dtype[float64]]]

Array of proportional weights corresponding to each Storage object in the StorageControlList.

DSS property name: StorageWeights, DSS property index: 11.

Return type
List[ndarray[Any, dtype[float64]]]
property Terminal: BatchInt32ArrayProxy

Number of the terminal of the circuit element to which the ESPVLControl control is connected. 1 or 2, typically. Default is 1. Make sure you have the direction on the power matching the sign of kWLimit.

DSS property name: Terminal, DSS property index: 2.

Return type
BatchInt32ArrayProxy
property Type: BatchInt32ArrayProxy

Type of controller. 1= System Controller; 2= Local controller.

DSS property name: Type, DSS property index: 3.

Return type
BatchInt32ArrayProxy
property Type_str: str

Type of controller. 1= System Controller; 2= Local controller.

DSS property name: Type, DSS property index: 3.

Return type
str
property basefreq: BatchFloat64ArrayProxy

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 12.

Return type
BatchFloat64ArrayProxy
property enabled: List[bool]

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 13.

Return type
List[bool]
property kWBand: BatchFloat64ArrayProxy

Bandwidth (kW) of the dead band around the target limit.No dispatch changes are attempted if the power in the monitored terminal stays within this band.

DSS property name: kWBand, DSS property index: 4.

Return type
BatchFloat64ArrayProxy
property kvarlimit: BatchFloat64ArrayProxy

Max kvar to be delivered through the element. Uses same dead band as kW.

DSS property name: kvarlimit, DSS property index: 5.

Return type
BatchFloat64ArrayProxy
class dss.IObj.EarthModel(value)

Earth Model (DSS enumeration)

Carson = 1
Deri = 3
FullCarson = 2
class dss.IObj.EnergyMeter(api_util, ptr)
class EnergyMeterAction(value)

EnergyMeter: Action (DSS enumeration for EnergyMeter)

Allocate = 0
Clear = 1
Reduce = 2
Save = 3
Take = 4
ZoneDump = 5
action(value)

{Clear (reset) | Save | Take | Zonedump | Allocate | Reduce}

(A)llocate = Allocate loads on the meter zone to match PeakCurrent. (C)lear = reset all registers to zero (R)educe = reduces zone by merging lines (see Set Keeplist & ReduceOption) (S)ave = saves the current register values to a file.

File name is “MTR_metername.CSV”.

(T)ake = Takes a sample at present solution (Z)onedump = Dump names of elements in meter zone to a file

File name is “Zone_metername.CSV”.

DSS property name: action, DSS property index: 3.

like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 27.

property CAIDI: float

(Read only) Makes CAIDI result available via return on query (? energymeter.myMeter.CAIDI.

DSS property name: CAIDI, DSS property index: 23.

Return type
float
property CustInterrupts: float

(Read only) Makes Total Customer Interrupts value result available via return on query (? energymeter.myMeter.CustInterrupts.

DSS property name: CustInterrupts, DSS property index: 24.

Return type
float
property Int_Duration: float

Average annual duration, in hr, of interruptions for head of the meter zone (source side of zone or feeder).

DSS property name: Int_Duration, DSS property index: 19.

Return type
float
property Int_Rate: float

Average number of annual interruptions for head of the meter zone (source side of zone or feeder).

DSS property name: Int_Rate, DSS property index: 18.

Return type
float
property LineLosses: bool

{Yes | No} Default is YES. Compute Line losses. If NO, then none of the losses are computed.

DSS property name: LineLosses, DSS property index: 12.

Return type
bool
property LocalOnly: bool

{Yes | No} Default is NO. If Yes, meter considers only the monitored element for EEN and UE calcs. Uses whole zone for losses.

DSS property name: LocalOnly, DSS property index: 9.

Return type
bool
property Losses: bool

{Yes | No} Default is YES. Compute Zone losses. If NO, then no losses at all are computed.

DSS property name: Losses, DSS property index: 11.

Return type
bool
property Mask: ndarray[Any, dtype[float64]]

Mask for adding registers whenever all meters are totalized. Array of floating point numbers representing the multiplier to be used for summing each register from this meter. Default = (1, 1, 1, 1, … ). You only have to enter as many as are changed (positional). Useful when two meters monitor same energy, etc.

DSS property name: Mask, DSS property index: 10.

Return type
ndarray[Any, dtype[float64]]
property PhaseVoltageReport: bool

{Yes | No} Default is NO. Report min, max, and average phase voltages for the zone and tabulate by voltage base. Demand Intervals must be turned on (Set Demand=true) and voltage bases must be defined for this property to take effect. Result is in a separate report file.

DSS property name: PhaseVoltageReport, DSS property index: 17.

Return type
bool
property SAIDI: float

(Read only) Makes SAIDI result available via return on query (? energymeter.myMeter.SAIDI.

DSS property name: SAIDI, DSS property index: 22.

Return type
float
property SAIFI: float

(Read only) Makes SAIFI result available via return on query (? energymeter.myMeter.SAIFI.

DSS property name: SAIFI, DSS property index: 20.

Return type
float
property SAIFIkW: float

(Read only) Makes SAIFIkW result available via return on query (? energymeter.myMeter.SAIFIkW.

DSS property name: SAIFIkW, DSS property index: 21.

Return type
float
property SeqLosses: bool

{Yes | No} Default is YES. Compute Sequence losses in lines and segregate by line mode losses and zero mode losses.

DSS property name: SeqLosses, DSS property index: 14.

Return type
bool
property VbaseLosses: bool

{Yes | No} Default is YES. Compute losses and segregate by voltage base. If NO, then voltage-based tabulation is not reported.

DSS property name: VbaseLosses, DSS property index: 16.

Return type
bool
property XfmrLosses: bool

{Yes | No} Default is YES. Compute Transformer losses. If NO, transformers are ignored in loss calculations.

DSS property name: XfmrLosses, DSS property index: 13.

Return type
bool
property Zonelist: List[str]

ARRAY of full element names for this meter’s zone. Default is for meter to find it’s own zone. If specified, DSS uses this list instead. Can access the names in a single-column text file. Examples:

zonelist=[line.L1, transformer.T1, Line.L3] zonelist=(file=branchlist.txt)

DSS property name: Zonelist, DSS property index: 8.

Return type
List[str]
property basefreq: float

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 25.

Return type
float
property element: str

Name (Full Object name) of element to which the monitor is connected.

DSS property name: element, DSS property index: 1.

Return type
str
property element_obj: DSSObj

Name (Full Object name) of element to which the monitor is connected.

DSS property name: element, DSS property index: 1.

Return type
DSSObj
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 26.

Return type
bool
property kVAemerg: float

Upper limit on kVA load in the zone, Emergency configuration. Default is 0.0 (ignored). Overrides limits on individual lines for overload UE. With “LocalOnly=Yes” option, uses only load in metered branch.

DSS property name: kVAemerg, DSS property index: 6.

Return type
float
property kVAnormal: float

Upper limit on kVA load in the zone, Normal configuration. Default is 0.0 (ignored). Overrides limits on individual lines for overload EEN. With “LocalOnly=Yes” option, uses only load in metered branch.

DSS property name: kVAnormal, DSS property index: 5.

Return type
float
property option: List[str]

Enter a string ARRAY of any combination of the following. Options processed left-to-right:

(E)xcess : (default) UE/EEN is estimate of energy over capacity (T)otal : UE/EEN is total energy after capacity exceeded (R)adial : (default) Treats zone as a radial circuit (M)esh : Treats zone as meshed network (not radial). (C)ombined : (default) Load UE/EEN computed from combination of overload and undervoltage. (V)oltage : Load UE/EEN computed based on voltage only.

Example: option=(E, R)

DSS property name: option, DSS property index: 4.

Return type
List[str]
property peakcurrent: ndarray[Any, dtype[float64]]

ARRAY of current magnitudes representing the peak currents measured at this location for the load allocation function. Default is (400, 400, 400). Enter one current for each phase

DSS property name: peakcurrent, DSS property index: 7.

Return type
ndarray[Any, dtype[float64]]
property terminal: int

Number of the terminal of the circuit element to which the monitor is connected. 1 or 2, typically.

DSS property name: terminal, DSS property index: 2.

Return type
int
property threePaseLosses: bool

{Yes | No} Default is YES. Compute Line losses and segregate by 3-phase and other (1- and 2-phase) line losses.

DSS property name: 3phaseLosses, DSS property index: 15.

Return type
bool
class dss.IObj.EnergyMeterBatch(api_util, **kwargs)
action(value)

{Clear (reset) | Save | Take | Zonedump | Allocate | Reduce}

(A)llocate = Allocate loads on the meter zone to match PeakCurrent. (C)lear = reset all registers to zero (R)educe = reduces zone by merging lines (see Set Keeplist & ReduceOption) (S)ave = saves the current register values to a file.

File name is “MTR_metername.CSV”.

(T)ake = Takes a sample at present solution (Z)onedump = Dump names of elements in meter zone to a file

File name is “Zone_metername.CSV”.

DSS property name: action, DSS property index: 3.

like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 27.

property CAIDI: BatchFloat64ArrayProxy

(Read only) Makes CAIDI result available via return on query (? energymeter.myMeter.CAIDI.

DSS property name: CAIDI, DSS property index: 23.

Return type
BatchFloat64ArrayProxy
property CustInterrupts: BatchFloat64ArrayProxy

(Read only) Makes Total Customer Interrupts value result available via return on query (? energymeter.myMeter.CustInterrupts.

DSS property name: CustInterrupts, DSS property index: 24.

Return type
BatchFloat64ArrayProxy
property Int_Duration: BatchFloat64ArrayProxy

Average annual duration, in hr, of interruptions for head of the meter zone (source side of zone or feeder).

DSS property name: Int_Duration, DSS property index: 19.

Return type
BatchFloat64ArrayProxy
property Int_Rate: BatchFloat64ArrayProxy

Average number of annual interruptions for head of the meter zone (source side of zone or feeder).

DSS property name: Int_Rate, DSS property index: 18.

Return type
BatchFloat64ArrayProxy
property LineLosses: List[bool]

{Yes | No} Default is YES. Compute Line losses. If NO, then none of the losses are computed.

DSS property name: LineLosses, DSS property index: 12.

Return type
List[bool]
property LocalOnly: List[bool]

{Yes | No} Default is NO. If Yes, meter considers only the monitored element for EEN and UE calcs. Uses whole zone for losses.

DSS property name: LocalOnly, DSS property index: 9.

Return type
List[bool]
property Losses: List[bool]

{Yes | No} Default is YES. Compute Zone losses. If NO, then no losses at all are computed.

DSS property name: Losses, DSS property index: 11.

Return type
List[bool]
property Mask: List[ndarray[Any, dtype[float64]]]

Mask for adding registers whenever all meters are totalized. Array of floating point numbers representing the multiplier to be used for summing each register from this meter. Default = (1, 1, 1, 1, … ). You only have to enter as many as are changed (positional). Useful when two meters monitor same energy, etc.

DSS property name: Mask, DSS property index: 10.

Return type
List[ndarray[Any, dtype[float64]]]
property PhaseVoltageReport: List[bool]

{Yes | No} Default is NO. Report min, max, and average phase voltages for the zone and tabulate by voltage base. Demand Intervals must be turned on (Set Demand=true) and voltage bases must be defined for this property to take effect. Result is in a separate report file.

DSS property name: PhaseVoltageReport, DSS property index: 17.

Return type
List[bool]
property SAIDI: BatchFloat64ArrayProxy

(Read only) Makes SAIDI result available via return on query (? energymeter.myMeter.SAIDI.

DSS property name: SAIDI, DSS property index: 22.

Return type
BatchFloat64ArrayProxy
property SAIFI: BatchFloat64ArrayProxy

(Read only) Makes SAIFI result available via return on query (? energymeter.myMeter.SAIFI.

DSS property name: SAIFI, DSS property index: 20.

Return type
BatchFloat64ArrayProxy
property SAIFIkW: BatchFloat64ArrayProxy

(Read only) Makes SAIFIkW result available via return on query (? energymeter.myMeter.SAIFIkW.

DSS property name: SAIFIkW, DSS property index: 21.

Return type
BatchFloat64ArrayProxy
property SeqLosses: List[bool]

{Yes | No} Default is YES. Compute Sequence losses in lines and segregate by line mode losses and zero mode losses.

DSS property name: SeqLosses, DSS property index: 14.

Return type
List[bool]
property VbaseLosses: List[bool]

{Yes | No} Default is YES. Compute losses and segregate by voltage base. If NO, then voltage-based tabulation is not reported.

DSS property name: VbaseLosses, DSS property index: 16.

Return type
List[bool]
property XfmrLosses: List[bool]

{Yes | No} Default is YES. Compute Transformer losses. If NO, transformers are ignored in loss calculations.

DSS property name: XfmrLosses, DSS property index: 13.

Return type
List[bool]
property Zonelist: List[List[str]]

ARRAY of full element names for this meter’s zone. Default is for meter to find it’s own zone. If specified, DSS uses this list instead. Can access the names in a single-column text file. Examples:

zonelist=[line.L1, transformer.T1, Line.L3] zonelist=(file=branchlist.txt)

DSS property name: Zonelist, DSS property index: 8.

Return type
List[List[str]]
property basefreq: BatchFloat64ArrayProxy

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 25.

Return type
BatchFloat64ArrayProxy
property element: List[str]

Name (Full Object name) of element to which the monitor is connected.

DSS property name: element, DSS property index: 1.

Return type
List[str]
property element_obj: List[str]

Name (Full Object name) of element to which the monitor is connected.

DSS property name: element, DSS property index: 1.

Return type
List[str]
property enabled: List[bool]

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 26.

Return type
List[bool]
property kVAemerg: BatchFloat64ArrayProxy

Upper limit on kVA load in the zone, Emergency configuration. Default is 0.0 (ignored). Overrides limits on individual lines for overload UE. With “LocalOnly=Yes” option, uses only load in metered branch.

DSS property name: kVAemerg, DSS property index: 6.

Return type
BatchFloat64ArrayProxy
property kVAnormal: BatchFloat64ArrayProxy

Upper limit on kVA load in the zone, Normal configuration. Default is 0.0 (ignored). Overrides limits on individual lines for overload EEN. With “LocalOnly=Yes” option, uses only load in metered branch.

DSS property name: kVAnormal, DSS property index: 5.

Return type
BatchFloat64ArrayProxy
property option: List[List[str]]

Enter a string ARRAY of any combination of the following. Options processed left-to-right:

(E)xcess : (default) UE/EEN is estimate of energy over capacity (T)otal : UE/EEN is total energy after capacity exceeded (R)adial : (default) Treats zone as a radial circuit (M)esh : Treats zone as meshed network (not radial). (C)ombined : (default) Load UE/EEN computed from combination of overload and undervoltage. (V)oltage : Load UE/EEN computed based on voltage only.

Example: option=(E, R)

DSS property name: option, DSS property index: 4.

Return type
List[List[str]]
property peakcurrent: List[ndarray[Any, dtype[float64]]]

ARRAY of current magnitudes representing the peak currents measured at this location for the load allocation function. Default is (400, 400, 400). Enter one current for each phase

DSS property name: peakcurrent, DSS property index: 7.

Return type
List[ndarray[Any, dtype[float64]]]
property terminal: BatchInt32ArrayProxy

Number of the terminal of the circuit element to which the monitor is connected. 1 or 2, typically.

DSS property name: terminal, DSS property index: 2.

Return type
BatchInt32ArrayProxy
property threePaseLosses: List[bool]

{Yes | No} Default is YES. Compute Line losses and segregate by 3-phase and other (1- and 2-phase) line losses.

DSS property name: 3phaseLosses, DSS property index: 15.

Return type
List[bool]
class dss.IObj.ExpControl(api_util, ptr)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 17.

property DERList: List[str]

Alternative to PVSystemList for CIM export and import.

However, storage is not actually implemented yet. Use fully qualified PVSystem names.

DSS property name: DERList, DSS property index: 14.

Return type
List[str]
property DeltaQ_factor: float

Convergence parameter; Defaults to 0.7.

Sets the maximum change (in per unit) from the prior var output level to the desired var output level during each control iteration. If numerical instability is noticed in solutions such as var sign changing from one control iteration to the next and voltages oscillating between two values with some separation, this is an indication of numerical instability (use the EventLog to diagnose). If the maximum control iterations are exceeded, and no numerical instability is seen in the EventLog of via monitors, then try increasing the value of this parameter to reduce the number of control iterations needed to achieve the control criteria, and move to the power flow solution.

DSS property name: DeltaQ_factor, DSS property index: 11.

Return type
float
property EventLog: bool

{Yes/True* | No/False} Default is No for ExpControl. Log control actions to Eventlog.

DSS property name: EventLog, DSS property index: 10.

Return type
bool
property PVSystemList: List[str]

Array list of PVSystems to be controlled.

If not specified, all PVSystems in the circuit are assumed to be controlled by this ExpControl.

DSS property name: PVSystemList, DSS property index: 1.

Return type
List[str]
property PreferQ: bool

{Yes/True* | No/False} Default is No for ExpControl.

Curtails real power output as needed to meet the reactive power requirement. IEEE1547-2018 requires Yes, but the default is No for backward compatibility of OpenDSS models.

DSS property name: PreferQ, DSS property index: 12.

Return type
bool
property Qbias: float

Equilibrium per-unit reactive power when V=Vreg; defaults to 0.

Enter > 0 for lagging (capacitive) bias, < 0 for leading (inductive) bias.

DSS property name: Qbias, DSS property index: 5.

Return type
float
property QmaxLag: float

Limit on lagging (capacitive) reactive power injection, in per-unit of base kva; defaults to 0.44.

For Category A inverters per P1547/D7, set this value to 0.25.Regardless of QmaxLag, the reactive power injection is still limited by dynamic headroom when actual real power output exceeds 0%

DSS property name: QmaxLag, DSS property index: 9.

Return type
float
property QmaxLead: float

Limit on leading (inductive) reactive power injection, in per-unit of base kva; defaults to 0.44.For Category A inverters per P1547/D7, set this value to 0.25.

Regardless of QmaxLead, the reactive power injection is still limited by dynamic headroom when actual real power output exceeds 0%

DSS property name: QmaxLead, DSS property index: 8.

Return type
float
property Slope: float

Per-unit reactive power injection / per-unit voltage deviation from Vreg; defaults to 50.

Unlike InvControl, base reactive power is constant at the inverter kva rating.

DSS property name: Slope, DSS property index: 3.

Return type
float
property Tresponse: float

Open-loop response time for changes in Q.

The value of Q reaches 90% of the target change within Tresponse, which corresponds to a low-pass filter having tau = Tresponse / 2.3026. The behavior is similar to LPFTAU in InvControl, but here the response time is input instead of the time constant. IEEE1547-2018 default is 10s for Catagory A and 5s for Category B, adjustable from 1s to 90s for both categories. However, the default is 0 for backward compatibility of OpenDSS models.

DSS property name: Tresponse, DSS property index: 13.

Return type
float
property Vreg: float

Per-unit voltage at which reactive power is zero; defaults to 1.0.

This may dynamically self-adjust when VregTau > 0, limited by VregMin and VregMax.If imput as 0, Vreg will be initialized from a snapshot solution with no inverter Q.The equilibrium point of reactive power is also affected by Qbias

DSS property name: Vreg, DSS property index: 2.

Return type
float
property VregMax: float

Upper limit on adaptive Vreg; defaults to 1.05 per-unit

DSS property name: VregMax, DSS property index: 7.

Return type
float
property VregMin: float

Lower limit on adaptive Vreg; defaults to 0.95 per-unit

DSS property name: VregMin, DSS property index: 6.

Return type
float
property VregTau: float

Time constant for adaptive Vreg. Defaults to 1200 seconds.

When the control injects or absorbs reactive power due to a voltage deviation from the Q=0 crossing of the volt-var curve, the Q=0 crossing will move toward the actual terminal voltage with this time constant. Over time, the effect is to gradually bring inverter reactive power to zero as the grid voltage changes due to non-solar effects. If zero, then Vreg stays fixed. IEEE1547-2018 requires adjustability from 300s to 5000s

DSS property name: VregTau, DSS property index: 4.

Return type
float
property basefreq: float

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 15.

Return type
float
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 16.

Return type
bool
class dss.IObj.ExpControlBatch(api_util, **kwargs)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 17.

property DERList: List[List[str]]

Alternative to PVSystemList for CIM export and import.

However, storage is not actually implemented yet. Use fully qualified PVSystem names.

DSS property name: DERList, DSS property index: 14.

Return type
List[List[str]]
property DeltaQ_factor: BatchFloat64ArrayProxy

Convergence parameter; Defaults to 0.7.

Sets the maximum change (in per unit) from the prior var output level to the desired var output level during each control iteration. If numerical instability is noticed in solutions such as var sign changing from one control iteration to the next and voltages oscillating between two values with some separation, this is an indication of numerical instability (use the EventLog to diagnose). If the maximum control iterations are exceeded, and no numerical instability is seen in the EventLog of via monitors, then try increasing the value of this parameter to reduce the number of control iterations needed to achieve the control criteria, and move to the power flow solution.

DSS property name: DeltaQ_factor, DSS property index: 11.

Return type
BatchFloat64ArrayProxy
property EventLog: List[bool]

{Yes/True* | No/False} Default is No for ExpControl. Log control actions to Eventlog.

DSS property name: EventLog, DSS property index: 10.

Return type
List[bool]
property PVSystemList: List[List[str]]

Array list of PVSystems to be controlled.

If not specified, all PVSystems in the circuit are assumed to be controlled by this ExpControl.

DSS property name: PVSystemList, DSS property index: 1.

Return type
List[List[str]]
property PreferQ: List[bool]

{Yes/True* | No/False} Default is No for ExpControl.

Curtails real power output as needed to meet the reactive power requirement. IEEE1547-2018 requires Yes, but the default is No for backward compatibility of OpenDSS models.

DSS property name: PreferQ, DSS property index: 12.

Return type
List[bool]
property Qbias: BatchFloat64ArrayProxy

Equilibrium per-unit reactive power when V=Vreg; defaults to 0.

Enter > 0 for lagging (capacitive) bias, < 0 for leading (inductive) bias.

DSS property name: Qbias, DSS property index: 5.

Return type
BatchFloat64ArrayProxy
property QmaxLag: BatchFloat64ArrayProxy

Limit on lagging (capacitive) reactive power injection, in per-unit of base kva; defaults to 0.44.

For Category A inverters per P1547/D7, set this value to 0.25.Regardless of QmaxLag, the reactive power injection is still limited by dynamic headroom when actual real power output exceeds 0%

DSS property name: QmaxLag, DSS property index: 9.

Return type
BatchFloat64ArrayProxy
property QmaxLead: BatchFloat64ArrayProxy

Limit on leading (inductive) reactive power injection, in per-unit of base kva; defaults to 0.44.For Category A inverters per P1547/D7, set this value to 0.25.

Regardless of QmaxLead, the reactive power injection is still limited by dynamic headroom when actual real power output exceeds 0%

DSS property name: QmaxLead, DSS property index: 8.

Return type
BatchFloat64ArrayProxy
property Slope: BatchFloat64ArrayProxy

Per-unit reactive power injection / per-unit voltage deviation from Vreg; defaults to 50.

Unlike InvControl, base reactive power is constant at the inverter kva rating.

DSS property name: Slope, DSS property index: 3.

Return type
BatchFloat64ArrayProxy
property Tresponse: BatchFloat64ArrayProxy

Open-loop response time for changes in Q.

The value of Q reaches 90% of the target change within Tresponse, which corresponds to a low-pass filter having tau = Tresponse / 2.3026. The behavior is similar to LPFTAU in InvControl, but here the response time is input instead of the time constant. IEEE1547-2018 default is 10s for Catagory A and 5s for Category B, adjustable from 1s to 90s for both categories. However, the default is 0 for backward compatibility of OpenDSS models.

DSS property name: Tresponse, DSS property index: 13.

Return type
BatchFloat64ArrayProxy
property Vreg: BatchFloat64ArrayProxy

Per-unit voltage at which reactive power is zero; defaults to 1.0.

This may dynamically self-adjust when VregTau > 0, limited by VregMin and VregMax.If imput as 0, Vreg will be initialized from a snapshot solution with no inverter Q.The equilibrium point of reactive power is also affected by Qbias

DSS property name: Vreg, DSS property index: 2.

Return type
BatchFloat64ArrayProxy
property VregMax: BatchFloat64ArrayProxy

Upper limit on adaptive Vreg; defaults to 1.05 per-unit

DSS property name: VregMax, DSS property index: 7.

Return type
BatchFloat64ArrayProxy
property VregMin: BatchFloat64ArrayProxy

Lower limit on adaptive Vreg; defaults to 0.95 per-unit

DSS property name: VregMin, DSS property index: 6.

Return type
BatchFloat64ArrayProxy
property VregTau: BatchFloat64ArrayProxy

Time constant for adaptive Vreg. Defaults to 1200 seconds.

When the control injects or absorbs reactive power due to a voltage deviation from the Q=0 crossing of the volt-var curve, the Q=0 crossing will move toward the actual terminal voltage with this time constant. Over time, the effect is to gradually bring inverter reactive power to zero as the grid voltage changes due to non-solar effects. If zero, then Vreg stays fixed. IEEE1547-2018 requires adjustability from 300s to 5000s

DSS property name: VregTau, DSS property index: 4.

Return type
BatchFloat64ArrayProxy
property basefreq: BatchFloat64ArrayProxy

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 15.

Return type
BatchFloat64ArrayProxy
property enabled: List[bool]

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 16.

Return type
List[bool]
class dss.IObj.Fault(api_util, ptr)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 17.

property Gmatrix: ndarray[Any, dtype[float64]]

Use this to specify a nodal conductance (G) matrix to represent some arbitrary resistance network. Specify in lower triangle form as usual for DSS matrices.

DSS property name: Gmatrix, DSS property index: 6.

Return type
ndarray[Any, dtype[float64]]
property MinAmps: float

Minimum amps that can sustain a temporary fault. Default is 5.

DSS property name: MinAmps, DSS property index: 9.

Return type
float
property ONtime: float

Time (sec) at which the fault is established for time varying simulations. Default is 0.0 (on at the beginning of the simulation)

DSS property name: ONtime, DSS property index: 7.

Return type
float
property basefreq: float

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 15.

Return type
float
property bus1: str

Name of first bus. Examples:

bus1=busname bus1=busname.1.2.3

Bus2 automatically defaults to busname.0,0,0 unless it was previously defined.

DSS property name: bus1, DSS property index: 1.

Return type
str
property bus2: str

Name of 2nd bus of the 2-terminal Fault object. Defaults to all phases connected to first bus, node 0, if not specified. (Shunt Wye Connection to ground reference)

That is, the Fault defaults to a ground fault unless otherwise specified.

DSS property name: bus2, DSS property index: 2.

Return type
str
property emergamps: float

Maximum or emerg current.

DSS property name: emergamps, DSS property index: 11.

Return type
float
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 16.

Return type
bool
property faultrate: float

Failure rate per year.

DSS property name: faultrate, DSS property index: 12.

Return type
float
property normamps: float

Normal rated current.

DSS property name: normamps, DSS property index: 10.

Return type
float
property pctperm: float

Percent of failures that become permanent.

DSS property name: pctperm, DSS property index: 13.

Return type
float
property pctstddev: float

Percent standard deviation in resistance to assume for Monte Carlo fault (MF) solution mode for GAUSSIAN distribution. Default is 0 (no variation from mean).

DSS property name: %stddev, DSS property index: 5.

Return type
float
property phases: int

Number of Phases. Default is 1.

DSS property name: phases, DSS property index: 3.

Return type
int
property r: float

Resistance, each phase, ohms. Default is 0.0001. Assumed to be Mean value if gaussian random mode.Max value if uniform mode. A Fault is actually a series resistance that defaults to a wye connection to ground on the second terminal. You may reconnect the 2nd terminal to achieve whatever connection. Use the Gmatrix property to specify an arbitrary conductance matrix.

DSS property name: r, DSS property index: 4.

Return type
float
property repair: float

Hours to repair.

DSS property name: repair, DSS property index: 14.

Return type
float
property temporary: bool

{Yes | No} Default is No. Designate whether the fault is temporary. For Time-varying simulations, the fault will be removed if the current through the fault drops below the MINAMPS criteria.

DSS property name: temporary, DSS property index: 8.

Return type
bool
class dss.IObj.FaultBatch(api_util, **kwargs)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 17.

property Gmatrix: List[ndarray[Any, dtype[float64]]]

Use this to specify a nodal conductance (G) matrix to represent some arbitrary resistance network. Specify in lower triangle form as usual for DSS matrices.

DSS property name: Gmatrix, DSS property index: 6.

Return type
List[ndarray[Any, dtype[float64]]]
property MinAmps: BatchFloat64ArrayProxy

Minimum amps that can sustain a temporary fault. Default is 5.

DSS property name: MinAmps, DSS property index: 9.

Return type
BatchFloat64ArrayProxy
property ONtime: BatchFloat64ArrayProxy

Time (sec) at which the fault is established for time varying simulations. Default is 0.0 (on at the beginning of the simulation)

DSS property name: ONtime, DSS property index: 7.

Return type
BatchFloat64ArrayProxy
property basefreq: BatchFloat64ArrayProxy

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 15.

Return type
BatchFloat64ArrayProxy
property bus1: List[str]

Name of first bus. Examples:

bus1=busname bus1=busname.1.2.3

Bus2 automatically defaults to busname.0,0,0 unless it was previously defined.

DSS property name: bus1, DSS property index: 1.

Return type
List[str]
property bus2: List[str]

Name of 2nd bus of the 2-terminal Fault object. Defaults to all phases connected to first bus, node 0, if not specified. (Shunt Wye Connection to ground reference)

That is, the Fault defaults to a ground fault unless otherwise specified.

DSS property name: bus2, DSS property index: 2.

Return type
List[str]
property emergamps: BatchFloat64ArrayProxy

Maximum or emerg current.

DSS property name: emergamps, DSS property index: 11.

Return type
BatchFloat64ArrayProxy
property enabled: List[bool]

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 16.

Return type
List[bool]
property faultrate: BatchFloat64ArrayProxy

Failure rate per year.

DSS property name: faultrate, DSS property index: 12.

Return type
BatchFloat64ArrayProxy
property normamps: BatchFloat64ArrayProxy

Normal rated current.

DSS property name: normamps, DSS property index: 10.

Return type
BatchFloat64ArrayProxy
property pctperm: BatchFloat64ArrayProxy

Percent of failures that become permanent.

DSS property name: pctperm, DSS property index: 13.

Return type
BatchFloat64ArrayProxy
property pctstddev: BatchFloat64ArrayProxy

Percent standard deviation in resistance to assume for Monte Carlo fault (MF) solution mode for GAUSSIAN distribution. Default is 0 (no variation from mean).

DSS property name: %stddev, DSS property index: 5.

Return type
BatchFloat64ArrayProxy
property phases: BatchInt32ArrayProxy

Number of Phases. Default is 1.

DSS property name: phases, DSS property index: 3.

Return type
BatchInt32ArrayProxy
property r: BatchFloat64ArrayProxy

Resistance, each phase, ohms. Default is 0.0001. Assumed to be Mean value if gaussian random mode.Max value if uniform mode. A Fault is actually a series resistance that defaults to a wye connection to ground on the second terminal. You may reconnect the 2nd terminal to achieve whatever connection. Use the Gmatrix property to specify an arbitrary conductance matrix.

DSS property name: r, DSS property index: 4.

Return type
BatchFloat64ArrayProxy
property repair: BatchFloat64ArrayProxy

Hours to repair.

DSS property name: repair, DSS property index: 14.

Return type
BatchFloat64ArrayProxy
property temporary: List[bool]

{Yes | No} Default is No. Designate whether the fault is temporary. For Time-varying simulations, the fault will be removed if the current through the fault drops below the MINAMPS criteria.

DSS property name: temporary, DSS property index: 8.

Return type
List[bool]
class dss.IObj.Fuse(api_util, ptr)
class FuseAction(value)

Fuse: Action (DSS enumeration for Fuse)

close = 2
open = 1
class FuseState(value)

Fuse: State (DSS enumeration for Fuse)

closed = 2
open = 1
Action(value)

DEPRECATED. See “State” property.

DSS property name: Action, DSS property index: 8.

like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 13.

property Delay: float

Fixed delay time (sec) added to Fuse blowing time determined from the TCC curve. Default is 0.0. Used to represent fuse clearing time or any other delay.

DSS property name: Delay, DSS property index: 7.

Return type
float
property FuseCurve: str

Name of the TCC Curve object that determines the fuse blowing. Must have been previously defined as a TCC_Curve object. Default is “Tlink”. Multiplying the current values in the curve by the “RatedCurrent” value gives the actual current.

DSS property name: FuseCurve, DSS property index: 5.

Return type
str
property FuseCurve_obj: TCC_Curve

Name of the TCC Curve object that determines the fuse blowing. Must have been previously defined as a TCC_Curve object. Default is “Tlink”. Multiplying the current values in the curve by the “RatedCurrent” value gives the actual current.

DSS property name: FuseCurve, DSS property index: 5.

Return type
TCC_Curve
property MonitoredObj: str

Full object name of the circuit element, typically a line, transformer, load, or generator, to which the Fuse is connected. This is the “monitored” element. There is no default; must be specified.

DSS property name: MonitoredObj, DSS property index: 1.

Return type
str
property MonitoredObj_obj: DSSObj

Full object name of the circuit element, typically a line, transformer, load, or generator, to which the Fuse is connected. This is the “monitored” element. There is no default; must be specified.

DSS property name: MonitoredObj, DSS property index: 1.

Return type
DSSObj
property MonitoredTerm: int

Number of the terminal of the circuit element to which the Fuse is connected. 1 or 2, typically. Default is 1.

DSS property name: MonitoredTerm, DSS property index: 2.

Return type
int
property Normal: List[FuseState]

ARRAY of strings {Open | Closed} representing the Normal state of the fuse in each phase of the controlled element. The fuse reverts to this state for reset, change of mode, etc. Defaults to “State” if not specifically declared.

DSS property name: Normal, DSS property index: 9.

Return type
List[FuseState]
property Normal_str: List[str]

ARRAY of strings {Open | Closed} representing the Normal state of the fuse in each phase of the controlled element. The fuse reverts to this state for reset, change of mode, etc. Defaults to “State” if not specifically declared.

DSS property name: Normal, DSS property index: 9.

Return type
List[str]
property RatedCurrent: float

Multiplier or actual phase amps for the phase TCC curve. Defaults to 1.0.

DSS property name: RatedCurrent, DSS property index: 6.

Return type
float
property State: List[FuseState]

ARRAY of strings {Open | Closed} representing the Actual state of the fuse in each phase of the controlled element. Upon setting, immediately forces state of fuse(s). Simulates manual control on Fuse. Defaults to Closed for all phases.

DSS property name: State, DSS property index: 10.

Return type
List[FuseState]
property State_str: List[str]

ARRAY of strings {Open | Closed} representing the Actual state of the fuse in each phase of the controlled element. Upon setting, immediately forces state of fuse(s). Simulates manual control on Fuse. Defaults to Closed for all phases.

DSS property name: State, DSS property index: 10.

Return type
List[str]
property SwitchedObj: str

Name of circuit element switch that the Fuse controls. Specify the full object name.Defaults to the same as the Monitored element. This is the “controlled” element.

DSS property name: SwitchedObj, DSS property index: 3.

Return type
str
property SwitchedObj_obj: DSSObj

Name of circuit element switch that the Fuse controls. Specify the full object name.Defaults to the same as the Monitored element. This is the “controlled” element.

DSS property name: SwitchedObj, DSS property index: 3.

Return type
DSSObj
property SwitchedTerm: int

Number of the terminal of the controlled element in which the switch is controlled by the Fuse. 1 or 2, typically. Default is 1. Assumes all phases of the element have a fuse of this type.

DSS property name: SwitchedTerm, DSS property index: 4.

Return type
int
property basefreq: float

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 11.

Return type
float
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 12.

Return type
bool
class dss.IObj.FuseBatch(api_util, **kwargs)
Action(value)

DEPRECATED. See “State” property.

DSS property name: Action, DSS property index: 8.

like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 13.

property Delay: BatchFloat64ArrayProxy

Fixed delay time (sec) added to Fuse blowing time determined from the TCC curve. Default is 0.0. Used to represent fuse clearing time or any other delay.

DSS property name: Delay, DSS property index: 7.

Return type
BatchFloat64ArrayProxy
property FuseCurve: List[str]

Name of the TCC Curve object that determines the fuse blowing. Must have been previously defined as a TCC_Curve object. Default is “Tlink”. Multiplying the current values in the curve by the “RatedCurrent” value gives the actual current.

DSS property name: FuseCurve, DSS property index: 5.

Return type
List[str]
property FuseCurve_obj: List[str]

Name of the TCC Curve object that determines the fuse blowing. Must have been previously defined as a TCC_Curve object. Default is “Tlink”. Multiplying the current values in the curve by the “RatedCurrent” value gives the actual current.

DSS property name: FuseCurve, DSS property index: 5.

Return type
List[str]
property MonitoredObj: List[str]

Full object name of the circuit element, typically a line, transformer, load, or generator, to which the Fuse is connected. This is the “monitored” element. There is no default; must be specified.

DSS property name: MonitoredObj, DSS property index: 1.

Return type
List[str]
property MonitoredObj_obj: List[str]

Full object name of the circuit element, typically a line, transformer, load, or generator, to which the Fuse is connected. This is the “monitored” element. There is no default; must be specified.

DSS property name: MonitoredObj, DSS property index: 1.

Return type
List[str]
property MonitoredTerm: BatchInt32ArrayProxy

Number of the terminal of the circuit element to which the Fuse is connected. 1 or 2, typically. Default is 1.

DSS property name: MonitoredTerm, DSS property index: 2.

Return type
BatchInt32ArrayProxy
property Normal: List[ndarray[Any, dtype[int32]]]

ARRAY of strings {Open | Closed} representing the Normal state of the fuse in each phase of the controlled element. The fuse reverts to this state for reset, change of mode, etc. Defaults to “State” if not specifically declared.

DSS property name: Normal, DSS property index: 9.

Return type
List[ndarray[Any, dtype[int32]]]
property Normal_str: List[List[str]]

ARRAY of strings {Open | Closed} representing the Normal state of the fuse in each phase of the controlled element. The fuse reverts to this state for reset, change of mode, etc. Defaults to “State” if not specifically declared.

DSS property name: Normal, DSS property index: 9.

Return type
List[List[str]]
property RatedCurrent: BatchFloat64ArrayProxy

Multiplier or actual phase amps for the phase TCC curve. Defaults to 1.0.

DSS property name: RatedCurrent, DSS property index: 6.

Return type
BatchFloat64ArrayProxy
property State: List[ndarray[Any, dtype[int32]]]

ARRAY of strings {Open | Closed} representing the Actual state of the fuse in each phase of the controlled element. Upon setting, immediately forces state of fuse(s). Simulates manual control on Fuse. Defaults to Closed for all phases.

DSS property name: State, DSS property index: 10.

Return type
List[ndarray[Any, dtype[int32]]]
property State_str: List[List[str]]

ARRAY of strings {Open | Closed} representing the Actual state of the fuse in each phase of the controlled element. Upon setting, immediately forces state of fuse(s). Simulates manual control on Fuse. Defaults to Closed for all phases.

DSS property name: State, DSS property index: 10.

Return type
List[List[str]]
property SwitchedObj: List[str]

Name of circuit element switch that the Fuse controls. Specify the full object name.Defaults to the same as the Monitored element. This is the “controlled” element.

DSS property name: SwitchedObj, DSS property index: 3.

Return type
List[str]
property SwitchedObj_obj: List[str]

Name of circuit element switch that the Fuse controls. Specify the full object name.Defaults to the same as the Monitored element. This is the “controlled” element.

DSS property name: SwitchedObj, DSS property index: 3.

Return type
List[str]
property SwitchedTerm: BatchInt32ArrayProxy

Number of the terminal of the controlled element in which the switch is controlled by the Fuse. 1 or 2, typically. Default is 1. Assumes all phases of the element have a fuse of this type.

DSS property name: SwitchedTerm, DSS property index: 4.

Return type
BatchInt32ArrayProxy
property basefreq: BatchFloat64ArrayProxy

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 11.

Return type
BatchFloat64ArrayProxy
property enabled: List[bool]

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 12.

Return type
List[bool]
class dss.IObj.GICLine(api_util, ptr)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 19.

property Angle: float

Phase angle in degrees of first phase. Default=0.0. See Voltage property

DSS property name: Angle, DSS property index: 4.

Return type
float
property C: float

Value of line blocking capacitance in microfarads. Default = 0.0, implying that there is no line blocking capacitor.

DSS property name: C, DSS property index: 9.

Return type
float
property EE: float

Eastward Electric field (V/km). If specified, Voltage and Angle are computed from EN, EE, lat and lon values.

DSS property name: EE, DSS property index: 11.

Return type
float
property EN: float

Northward Electric field (V/km). If specified, Voltage and Angle are computed from EN, EE, lat and lon values.

DSS property name: EN, DSS property index: 10.

Return type
float
property Lat1: float

Latitude of Bus1 (degrees)

DSS property name: Lat1, DSS property index: 12.

Return type
float
property Lat2: float

Latitude of Bus2 (degrees)

DSS property name: Lat2, DSS property index: 14.

Return type
float
property Lon1: float

Longitude of Bus1 (degrees)

DSS property name: Lon1, DSS property index: 13.

Return type
float
property Lon2: float

Longitude of Bus2 (degrees)

DSS property name: Lon2, DSS property index: 15.

Return type
float
property R: float

Resistance of line, ohms of impedance in series with GIC voltage source.

DSS property name: R, DSS property index: 7.

Return type
float
property Volts: float

Voltage magnitude, in volts, of the GIC voltage induced across this line. When spedified, voltage source is assumed defined by Voltage and Angle properties.

Specify this value

OR

EN, EE, lat1, lon1, lat2, lon2.

Not both!! Last one entered will take precedence. Assumed identical in each phase of the Line object.

DSS property name: Volts, DSS property index: 3.

Return type
float
property X: float

Reactance at base frequency, ohms. Default = 0.0. This value is generally not important for GIC studies but may be used if desired.

DSS property name: X, DSS property index: 8.

Return type
float
property basefreq: float

Inherited Property for all PCElements. Base frequency for specification of reactance value.

DSS property name: basefreq, DSS property index: 17.

Return type
float
property bus1: str

Name of bus to which the main terminal (1) is connected. bus1=busname bus1=busname.1.2.3

DSS property name: bus1, DSS property index: 1.

Return type
str
property bus2: str

Name of bus to which 2nd terminal is connected. bus2=busname bus2=busname.1.2.3

No Default; must be specified.

DSS property name: bus2, DSS property index: 2.

Return type
str
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 18.

Return type
bool
property frequency: float

Source frequency. Defaults to 0.1 Hz.

DSS property name: frequency, DSS property index: 5.

Return type
float
property phases: int

Number of phases. Defaults to 3.

DSS property name: phases, DSS property index: 6.

Return type
int
property spectrum: str

Inherited Property for all PCElements. Name of harmonic spectrum for this source. Default is “defaultvsource”, which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 16.

Return type
str
property spectrum_obj: Spectrum

Inherited Property for all PCElements. Name of harmonic spectrum for this source. Default is “defaultvsource”, which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 16.

Return type
Spectrum
class dss.IObj.GICLineBatch(api_util, **kwargs)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 19.

property Angle: BatchFloat64ArrayProxy

Phase angle in degrees of first phase. Default=0.0. See Voltage property

DSS property name: Angle, DSS property index: 4.

Return type
BatchFloat64ArrayProxy
property C: BatchFloat64ArrayProxy

Value of line blocking capacitance in microfarads. Default = 0.0, implying that there is no line blocking capacitor.

DSS property name: C, DSS property index: 9.

Return type
BatchFloat64ArrayProxy
property EE: BatchFloat64ArrayProxy

Eastward Electric field (V/km). If specified, Voltage and Angle are computed from EN, EE, lat and lon values.

DSS property name: EE, DSS property index: 11.

Return type
BatchFloat64ArrayProxy
property EN: BatchFloat64ArrayProxy

Northward Electric field (V/km). If specified, Voltage and Angle are computed from EN, EE, lat and lon values.

DSS property name: EN, DSS property index: 10.

Return type
BatchFloat64ArrayProxy
property Lat1: BatchFloat64ArrayProxy

Latitude of Bus1 (degrees)

DSS property name: Lat1, DSS property index: 12.

Return type
BatchFloat64ArrayProxy
property Lat2: BatchFloat64ArrayProxy

Latitude of Bus2 (degrees)

DSS property name: Lat2, DSS property index: 14.

Return type
BatchFloat64ArrayProxy
property Lon1: BatchFloat64ArrayProxy

Longitude of Bus1 (degrees)

DSS property name: Lon1, DSS property index: 13.

Return type
BatchFloat64ArrayProxy
property Lon2: BatchFloat64ArrayProxy

Longitude of Bus2 (degrees)

DSS property name: Lon2, DSS property index: 15.

Return type
BatchFloat64ArrayProxy
property R: BatchFloat64ArrayProxy

Resistance of line, ohms of impedance in series with GIC voltage source.

DSS property name: R, DSS property index: 7.

Return type
BatchFloat64ArrayProxy
property Volts: BatchFloat64ArrayProxy

Voltage magnitude, in volts, of the GIC voltage induced across this line. When spedified, voltage source is assumed defined by Voltage and Angle properties.

Specify this value

OR

EN, EE, lat1, lon1, lat2, lon2.

Not both!! Last one entered will take precedence. Assumed identical in each phase of the Line object.

DSS property name: Volts, DSS property index: 3.

Return type
BatchFloat64ArrayProxy
property X: BatchFloat64ArrayProxy

Reactance at base frequency, ohms. Default = 0.0. This value is generally not important for GIC studies but may be used if desired.

DSS property name: X, DSS property index: 8.

Return type
BatchFloat64ArrayProxy
property basefreq: BatchFloat64ArrayProxy

Inherited Property for all PCElements. Base frequency for specification of reactance value.

DSS property name: basefreq, DSS property index: 17.

Return type
BatchFloat64ArrayProxy
property bus1: List[str]

Name of bus to which the main terminal (1) is connected. bus1=busname bus1=busname.1.2.3

DSS property name: bus1, DSS property index: 1.

Return type
List[str]
property bus2: List[str]

Name of bus to which 2nd terminal is connected. bus2=busname bus2=busname.1.2.3

No Default; must be specified.

DSS property name: bus2, DSS property index: 2.

Return type
List[str]
property enabled: List[bool]

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 18.

Return type
List[bool]
property frequency: BatchFloat64ArrayProxy

Source frequency. Defaults to 0.1 Hz.

DSS property name: frequency, DSS property index: 5.

Return type
BatchFloat64ArrayProxy
property phases: BatchInt32ArrayProxy

Number of phases. Defaults to 3.

DSS property name: phases, DSS property index: 6.

Return type
BatchInt32ArrayProxy
property spectrum: List[str]

Inherited Property for all PCElements. Name of harmonic spectrum for this source. Default is “defaultvsource”, which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 16.

Return type
List[str]
property spectrum_obj: List[str]

Inherited Property for all PCElements. Name of harmonic spectrum for this source. Default is “defaultvsource”, which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 16.

Return type
List[str]
class dss.IObj.GICTransformer(api_util, ptr)
class GICTransformerType(value)

GICTransformer: Type (DSS enumeration for GICTransformer)

Auto = 2
GSU = 1
YY = 3
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 23.

property BusH: str

Name of High-side(H) bus. Examples: BusH=busname BusH=busname.1.2.3

DSS property name: BusH, DSS property index: 1.

Return type
str
property BusNH: str

Name of Neutral bus for H, or first, winding. Defaults to all phases connected to H-side bus, node 0, if not specified and transformer type is either GSU or YY. (Shunt Wye Connection to ground reference)For Auto, this is automatically set to the X bus.

DSS property name: BusNH, DSS property index: 2.

Return type
str
property BusNX: str

Name of Neutral bus for X, or Second, winding. Defaults to all phases connected to X-side bus, node 0, if not specified. (Shunt Wye Connection to ground reference)

DSS property name: BusNX, DSS property index: 4.

Return type
str
property BusX: str

Name of Low-side(X) bus, if type=Auto or YY.

DSS property name: BusX, DSS property index: 3.

Return type
str
property K: float

Mvar K factor. Default way to convert GIC Amps in H winding (winding 1) to Mvar. Default is 2.2. Commonly-used simple multiplier for estimating Mvar losses for power flow analysis.

Mvar = K * kvLL * GIC per phase / 1000

Mutually exclusive with using the VarCurve property and pu curves.If you specify this (default), VarCurve is ignored.

DSS property name: K, DSS property index: 15.

Return type
float
property KVLL1: float

Optional. kV LL rating for H winding (winding 1). Default is 500. Required if you are going to export vars for power flow analysis or enter winding resistances in percent.

DSS property name: KVLL1, DSS property index: 9.

Return type
float
property KVLL2: float

Optional. kV LL rating for X winding (winding 2). Default is 138. Required if you are going to export vars for power flow analysis or enter winding resistances in percent..

DSS property name: KVLL2, DSS property index: 10.

Return type
float
property MVA: float

Optional. MVA Rating assumed Transformer. Default is 100. Used for computing vars due to GIC and winding resistances if kV and MVA ratings are specified.

DSS property name: MVA, DSS property index: 11.

Return type
float
property R1: float

Resistance, each phase, ohms for H winding, (Series winding, if Auto). Default is 0.0001. If

DSS property name: R1, DSS property index: 7.

Return type
float
property R2: float

Resistance, each phase, ohms for X winding, (Common winding, if Auto). Default is 0.0001.

DSS property name: R2, DSS property index: 8.

Return type
float
property Type: GICTransformerType

Type of transformer: {GSU* | Auto | YY}. Default is GSU.

DSS property name: Type, DSS property index: 6.

Return type
GICTransformerType
property Type_str: str

Type of transformer: {GSU* | Auto | YY}. Default is GSU.

DSS property name: Type, DSS property index: 6.

Return type
str
property VarCurve: str

Optional. XYCurve object name. Curve is expected as TOTAL pu vars vs pu GIC amps/phase. Vars are in pu of the MVA property. No Default value. Required only if you are going to export vars for power flow analysis. See K property.

DSS property name: VarCurve, DSS property index: 12.

Return type
str
property VarCurve_obj: XYcurve

Optional. XYCurve object name. Curve is expected as TOTAL pu vars vs pu GIC amps/phase. Vars are in pu of the MVA property. No Default value. Required only if you are going to export vars for power flow analysis. See K property.

DSS property name: VarCurve, DSS property index: 12.

Return type
XYcurve
property basefreq: float

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 21.

Return type
float
property emergamps: float

Maximum or emerg current.

DSS property name: emergamps, DSS property index: 17.

Return type
float
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 22.

Return type
bool
property faultrate: float

Failure rate per year.

DSS property name: faultrate, DSS property index: 18.

Return type
float
property normamps: float

Normal rated current.

DSS property name: normamps, DSS property index: 16.

Return type
float
property pctR1: float

Optional. Percent Resistance, each phase, for H winding (1), (Series winding, if Auto). Default is 0.2.

Alternative way to enter R1 value. It is the actual resistances in ohmns that matter. MVA and kV should be specified.

DSS property name: %R1, DSS property index: 13.

Return type
float
property pctR2: float

Optional. Percent Resistance, each phase, for X winding (2), (Common winding, if Auto). Default is 0.2.

Alternative way to enter R2 value. It is the actual resistances in ohms that matter. MVA and kV should be specified.

DSS property name: %R2, DSS property index: 14.

Return type
float
property pctperm: float

Percent of failures that become permanent.

DSS property name: pctperm, DSS property index: 19.

Return type
float
property phases: int

Number of Phases. Default is 3.

DSS property name: phases, DSS property index: 5.

Return type
int
property repair: float

Hours to repair.

DSS property name: repair, DSS property index: 20.

Return type
float
class dss.IObj.GICTransformerBatch(api_util, **kwargs)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 23.

property BusH: List[str]

Name of High-side(H) bus. Examples: BusH=busname BusH=busname.1.2.3

DSS property name: BusH, DSS property index: 1.

Return type
List[str]
property BusNH: List[str]

Name of Neutral bus for H, or first, winding. Defaults to all phases connected to H-side bus, node 0, if not specified and transformer type is either GSU or YY. (Shunt Wye Connection to ground reference)For Auto, this is automatically set to the X bus.

DSS property name: BusNH, DSS property index: 2.

Return type
List[str]
property BusNX: List[str]

Name of Neutral bus for X, or Second, winding. Defaults to all phases connected to X-side bus, node 0, if not specified. (Shunt Wye Connection to ground reference)

DSS property name: BusNX, DSS property index: 4.

Return type
List[str]
property BusX: List[str]

Name of Low-side(X) bus, if type=Auto or YY.

DSS property name: BusX, DSS property index: 3.

Return type
List[str]
property K: BatchFloat64ArrayProxy

Mvar K factor. Default way to convert GIC Amps in H winding (winding 1) to Mvar. Default is 2.2. Commonly-used simple multiplier for estimating Mvar losses for power flow analysis.

Mvar = K * kvLL * GIC per phase / 1000

Mutually exclusive with using the VarCurve property and pu curves.If you specify this (default), VarCurve is ignored.

DSS property name: K, DSS property index: 15.

Return type
BatchFloat64ArrayProxy
property KVLL1: BatchFloat64ArrayProxy

Optional. kV LL rating for H winding (winding 1). Default is 500. Required if you are going to export vars for power flow analysis or enter winding resistances in percent.

DSS property name: KVLL1, DSS property index: 9.

Return type
BatchFloat64ArrayProxy
property KVLL2: BatchFloat64ArrayProxy

Optional. kV LL rating for X winding (winding 2). Default is 138. Required if you are going to export vars for power flow analysis or enter winding resistances in percent..

DSS property name: KVLL2, DSS property index: 10.

Return type
BatchFloat64ArrayProxy
property MVA: BatchFloat64ArrayProxy

Optional. MVA Rating assumed Transformer. Default is 100. Used for computing vars due to GIC and winding resistances if kV and MVA ratings are specified.

DSS property name: MVA, DSS property index: 11.

Return type
BatchFloat64ArrayProxy
property R1: BatchFloat64ArrayProxy

Resistance, each phase, ohms for H winding, (Series winding, if Auto). Default is 0.0001. If

DSS property name: R1, DSS property index: 7.

Return type
BatchFloat64ArrayProxy
property R2: BatchFloat64ArrayProxy

Resistance, each phase, ohms for X winding, (Common winding, if Auto). Default is 0.0001.

DSS property name: R2, DSS property index: 8.

Return type
BatchFloat64ArrayProxy
property Type: BatchInt32ArrayProxy

Type of transformer: {GSU* | Auto | YY}. Default is GSU.

DSS property name: Type, DSS property index: 6.

Return type
BatchInt32ArrayProxy
property Type_str: str

Type of transformer: {GSU* | Auto | YY}. Default is GSU.

DSS property name: Type, DSS property index: 6.

Return type
str
property VarCurve: List[str]

Optional. XYCurve object name. Curve is expected as TOTAL pu vars vs pu GIC amps/phase. Vars are in pu of the MVA property. No Default value. Required only if you are going to export vars for power flow analysis. See K property.

DSS property name: VarCurve, DSS property index: 12.

Return type
List[str]
property VarCurve_obj: List[str]

Optional. XYCurve object name. Curve is expected as TOTAL pu vars vs pu GIC amps/phase. Vars are in pu of the MVA property. No Default value. Required only if you are going to export vars for power flow analysis. See K property.

DSS property name: VarCurve, DSS property index: 12.

Return type
List[str]
property basefreq: BatchFloat64ArrayProxy

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 21.

Return type
BatchFloat64ArrayProxy
property emergamps: BatchFloat64ArrayProxy

Maximum or emerg current.

DSS property name: emergamps, DSS property index: 17.

Return type
BatchFloat64ArrayProxy
property enabled: List[bool]

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 22.

Return type
List[bool]
property faultrate: BatchFloat64ArrayProxy

Failure rate per year.

DSS property name: faultrate, DSS property index: 18.

Return type
BatchFloat64ArrayProxy
property normamps: BatchFloat64ArrayProxy

Normal rated current.

DSS property name: normamps, DSS property index: 16.

Return type
BatchFloat64ArrayProxy
property pctR1: BatchFloat64ArrayProxy

Optional. Percent Resistance, each phase, for H winding (1), (Series winding, if Auto). Default is 0.2.

Alternative way to enter R1 value. It is the actual resistances in ohmns that matter. MVA and kV should be specified.

DSS property name: %R1, DSS property index: 13.

Return type
BatchFloat64ArrayProxy
property pctR2: BatchFloat64ArrayProxy

Optional. Percent Resistance, each phase, for X winding (2), (Common winding, if Auto). Default is 0.2.

Alternative way to enter R2 value. It is the actual resistances in ohms that matter. MVA and kV should be specified.

DSS property name: %R2, DSS property index: 14.

Return type
BatchFloat64ArrayProxy
property pctperm: BatchFloat64ArrayProxy

Percent of failures that become permanent.

DSS property name: pctperm, DSS property index: 19.

Return type
BatchFloat64ArrayProxy
property phases: BatchInt32ArrayProxy

Number of Phases. Default is 3.

DSS property name: phases, DSS property index: 5.

Return type
BatchInt32ArrayProxy
property repair: BatchFloat64ArrayProxy

Hours to repair.

DSS property name: repair, DSS property index: 20.

Return type
BatchFloat64ArrayProxy
class dss.IObj.GICsource(api_util, ptr)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 14.

property EE: float

Eastward Electric field (V/km). If specified, Voltage and Angle are computed from EN, EE, lat and lon values.

DSS property name: EE, DSS property index: 6.

Return type
float
property EN: float

Northward Electric field (V/km). If specified, Voltage and Angle are computed from EN, EE, lat and lon values.

DSS property name: EN, DSS property index: 5.

Return type
float
property Lat1: float

Latitude of Bus1 of the line(degrees)

DSS property name: Lat1, DSS property index: 7.

Return type
float
property Lat2: float

Latitude of Bus2 of the line (degrees)

DSS property name: Lat2, DSS property index: 9.

Return type
float
property Lon1: float

Longitude of Bus1 of the line (degrees)

DSS property name: Lon1, DSS property index: 8.

Return type
float
property Lon2: float

Longitude of Bus2 of the line (degrees)

DSS property name: Lon2, DSS property index: 10.

Return type
float
property Volts: float

Voltage magnitude, in volts, of the GIC voltage induced across the associated line. When specified, induced voltage is assumed defined by Voltage and Angle properties.

Specify this value

OR

EN, EE, lat1, lon1, lat2, lon2.

Not both!! Last one entered will take precedence. Assumed identical in each phase of the Line object.

DSS property name: Volts, DSS property index: 1.

Return type
float
property angle: float

Phase angle in degrees of first phase. Default=0.0. See Voltage property

DSS property name: angle, DSS property index: 2.

Return type
float
property basefreq: float

Not used.

DSS property name: basefreq, DSS property index: 12.

Return type
float
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 13.

Return type
bool
property frequency: float

Source frequency. Defaults to 0.1 Hz. So GICSource=0 at power frequency.

DSS property name: frequency, DSS property index: 3.

Return type
float
property phases: int

Number of phases. Defaults to 3. All three phases are assumed in phase (zero sequence)

DSS property name: phases, DSS property index: 4.

Return type
int
property spectrum: str

Not used.

DSS property name: spectrum, DSS property index: 11.

Return type
str
property spectrum_obj: Spectrum

Not used.

DSS property name: spectrum, DSS property index: 11.

Return type
Spectrum
class dss.IObj.GICsourceBatch(api_util, **kwargs)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 14.

property EE: BatchFloat64ArrayProxy

Eastward Electric field (V/km). If specified, Voltage and Angle are computed from EN, EE, lat and lon values.

DSS property name: EE, DSS property index: 6.

Return type
BatchFloat64ArrayProxy
property EN: BatchFloat64ArrayProxy

Northward Electric field (V/km). If specified, Voltage and Angle are computed from EN, EE, lat and lon values.

DSS property name: EN, DSS property index: 5.

Return type
BatchFloat64ArrayProxy
property Lat1: BatchFloat64ArrayProxy

Latitude of Bus1 of the line(degrees)

DSS property name: Lat1, DSS property index: 7.

Return type
BatchFloat64ArrayProxy
property Lat2: BatchFloat64ArrayProxy

Latitude of Bus2 of the line (degrees)

DSS property name: Lat2, DSS property index: 9.

Return type
BatchFloat64ArrayProxy
property Lon1: BatchFloat64ArrayProxy

Longitude of Bus1 of the line (degrees)

DSS property name: Lon1, DSS property index: 8.

Return type
BatchFloat64ArrayProxy
property Lon2: BatchFloat64ArrayProxy

Longitude of Bus2 of the line (degrees)

DSS property name: Lon2, DSS property index: 10.

Return type
BatchFloat64ArrayProxy
property Volts: BatchFloat64ArrayProxy

Voltage magnitude, in volts, of the GIC voltage induced across the associated line. When specified, induced voltage is assumed defined by Voltage and Angle properties.

Specify this value

OR

EN, EE, lat1, lon1, lat2, lon2.

Not both!! Last one entered will take precedence. Assumed identical in each phase of the Line object.

DSS property name: Volts, DSS property index: 1.

Return type
BatchFloat64ArrayProxy
property angle: BatchFloat64ArrayProxy

Phase angle in degrees of first phase. Default=0.0. See Voltage property

DSS property name: angle, DSS property index: 2.

Return type
BatchFloat64ArrayProxy
property basefreq: BatchFloat64ArrayProxy

Not used.

DSS property name: basefreq, DSS property index: 12.

Return type
BatchFloat64ArrayProxy
property enabled: List[bool]

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 13.

Return type
List[bool]
property frequency: BatchFloat64ArrayProxy

Source frequency. Defaults to 0.1 Hz. So GICSource=0 at power frequency.

DSS property name: frequency, DSS property index: 3.

Return type
BatchFloat64ArrayProxy
property phases: BatchInt32ArrayProxy

Number of phases. Defaults to 3. All three phases are assumed in phase (zero sequence)

DSS property name: phases, DSS property index: 4.

Return type
BatchInt32ArrayProxy
property spectrum: List[str]

Not used.

DSS property name: spectrum, DSS property index: 11.

Return type
List[str]
property spectrum_obj: List[str]

Not used.

DSS property name: spectrum, DSS property index: 11.

Return type
List[str]
class dss.IObj.GenDispatcher(api_util, ptr)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 10.

property Element: str

Full object name of the circuit element, typically a line or transformer, which the control is monitoring. There is no default; must be specified.

DSS property name: Element, DSS property index: 1.

Return type
str
property Element_obj: DSSObj

Full object name of the circuit element, typically a line or transformer, which the control is monitoring. There is no default; must be specified.

DSS property name: Element, DSS property index: 1.

Return type
DSSObj
property GenList: List[str]

Array list of generators to be dispatched. If not specified, all generators in the circuit are assumed dispatchable.

DSS property name: GenList, DSS property index: 6.

Return type
List[str]
property Terminal: int

Number of the terminal of the circuit element to which the GenDispatcher control is connected. 1 or 2, typically. Default is 1. Make sure you have the direction on the power matching the sign of kWLimit.

DSS property name: Terminal, DSS property index: 2.

Return type
int
property Weights: ndarray[Any, dtype[float64]]

DSS property name: Weights, DSS property index: 7.

Return type
ndarray[Any, dtype[float64]]
property basefreq: float

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 8.

Return type
float
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 9.

Return type
bool
property kWBand: float

Bandwidth (kW) of the dead band around the target limit.No dispatch changes are attempted if the power in the monitored terminal stays within this band.

DSS property name: kWBand, DSS property index: 4.

Return type
float
property kWLimit: float

kW Limit for the monitored element. The generators are dispatched to hold the power in band.

DSS property name: kWLimit, DSS property index: 3.

Return type
float
property kvarlimit: float

Max kvar to be delivered through the element. Uses same dead band as kW.

DSS property name: kvarlimit, DSS property index: 5.

Return type
float
class dss.IObj.GenDispatcherBatch(api_util, **kwargs)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 10.

property Element: List[str]

Full object name of the circuit element, typically a line or transformer, which the control is monitoring. There is no default; must be specified.

DSS property name: Element, DSS property index: 1.

Return type
List[str]
property Element_obj: List[str]

Full object name of the circuit element, typically a line or transformer, which the control is monitoring. There is no default; must be specified.

DSS property name: Element, DSS property index: 1.

Return type
List[str]
property GenList: List[List[str]]

Array list of generators to be dispatched. If not specified, all generators in the circuit are assumed dispatchable.

DSS property name: GenList, DSS property index: 6.

Return type
List[List[str]]
property Terminal: BatchInt32ArrayProxy

Number of the terminal of the circuit element to which the GenDispatcher control is connected. 1 or 2, typically. Default is 1. Make sure you have the direction on the power matching the sign of kWLimit.

DSS property name: Terminal, DSS property index: 2.

Return type
BatchInt32ArrayProxy
property Weights: List[ndarray[Any, dtype[float64]]]

DSS property name: Weights, DSS property index: 7.

Return type
List[ndarray[Any, dtype[float64]]]
property basefreq: BatchFloat64ArrayProxy

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 8.

Return type
BatchFloat64ArrayProxy
property enabled: List[bool]

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 9.

Return type
List[bool]
property kWBand: BatchFloat64ArrayProxy

Bandwidth (kW) of the dead band around the target limit.No dispatch changes are attempted if the power in the monitored terminal stays within this band.

DSS property name: kWBand, DSS property index: 4.

Return type
BatchFloat64ArrayProxy
property kWLimit: BatchFloat64ArrayProxy

kW Limit for the monitored element. The generators are dispatched to hold the power in band.

DSS property name: kWLimit, DSS property index: 3.

Return type
BatchFloat64ArrayProxy
property kvarlimit: BatchFloat64ArrayProxy

Max kvar to be delivered through the element. Uses same dead band as kW.

DSS property name: kvarlimit, DSS property index: 5.

Return type
BatchFloat64ArrayProxy
class dss.IObj.Generator(api_util, ptr)
class GeneratorDispatchMode(value)

Generator: Dispatch Mode (DSS enumeration for Generator)

Default = 0
LoadLevel = 1
Price = 2
class GeneratorStatus(value)

Generator: Status (DSS enumeration for Generator)

Fixed = 1
Variable = 0
Refuel(value)

It is a boolean value (Yes/True, No/False) that can be used to manually refuel the generator when needed. It only applies if UseFuel = Yes/True

DSS property name: Refuel, DSS property index: 42.

like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 46.

property Balanced: bool

{Yes | No*} Default is No. For Model=7, force balanced current only for 3-phase generators. Force zero- and negative-sequence to zero.

DSS property name: Balanced, DSS property index: 36.

Return type
bool
property D: float

Damping constant. Usual range is 0 to 4. Default is 1.0. Adjust to get damping

DSS property name: D, DSS property index: 29.

Return type
float
property DutyStart: float

Starting time offset [hours] into the duty cycle shape for this generator, defaults to 0

DSS property name: DutyStart, DSS property index: 34.

Return type
float
property FuelkWh: float

{*0}Is the nominal level of fuel for the generator (kWh). It only applies if UseFuel = Yes/True

DSS property name: FuelkWh, DSS property index: 39.

Return type
float
property H: float

Per unit mass constant of the machine. MW-sec/MVA. Default is 1.0.

DSS property name: H, DSS property index: 28.

Return type
float
property MVA: float

MVA rating of electrical machine. Alternative to using kVA=.

DSS property name: MVA, DSS property index: 24.

Return type
float
property ShaftData: str

String (in quotes or parentheses) that gets passed to user-written shaft dynamic model for defining the data for that model.

DSS property name: ShaftData, DSS property index: 33.

Return type
str
property ShaftModel: str

Name of user-written DLL containing a Shaft model, which models the prime mover and determines the power on the shaft for Dynamics studies. Models additional mass elements other than the single-mass model in the DSS default model. Set to “none” to negate previous setting.

DSS property name: ShaftModel, DSS property index: 32.

Return type
str
property UseFuel: bool

{Yes | *No}. Activates the use of fuel for the operation of the generator. When the fuel level reaches the reserve level, the generator stops until it gets refueled. By default, the generator is connected to a continuous fuel supply, Use this mode to mimic dependency on fuel level for different generation technologies.

DSS property name: UseFuel, DSS property index: 38.

Return type
bool
property UserData: str

String (in quotes or parentheses) that gets passed to user-written model for defining the data required for that model.

DSS property name: UserData, DSS property index: 31.

Return type
str
property UserModel: str

Name of DLL containing user-written model, which computes the terminal currents for Dynamics studies, overriding the default model. Set to “none” to negate previous setting.

DSS property name: UserModel, DSS property index: 30.

Return type
str
property Vmaxpu: float

Default = 1.10. Maximum per unit voltage for which the Model is assumed to apply. Above this value, the load model reverts to a constant impedance model.

DSS property name: Vmaxpu, DSS property index: 9.

Return type
float
property Vminpu: float

Default = 0.90. Minimum per unit voltage for which the Model is assumed to apply. Below this value, the load model reverts to a constant impedance model. For model 7, the current is limited to the value computed for constant power at Vminpu.

DSS property name: Vminpu, DSS property index: 8.

Return type
float
property Vpu: float

Per Unit voltage set point for Model = 3 (typical power flow model). Default is 1.0.

DSS property name: Vpu, DSS property index: 18.

Return type
float
property XRdp: float

Default is 20. X/R ratio for Xdp property for FaultStudy and Dynamic modes.

DSS property name: XRdp, DSS property index: 37.

Return type
float
property Xd: float

Per unit synchronous reactance of machine. Presently used only for Thevinen impedance for power flow calcs of user models (model=6). Typically use a value 0.4 to 1.0. Default is 1.0

DSS property name: Xd, DSS property index: 25.

Return type
float
property Xdp: float

Per unit transient reactance of the machine. Used for Dynamics mode and Fault studies. Default is 0.27.For user models, this value is used for the Thevinen/Norton impedance for Dynamics Mode.

DSS property name: Xdp, DSS property index: 26.

Return type
float
property Xdpp: float

Per unit subtransient reactance of the machine. Used for Harmonics. Default is 0.20.

DSS property name: Xdpp, DSS property index: 27.

Return type
float
property basefreq: float

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 44.

Return type
float
property bus1: str

Bus to which the Generator is connected. May include specific node specification.

DSS property name: bus1, DSS property index: 2.

Return type
str
property cls: int

An arbitrary integer number representing the class of Generator so that Generator values may be segregated by class.

DSS property name: class, DSS property index: 17.

Return type
int
property conn: Connection

={wye|LN|delta|LL}. Default is wye.

DSS property name: conn, DSS property index: 15.

Return type
Connection
property conn_str: str

={wye|LN|delta|LL}. Default is wye.

DSS property name: conn, DSS property index: 15.

Return type
str
property daily: str

Dispatch shape to use for daily simulations. Must be previously defined as a Loadshape object of 24 hrs, typically. If generator is assumed to be ON continuously, specify Status=FIXED, or designate a Loadshape objectthat is 1.0 perunit for all hours. Set to NONE to reset to no loadahape.

DSS property name: daily, DSS property index: 11.

Return type
str
property daily_obj: LoadShape

Dispatch shape to use for daily simulations. Must be previously defined as a Loadshape object of 24 hrs, typically. If generator is assumed to be ON continuously, specify Status=FIXED, or designate a Loadshape objectthat is 1.0 perunit for all hours. Set to NONE to reset to no loadahape.

DSS property name: daily, DSS property index: 11.

Return type
LoadShape
property debugtrace: bool

{Yes | No } Default is no. Turn this on to capture the progress of the generator model for each iteration. Creates a separate file for each generator named “GEN_name.CSV”.

DSS property name: debugtrace, DSS property index: 35.

Return type
bool
property dispmode: GeneratorDispatchMode

{Default* | Loadlevel | Price } Default = Default. Dispatch mode. In default mode, gen is either always on or follows dispatch curve as specified. Otherwise, the gen comes on when either the global default load level (Loadshape “default”) or the price level exceeds the dispatch value.

DSS property name: dispmode, DSS property index: 13.

Return type
GeneratorDispatchMode
property dispmode_str: str

{Default* | Loadlevel | Price } Default = Default. Dispatch mode. In default mode, gen is either always on or follows dispatch curve as specified. Otherwise, the gen comes on when either the global default load level (Loadshape “default”) or the price level exceeds the dispatch value.

DSS property name: dispmode, DSS property index: 13.

Return type
str
property dispvalue: float

Dispatch value. If = 0.0 (default) then Generator follow dispatch curves, if any. If > 0 then Generator is ON only when either the price signal (in Price dispatch mode) exceeds this value or the active circuit load multiplier * “default” loadshape value * the default yearly growth factor exceeds this value. Then the generator follows dispatch curves (duty, daily, or yearly), if any (see also Status).

DSS property name: dispvalue, DSS property index: 14.

Return type
float
property duty: str

Load shape to use for duty cycle dispatch simulations such as for wind generation. Must be previously defined as a Loadshape object. Typically would have time intervals less than 1 hr – perhaps, in seconds. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.

DSS property name: duty, DSS property index: 12.

Return type
str
property duty_obj: LoadShape

Load shape to use for duty cycle dispatch simulations such as for wind generation. Must be previously defined as a Loadshape object. Typically would have time intervals less than 1 hr – perhaps, in seconds. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.

DSS property name: duty, DSS property index: 12.

Return type
LoadShape
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 45.

Return type
bool
property forceon: bool

{Yes | No} Forces generator ON despite requirements of other dispatch modes. Stays ON until this property is set to NO, or an internal algorithm cancels the forced ON state.

DSS property name: forceon, DSS property index: 22.

Return type
bool
property kVA: float

kVA rating of electrical machine. Defaults to 1.2* kW if not specified. Applied to machine or inverter definition for Dynamics mode solutions.

DSS property name: kVA, DSS property index: 23.

Return type
float
property kW: float

Total base kW for the Generator. A positive value denotes power coming OUT of the element, which is the opposite of a load. This value is modified depending on the dispatch mode. Unaffected by the global load multiplier and growth curves. If you want there to be more generation, you must add more generators or change this value.

DSS property name: kW, DSS property index: 4.

Return type
float
property kv: float

Nominal rated (1.0 per unit) voltage, kV, for Generator. For 2- and 3-phase Generators, specify phase-phase kV. Otherwise, for phases=1 or phases>3, specify actual kV across each branch of the Generator. If wye (star), specify phase-neutral kV. If delta or phase-phase connected, specify phase-phase kV.

DSS property name: kv, DSS property index: 3.

Return type
float
property kvar: float

Specify the base kvar. Alternative to specifying the power factor. Side effect: the power factor value is altered to agree based on present value of kW.

DSS property name: kvar, DSS property index: 6.

Return type
float
property maxkvar: float

Maximum kvar limit for Model = 3. Defaults to twice the specified load kvar. Always reset this if you change PF or kvar properties.

DSS property name: maxkvar, DSS property index: 19.

Return type
float
property minkvar: float

Minimum kvar limit for Model = 3. Enter a negative number if generator can absorb vars. Defaults to negative of Maxkvar. Always reset this if you change PF or kvar properties.

DSS property name: minkvar, DSS property index: 20.

Return type
float
property model: int

Integer code for the model to use for generation variation with voltage. Valid values are:

1:Generator injects a constant kW at specified power factor. 2:Generator is modeled as a constant admittance. 3:Const kW, constant kV. Somewhat like a conventional transmission power flow P-V generator. 4:Const kW, Fixed Q (Q never varies) 5:Const kW, Fixed Q(as a constant reactance) 6:Compute load injection from User-written Model.(see usage of Xd, Xdp) 7:Constant kW, kvar, but current-limited below Vminpu. Approximates a simple inverter. See also Balanced.

DSS property name: model, DSS property index: 7.

Return type
int
property pctFuel: float

It is a number between 0 and 100 representing the current amount of fuel avaiable in percentage of FuelkWh. It only applies if UseFuel = Yes/True

DSS property name: %Fuel, DSS property index: 40.

Return type
float
property pctReserve: float

It is a number between 0 and 100 representing the reserve level in percentage of FuelkWh. It only applies if UseFuel = Yes/True

DSS property name: %Reserve, DSS property index: 41.

Return type
float
property pf: float

Generator power factor. Default is 0.80. Enter negative for leading powerfactor (when kW and kvar have opposite signs.) A positive power factor for a generator signifies that the generator produces vars as is typical for a synchronous generator. Induction machines would be specified with a negative power factor.

DSS property name: pf, DSS property index: 5.

Return type
float
property phases: int

Number of Phases, this Generator. Power is evenly divided among phases.

DSS property name: phases, DSS property index: 1.

Return type
int
property pvfactor: float

Deceleration factor for P-V generator model (Model=3). Default is 0.1. If the circuit converges easily, you may want to use a higher number such as 1.0. Use a lower number if solution diverges. Use Debugtrace=yes to create a file that will trace the convergence of a generator model.

DSS property name: pvfactor, DSS property index: 21.

Return type
float
property spectrum: str

Name of harmonic voltage or current spectrum for this generator. Voltage behind Xd” for machine - default. Current injection for inverter. Default value is “default”, which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 43.

Return type
str
property spectrum_obj: Spectrum

Name of harmonic voltage or current spectrum for this generator. Voltage behind Xd” for machine - default. Current injection for inverter. Default value is “default”, which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 43.

Return type
Spectrum
property status: GeneratorStatus

={Fixed | Variable*}. If Fixed, then dispatch multipliers do not apply. The generator is alway at full power when it is ON. Default is Variable (follows curves).

DSS property name: status, DSS property index: 16.

Return type
GeneratorStatus
property status_str: str

={Fixed | Variable*}. If Fixed, then dispatch multipliers do not apply. The generator is alway at full power when it is ON. Default is Variable (follows curves).

DSS property name: status, DSS property index: 16.

Return type
str
property yearly: str

Dispatch shape to use for yearly simulations. Must be previously defined as a Loadshape object. If this is not specified, a constant value is assumed (no variation). If the generator is assumed to be ON continuously, specify Status=FIXED, or designate a curve that is 1.0 per unit at all times. Set to NONE to reset to no loadahape. Nominally for 8760 simulations. If there are fewer points in the designated shape than the number of points in the solution, the curve is repeated.

DSS property name: yearly, DSS property index: 10.

Return type
str
property yearly_obj: LoadShape

Dispatch shape to use for yearly simulations. Must be previously defined as a Loadshape object. If this is not specified, a constant value is assumed (no variation). If the generator is assumed to be ON continuously, specify Status=FIXED, or designate a curve that is 1.0 per unit at all times. Set to NONE to reset to no loadahape. Nominally for 8760 simulations. If there are fewer points in the designated shape than the number of points in the solution, the curve is repeated.

DSS property name: yearly, DSS property index: 10.

Return type
LoadShape
class dss.IObj.GeneratorBatch(api_util, **kwargs)
Refuel(value)

It is a boolean value (Yes/True, No/False) that can be used to manually refuel the generator when needed. It only applies if UseFuel = Yes/True

DSS property name: Refuel, DSS property index: 42.

like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 46.

property Balanced: List[bool]

{Yes | No*} Default is No. For Model=7, force balanced current only for 3-phase generators. Force zero- and negative-sequence to zero.

DSS property name: Balanced, DSS property index: 36.

Return type
List[bool]
property D: BatchFloat64ArrayProxy

Damping constant. Usual range is 0 to 4. Default is 1.0. Adjust to get damping

DSS property name: D, DSS property index: 29.

Return type
BatchFloat64ArrayProxy
property DutyStart: BatchFloat64ArrayProxy

Starting time offset [hours] into the duty cycle shape for this generator, defaults to 0

DSS property name: DutyStart, DSS property index: 34.

Return type
BatchFloat64ArrayProxy
property FuelkWh: BatchFloat64ArrayProxy

{*0}Is the nominal level of fuel for the generator (kWh). It only applies if UseFuel = Yes/True

DSS property name: FuelkWh, DSS property index: 39.

Return type
BatchFloat64ArrayProxy
property H: BatchFloat64ArrayProxy

Per unit mass constant of the machine. MW-sec/MVA. Default is 1.0.

DSS property name: H, DSS property index: 28.

Return type
BatchFloat64ArrayProxy
property MVA: BatchFloat64ArrayProxy

MVA rating of electrical machine. Alternative to using kVA=.

DSS property name: MVA, DSS property index: 24.

Return type
BatchFloat64ArrayProxy
property ShaftData: List[str]

String (in quotes or parentheses) that gets passed to user-written shaft dynamic model for defining the data for that model.

DSS property name: ShaftData, DSS property index: 33.

Return type
List[str]
property ShaftModel: List[str]

Name of user-written DLL containing a Shaft model, which models the prime mover and determines the power on the shaft for Dynamics studies. Models additional mass elements other than the single-mass model in the DSS default model. Set to “none” to negate previous setting.

DSS property name: ShaftModel, DSS property index: 32.

Return type
List[str]
property UseFuel: List[bool]

{Yes | *No}. Activates the use of fuel for the operation of the generator. When the fuel level reaches the reserve level, the generator stops until it gets refueled. By default, the generator is connected to a continuous fuel supply, Use this mode to mimic dependency on fuel level for different generation technologies.

DSS property name: UseFuel, DSS property index: 38.

Return type
List[bool]
property UserData: List[str]

String (in quotes or parentheses) that gets passed to user-written model for defining the data required for that model.

DSS property name: UserData, DSS property index: 31.

Return type
List[str]
property UserModel: List[str]

Name of DLL containing user-written model, which computes the terminal currents for Dynamics studies, overriding the default model. Set to “none” to negate previous setting.

DSS property name: UserModel, DSS property index: 30.

Return type
List[str]
property Vmaxpu: BatchFloat64ArrayProxy

Default = 1.10. Maximum per unit voltage for which the Model is assumed to apply. Above this value, the load model reverts to a constant impedance model.

DSS property name: Vmaxpu, DSS property index: 9.

Return type
BatchFloat64ArrayProxy
property Vminpu: BatchFloat64ArrayProxy

Default = 0.90. Minimum per unit voltage for which the Model is assumed to apply. Below this value, the load model reverts to a constant impedance model. For model 7, the current is limited to the value computed for constant power at Vminpu.

DSS property name: Vminpu, DSS property index: 8.

Return type
BatchFloat64ArrayProxy
property Vpu: BatchFloat64ArrayProxy

Per Unit voltage set point for Model = 3 (typical power flow model). Default is 1.0.

DSS property name: Vpu, DSS property index: 18.

Return type
BatchFloat64ArrayProxy
property XRdp: BatchFloat64ArrayProxy

Default is 20. X/R ratio for Xdp property for FaultStudy and Dynamic modes.

DSS property name: XRdp, DSS property index: 37.

Return type
BatchFloat64ArrayProxy
property Xd: BatchFloat64ArrayProxy

Per unit synchronous reactance of machine. Presently used only for Thevinen impedance for power flow calcs of user models (model=6). Typically use a value 0.4 to 1.0. Default is 1.0

DSS property name: Xd, DSS property index: 25.

Return type
BatchFloat64ArrayProxy
property Xdp: BatchFloat64ArrayProxy

Per unit transient reactance of the machine. Used for Dynamics mode and Fault studies. Default is 0.27.For user models, this value is used for the Thevinen/Norton impedance for Dynamics Mode.

DSS property name: Xdp, DSS property index: 26.

Return type
BatchFloat64ArrayProxy
property Xdpp: BatchFloat64ArrayProxy

Per unit subtransient reactance of the machine. Used for Harmonics. Default is 0.20.

DSS property name: Xdpp, DSS property index: 27.

Return type
BatchFloat64ArrayProxy
property basefreq: BatchFloat64ArrayProxy

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 44.

Return type
BatchFloat64ArrayProxy
property bus1: List[str]

Bus to which the Generator is connected. May include specific node specification.

DSS property name: bus1, DSS property index: 2.

Return type
List[str]
property cls: BatchInt32ArrayProxy

An arbitrary integer number representing the class of Generator so that Generator values may be segregated by class.

DSS property name: class, DSS property index: 17.

Return type
BatchInt32ArrayProxy
property conn: BatchInt32ArrayProxy

={wye|LN|delta|LL}. Default is wye.

DSS property name: conn, DSS property index: 15.

Return type
BatchInt32ArrayProxy
property conn_str: str

={wye|LN|delta|LL}. Default is wye.

DSS property name: conn, DSS property index: 15.

Return type
str
property daily: List[str]

Dispatch shape to use for daily simulations. Must be previously defined as a Loadshape object of 24 hrs, typically. If generator is assumed to be ON continuously, specify Status=FIXED, or designate a Loadshape objectthat is 1.0 perunit for all hours. Set to NONE to reset to no loadahape.

DSS property name: daily, DSS property index: 11.

Return type
List[str]
property daily_obj: List[str]

Dispatch shape to use for daily simulations. Must be previously defined as a Loadshape object of 24 hrs, typically. If generator is assumed to be ON continuously, specify Status=FIXED, or designate a Loadshape objectthat is 1.0 perunit for all hours. Set to NONE to reset to no loadahape.

DSS property name: daily, DSS property index: 11.

Return type
List[str]
property debugtrace: List[bool]

{Yes | No } Default is no. Turn this on to capture the progress of the generator model for each iteration. Creates a separate file for each generator named “GEN_name.CSV”.

DSS property name: debugtrace, DSS property index: 35.

Return type
List[bool]
property dispmode: BatchInt32ArrayProxy

{Default* | Loadlevel | Price } Default = Default. Dispatch mode. In default mode, gen is either always on or follows dispatch curve as specified. Otherwise, the gen comes on when either the global default load level (Loadshape “default”) or the price level exceeds the dispatch value.

DSS property name: dispmode, DSS property index: 13.

Return type
BatchInt32ArrayProxy
property dispmode_str: str

{Default* | Loadlevel | Price } Default = Default. Dispatch mode. In default mode, gen is either always on or follows dispatch curve as specified. Otherwise, the gen comes on when either the global default load level (Loadshape “default”) or the price level exceeds the dispatch value.

DSS property name: dispmode, DSS property index: 13.

Return type
str
property dispvalue: BatchFloat64ArrayProxy

Dispatch value. If = 0.0 (default) then Generator follow dispatch curves, if any. If > 0 then Generator is ON only when either the price signal (in Price dispatch mode) exceeds this value or the active circuit load multiplier * “default” loadshape value * the default yearly growth factor exceeds this value. Then the generator follows dispatch curves (duty, daily, or yearly), if any (see also Status).

DSS property name: dispvalue, DSS property index: 14.

Return type
BatchFloat64ArrayProxy
property duty: List[str]

Load shape to use for duty cycle dispatch simulations such as for wind generation. Must be previously defined as a Loadshape object. Typically would have time intervals less than 1 hr – perhaps, in seconds. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.

DSS property name: duty, DSS property index: 12.

Return type
List[str]
property duty_obj: List[str]

Load shape to use for duty cycle dispatch simulations such as for wind generation. Must be previously defined as a Loadshape object. Typically would have time intervals less than 1 hr – perhaps, in seconds. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.

DSS property name: duty, DSS property index: 12.

Return type
List[str]
property enabled: List[bool]

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 45.

Return type
List[bool]
property forceon: List[bool]

{Yes | No} Forces generator ON despite requirements of other dispatch modes. Stays ON until this property is set to NO, or an internal algorithm cancels the forced ON state.

DSS property name: forceon, DSS property index: 22.

Return type
List[bool]
property kVA: BatchFloat64ArrayProxy

kVA rating of electrical machine. Defaults to 1.2* kW if not specified. Applied to machine or inverter definition for Dynamics mode solutions.

DSS property name: kVA, DSS property index: 23.

Return type
BatchFloat64ArrayProxy
property kW: BatchFloat64ArrayProxy

Total base kW for the Generator. A positive value denotes power coming OUT of the element, which is the opposite of a load. This value is modified depending on the dispatch mode. Unaffected by the global load multiplier and growth curves. If you want there to be more generation, you must add more generators or change this value.

DSS property name: kW, DSS property index: 4.

Return type
BatchFloat64ArrayProxy
property kv: BatchFloat64ArrayProxy

Nominal rated (1.0 per unit) voltage, kV, for Generator. For 2- and 3-phase Generators, specify phase-phase kV. Otherwise, for phases=1 or phases>3, specify actual kV across each branch of the Generator. If wye (star), specify phase-neutral kV. If delta or phase-phase connected, specify phase-phase kV.

DSS property name: kv, DSS property index: 3.

Return type
BatchFloat64ArrayProxy
property kvar: BatchFloat64ArrayProxy

Specify the base kvar. Alternative to specifying the power factor. Side effect: the power factor value is altered to agree based on present value of kW.

DSS property name: kvar, DSS property index: 6.

Return type
BatchFloat64ArrayProxy
property maxkvar: BatchFloat64ArrayProxy

Maximum kvar limit for Model = 3. Defaults to twice the specified load kvar. Always reset this if you change PF or kvar properties.

DSS property name: maxkvar, DSS property index: 19.

Return type
BatchFloat64ArrayProxy
property minkvar: BatchFloat64ArrayProxy

Minimum kvar limit for Model = 3. Enter a negative number if generator can absorb vars. Defaults to negative of Maxkvar. Always reset this if you change PF or kvar properties.

DSS property name: minkvar, DSS property index: 20.

Return type
BatchFloat64ArrayProxy
property model: BatchInt32ArrayProxy

Integer code for the model to use for generation variation with voltage. Valid values are:

1:Generator injects a constant kW at specified power factor. 2:Generator is modeled as a constant admittance. 3:Const kW, constant kV. Somewhat like a conventional transmission power flow P-V generator. 4:Const kW, Fixed Q (Q never varies) 5:Const kW, Fixed Q(as a constant reactance) 6:Compute load injection from User-written Model.(see usage of Xd, Xdp) 7:Constant kW, kvar, but current-limited below Vminpu. Approximates a simple inverter. See also Balanced.

DSS property name: model, DSS property index: 7.

Return type
BatchInt32ArrayProxy
property pctFuel: BatchFloat64ArrayProxy

It is a number between 0 and 100 representing the current amount of fuel avaiable in percentage of FuelkWh. It only applies if UseFuel = Yes/True

DSS property name: %Fuel, DSS property index: 40.

Return type
BatchFloat64ArrayProxy
property pctReserve: BatchFloat64ArrayProxy

It is a number between 0 and 100 representing the reserve level in percentage of FuelkWh. It only applies if UseFuel = Yes/True

DSS property name: %Reserve, DSS property index: 41.

Return type
BatchFloat64ArrayProxy
property pf: BatchFloat64ArrayProxy

Generator power factor. Default is 0.80. Enter negative for leading powerfactor (when kW and kvar have opposite signs.) A positive power factor for a generator signifies that the generator produces vars as is typical for a synchronous generator. Induction machines would be specified with a negative power factor.

DSS property name: pf, DSS property index: 5.

Return type
BatchFloat64ArrayProxy
property phases: BatchInt32ArrayProxy

Number of Phases, this Generator. Power is evenly divided among phases.

DSS property name: phases, DSS property index: 1.

Return type
BatchInt32ArrayProxy
property pvfactor: BatchFloat64ArrayProxy

Deceleration factor for P-V generator model (Model=3). Default is 0.1. If the circuit converges easily, you may want to use a higher number such as 1.0. Use a lower number if solution diverges. Use Debugtrace=yes to create a file that will trace the convergence of a generator model.

DSS property name: pvfactor, DSS property index: 21.

Return type
BatchFloat64ArrayProxy
property spectrum: List[str]

Name of harmonic voltage or current spectrum for this generator. Voltage behind Xd” for machine - default. Current injection for inverter. Default value is “default”, which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 43.

Return type
List[str]
property spectrum_obj: List[str]

Name of harmonic voltage or current spectrum for this generator. Voltage behind Xd” for machine - default. Current injection for inverter. Default value is “default”, which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 43.

Return type
List[str]
property status: BatchInt32ArrayProxy

={Fixed | Variable*}. If Fixed, then dispatch multipliers do not apply. The generator is alway at full power when it is ON. Default is Variable (follows curves).

DSS property name: status, DSS property index: 16.

Return type
BatchInt32ArrayProxy
property status_str: str

={Fixed | Variable*}. If Fixed, then dispatch multipliers do not apply. The generator is alway at full power when it is ON. Default is Variable (follows curves).

DSS property name: status, DSS property index: 16.

Return type
str
property yearly: List[str]

Dispatch shape to use for yearly simulations. Must be previously defined as a Loadshape object. If this is not specified, a constant value is assumed (no variation). If the generator is assumed to be ON continuously, specify Status=FIXED, or designate a curve that is 1.0 per unit at all times. Set to NONE to reset to no loadahape. Nominally for 8760 simulations. If there are fewer points in the designated shape than the number of points in the solution, the curve is repeated.

DSS property name: yearly, DSS property index: 10.

Return type
List[str]
property yearly_obj: List[str]

Dispatch shape to use for yearly simulations. Must be previously defined as a Loadshape object. If this is not specified, a constant value is assumed (no variation). If the generator is assumed to be ON continuously, specify Status=FIXED, or designate a curve that is 1.0 per unit at all times. Set to NONE to reset to no loadahape. Nominally for 8760 simulations. If there are fewer points in the designated shape than the number of points in the solution, the curve is repeated.

DSS property name: yearly, DSS property index: 10.

Return type
List[str]
class dss.IObj.GrowthShape(api_util, ptr)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 7.

property csvfile: str

Switch input of growth curve data to a csv file containing (year, mult) points, one per line.

DSS property name: csvfile, DSS property index: 4.

Return type
str
property dblfile: str

Switch input of growth curve data to a binary file of doubles containing (year, mult) points, packed one after another.

DSS property name: dblfile, DSS property index: 6.

Return type
str
property mult: ndarray[Any, dtype[float64]]

Array of growth multiplier values, or a text file spec, corresponding to the year values. Enter the multiplier by which you would multiply the previous year’s load to get the present year’s.

Examples:

Year = [1, 2, 5] Mult=[1.05, 1.025, 1.02]. Year= (File=years.txt) Mult= (file=mults.txt).

Text files contain one value per line.

DSS property name: mult, DSS property index: 3.

Return type
ndarray[Any, dtype[float64]]
property npts: int

Number of points to expect in subsequent vector.

DSS property name: npts, DSS property index: 1.

Return type
int
property sngfile: str

Switch input of growth curve data to a binary file of singles containing (year, mult) points, packed one after another.

DSS property name: sngfile, DSS property index: 5.

Return type
str
property year: ndarray[Any, dtype[float64]]

Array of year values, or a text file spec, corresponding to the multipliers. Enter only those years where the growth changes. May be any integer sequence – just so it is consistent. See help on Mult.

DSS property name: year, DSS property index: 2.

Return type
ndarray[Any, dtype[float64]]
class dss.IObj.GrowthShapeBatch(api_util, **kwargs)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 7.

property csvfile: List[str]

Switch input of growth curve data to a csv file containing (year, mult) points, one per line.

DSS property name: csvfile, DSS property index: 4.

Return type
List[str]
property dblfile: List[str]

Switch input of growth curve data to a binary file of doubles containing (year, mult) points, packed one after another.

DSS property name: dblfile, DSS property index: 6.

Return type
List[str]
property mult: List[ndarray[Any, dtype[float64]]]

Array of growth multiplier values, or a text file spec, corresponding to the year values. Enter the multiplier by which you would multiply the previous year’s load to get the present year’s.

Examples:

Year = [1, 2, 5] Mult=[1.05, 1.025, 1.02]. Year= (File=years.txt) Mult= (file=mults.txt).

Text files contain one value per line.

DSS property name: mult, DSS property index: 3.

Return type
List[ndarray[Any, dtype[float64]]]
property npts: BatchInt32ArrayProxy

Number of points to expect in subsequent vector.

DSS property name: npts, DSS property index: 1.

Return type
BatchInt32ArrayProxy
property sngfile: List[str]

Switch input of growth curve data to a binary file of singles containing (year, mult) points, packed one after another.

DSS property name: sngfile, DSS property index: 5.

Return type
List[str]
property year: List[ndarray[Any, dtype[float64]]]

Array of year values, or a text file spec, corresponding to the multipliers. Enter only those years where the growth changes. May be any integer sequence – just so it is consistent. See help on Mult.

DSS property name: year, DSS property index: 2.

Return type
List[ndarray[Any, dtype[float64]]]
class dss.IObj.IDSSObj(iobj, cls_idx, obj_cls, batch_cls)
batch(**kwargs)

Creates a new batch hanlder of (existing) objects

find(name_or_idx)
new(name, begin_edit=True, activate=False)
class dss.IObj.IObj(api_util)
AutoTrans
CNData
CapControl
Capacitor
ESPVLControl
EnergyMeter
ExpControl
Fault
Fuse
GICLine
GICTransformer
GICsource
GenDispatcher
Generator
GrowthShape
IndMach012
InvControl
Isource
Line
LineCode
LineGeometry
LineSpacing
Load
LoadShape
Monitor
PVSystem
PriceShape
Reactor
Recloser
RegControl
Relay
Sensor
Spectrum
Storage
StorageController
SwtControl
TCC_Curve
TSData
TShape
Transformer
UPFC
UPFCControl
VCCS
VSConverter
Vsource
WireData
XYcurve
XfmrCode
class dss.IObj.IndMach012(api_util, ptr)
class IndMach012SlipOption(value)

IndMach012: Slip Option (DSS enumeration for IndMach012)

FixedSlip = 1
VariableSlip = 0
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 25.

property D: float

Damping constant. Usual range is 0 to 4. Default is 1.0. Adjust to get damping in Dynamics mode,

DSS property name: D, DSS property index: 9.

Return type
float
property Daily: str

LOADSHAPE object to use for daily simulations. Must be previously defined as a Loadshape object of 24 hrs, typically. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. Default is no variation (constant) if not defined. Side effect: Sets Yearly load shape if not already defined.

DSS property name: Daily, DSS property index: 19.

Return type
str
property Daily_obj: LoadShape

LOADSHAPE object to use for daily simulations. Must be previously defined as a Loadshape object of 24 hrs, typically. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. Default is no variation (constant) if not defined. Side effect: Sets Yearly load shape if not already defined.

DSS property name: Daily, DSS property index: 19.

Return type
LoadShape
property Debugtrace: bool

[Yes | No*] Write DebugTrace file.

DSS property name: Debugtrace, DSS property index: 21.

Return type
bool
property Duty: str

LOADSHAPE object to use for duty cycle simulations. Must be previously defined as a Loadshape object. Typically would have time intervals less than 1 hr. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.Set to NONE to reset to no loadahape. Set Status=Fixed to ignore Loadshape designation. Defaults to Daily curve If not specified.

DSS property name: Duty, DSS property index: 20.

Return type
str
property Duty_obj: LoadShape

LOADSHAPE object to use for duty cycle simulations. Must be previously defined as a Loadshape object. Typically would have time intervals less than 1 hr. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.Set to NONE to reset to no loadahape. Set Status=Fixed to ignore Loadshape designation. Defaults to Daily curve If not specified.

DSS property name: Duty, DSS property index: 20.

Return type
LoadShape
property H: float

Per unit mass constant of the machine. MW-sec/MVA. Default is 1.0.

DSS property name: H, DSS property index: 8.

Return type
float
property MaxSlip: float

Max slip value to allow. Default is 0.1. Set this before setting slip.

DSS property name: MaxSlip, DSS property index: 16.

Return type
float
property Slip: float

Initial slip value. Default is 0.007

DSS property name: Slip, DSS property index: 15.

Return type
float
property SlipOption: IndMach012SlipOption

Option for slip model. One of {fixedslip | variableslip* }

DSS property name: SlipOption, DSS property index: 17.

Return type
IndMach012SlipOption
property SlipOption_str: str

Option for slip model. One of {fixedslip | variableslip* }

DSS property name: SlipOption, DSS property index: 17.

Return type
str
property Yearly: str

LOADSHAPE object to use for yearly simulations. Must be previously defined as a Loadshape object. Is set to the Daily load shape when Daily is defined. The daily load shape is repeated in this case. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. The default is no variation.

DSS property name: Yearly, DSS property index: 18.

Return type
str
property Yearly_obj: LoadShape

LOADSHAPE object to use for yearly simulations. Must be previously defined as a Loadshape object. Is set to the Daily load shape when Daily is defined. The daily load shape is repeated in this case. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. The default is no variation.

DSS property name: Yearly, DSS property index: 18.

Return type
LoadShape
property basefreq: float

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 23.

Return type
float
property bus1: str

Bus to which the Induction Machine is connected. May include specific node specification.

DSS property name: bus1, DSS property index: 2.

Return type
str
property conn: Connection

Connection of stator: Delta or Wye. Default is Delta.

DSS property name: conn, DSS property index: 6.

Return type
Connection
property conn_str: str

Connection of stator: Delta or Wye. Default is Delta.

DSS property name: conn, DSS property index: 6.

Return type
str
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 24.

Return type
bool
property kVA: float

Rated kVA for the machine.

DSS property name: kVA, DSS property index: 7.

Return type
float
property kW: float

Shaft Power, kW, for the Induction Machine. A positive value denotes power for a load. Negative value denotes an induction generator.

DSS property name: kW, DSS property index: 4.

Return type
float
property kv: float

Nominal rated (1.0 per unit) voltage, kV. For 2- and 3-phase machines, specify phase-phase kV. Otherwise, specify actual kV across each branch of the machine. If wye (star), specify phase-neutral kV. If delta or phase-phase connected, specify phase-phase kV.

DSS property name: kv, DSS property index: 3.

Return type
float
property pf: float

[Read Only] Present power factor for the machine.

DSS property name: pf, DSS property index: 5.

Return type
float
property phases: int

Number of Phases, this Induction Machine.

DSS property name: phases, DSS property index: 1.

Return type
int
property puRr: float

Per unit rotor resistance. Default is 0.007.

DSS property name: puRr, DSS property index: 12.

Return type
float
property puRs: float

Per unit stator resistance. Default is 0.0053.

DSS property name: puRs, DSS property index: 10.

Return type
float
property puXm: float

Per unit magnetizing reactance.Default is 4.0.

DSS property name: puXm, DSS property index: 14.

Return type
float
property puXr: float

Per unit rotor leakage reactance. Default is 0.12.

DSS property name: puXr, DSS property index: 13.

Return type
float
property puXs: float

Per unit stator leakage reactance. Default is 0.106.

DSS property name: puXs, DSS property index: 11.

Return type
float
property spectrum: str

Name of harmonic voltage or current spectrum for this IndMach012. Voltage behind Xd” for machine - default. Current injection for inverter. Default value is “default”, which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 22.

Return type
str
property spectrum_obj: Spectrum

Name of harmonic voltage or current spectrum for this IndMach012. Voltage behind Xd” for machine - default. Current injection for inverter. Default value is “default”, which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 22.

Return type
Spectrum
class dss.IObj.IndMach012Batch(api_util, **kwargs)
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 25.

property D: BatchFloat64ArrayProxy

Damping constant. Usual range is 0 to 4. Default is 1.0. Adjust to get damping in Dynamics mode,

DSS property name: D, DSS property index: 9.

Return type
BatchFloat64ArrayProxy
property Daily: List[str]

LOADSHAPE object to use for daily simulations. Must be previously defined as a Loadshape object of 24 hrs, typically. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. Default is no variation (constant) if not defined. Side effect: Sets Yearly load shape if not already defined.

DSS property name: Daily, DSS property index: 19.

Return type
List[str]
property Daily_obj: List[str]

LOADSHAPE object to use for daily simulations. Must be previously defined as a Loadshape object of 24 hrs, typically. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. Default is no variation (constant) if not defined. Side effect: Sets Yearly load shape if not already defined.

DSS property name: Daily, DSS property index: 19.

Return type
List[str]
property Debugtrace: List[bool]

[Yes | No*] Write DebugTrace file.

DSS property name: Debugtrace, DSS property index: 21.

Return type
List[bool]
property Duty: List[str]

LOADSHAPE object to use for duty cycle simulations. Must be previously defined as a Loadshape object. Typically would have time intervals less than 1 hr. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.Set to NONE to reset to no loadahape. Set Status=Fixed to ignore Loadshape designation. Defaults to Daily curve If not specified.

DSS property name: Duty, DSS property index: 20.

Return type
List[str]
property Duty_obj: List[str]

LOADSHAPE object to use for duty cycle simulations. Must be previously defined as a Loadshape object. Typically would have time intervals less than 1 hr. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.Set to NONE to reset to no loadahape. Set Status=Fixed to ignore Loadshape designation. Defaults to Daily curve If not specified.

DSS property name: Duty, DSS property index: 20.

Return type
List[str]
property H: BatchFloat64ArrayProxy

Per unit mass constant of the machine. MW-sec/MVA. Default is 1.0.

DSS property name: H, DSS property index: 8.

Return type
BatchFloat64ArrayProxy
property MaxSlip: BatchFloat64ArrayProxy

Max slip value to allow. Default is 0.1. Set this before setting slip.

DSS property name: MaxSlip, DSS property index: 16.

Return type
BatchFloat64ArrayProxy
property Slip: BatchFloat64ArrayProxy

Initial slip value. Default is 0.007

DSS property name: Slip, DSS property index: 15.

Return type
BatchFloat64ArrayProxy
property SlipOption: BatchInt32ArrayProxy

Option for slip model. One of {fixedslip | variableslip* }

DSS property name: SlipOption, DSS property index: 17.

Return type
BatchInt32ArrayProxy
property SlipOption_str: str

Option for slip model. One of {fixedslip | variableslip* }

DSS property name: SlipOption, DSS property index: 17.

Return type
str
property Yearly: List[str]

LOADSHAPE object to use for yearly simulations. Must be previously defined as a Loadshape object. Is set to the Daily load shape when Daily is defined. The daily load shape is repeated in this case. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. The default is no variation.

DSS property name: Yearly, DSS property index: 18.

Return type
List[str]
property Yearly_obj: List[str]

LOADSHAPE object to use for yearly simulations. Must be previously defined as a Loadshape object. Is set to the Daily load shape when Daily is defined. The daily load shape is repeated in this case. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. The default is no variation.

DSS property name: Yearly, DSS property index: 18.

Return type
List[str]
property basefreq: BatchFloat64ArrayProxy

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 23.

Return type
BatchFloat64ArrayProxy
property bus1: List[str]

Bus to which the Induction Machine is connected. May include specific node specification.

DSS property name: bus1, DSS property index: 2.

Return type
List[str]
property conn: BatchInt32ArrayProxy

Connection of stator: Delta or Wye. Default is Delta.

DSS property name: conn, DSS property index: 6.

Return type
BatchInt32ArrayProxy
property conn_str: str

Connection of stator: Delta or Wye. Default is Delta.

DSS property name: conn, DSS property index: 6.

Return type
str
property enabled: List[bool]

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 24.

Return type
List[bool]
property kVA: BatchFloat64ArrayProxy

Rated kVA for the machine.

DSS property name: kVA, DSS property index: 7.

Return type
BatchFloat64ArrayProxy
property kW: BatchFloat64ArrayProxy

Shaft Power, kW, for the Induction Machine. A positive value denotes power for a load. Negative value denotes an induction generator.

DSS property name: kW, DSS property index: 4.

Return type
BatchFloat64ArrayProxy
property kv: BatchFloat64ArrayProxy

Nominal rated (1.0 per unit) voltage, kV. For 2- and 3-phase machines, specify phase-phase kV. Otherwise, specify actual kV across each branch of the machine. If wye (star), specify phase-neutral kV. If delta or phase-phase connected, specify phase-phase kV.

DSS property name: kv, DSS property index: 3.

Return type
BatchFloat64ArrayProxy
property pf: BatchFloat64ArrayProxy

[Read Only] Present power factor for the machine.

DSS property name: pf, DSS property index: 5.

Return type
BatchFloat64ArrayProxy
property phases: BatchInt32ArrayProxy

Number of Phases, this Induction Machine.

DSS property name: phases, DSS property index: 1.

Return type
BatchInt32ArrayProxy
property puRr: BatchFloat64ArrayProxy

Per unit rotor resistance. Default is 0.007.

DSS property name: puRr, DSS property index: 12.

Return type
BatchFloat64ArrayProxy
property puRs: BatchFloat64ArrayProxy

Per unit stator resistance. Default is 0.0053.

DSS property name: puRs, DSS property index: 10.

Return type
BatchFloat64ArrayProxy
property puXm: BatchFloat64ArrayProxy

Per unit magnetizing reactance.Default is 4.0.

DSS property name: puXm, DSS property index: 14.

Return type
BatchFloat64ArrayProxy
property puXr: BatchFloat64ArrayProxy

Per unit rotor leakage reactance. Default is 0.12.

DSS property name: puXr, DSS property index: 13.

Return type
BatchFloat64ArrayProxy
property puXs: BatchFloat64ArrayProxy

Per unit stator leakage reactance. Default is 0.106.

DSS property name: puXs, DSS property index: 11.

Return type
BatchFloat64ArrayProxy
property spectrum: List[str]

Name of harmonic voltage or current spectrum for this IndMach012. Voltage behind Xd” for machine - default. Current injection for inverter. Default value is “default”, which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 22.

Return type
List[str]
property spectrum_obj: List[str]

Name of harmonic voltage or current spectrum for this IndMach012. Voltage behind Xd” for machine - default. Current injection for inverter. Default value is “default”, which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 22.

Return type
List[str]
class dss.IObj.InvControl(api_util, ptr)
class InvControlCombiMode(value)

InvControl: Combi Mode (DSS enumeration for InvControl)

VV_DRC = 2
VV_VW = 1
class InvControlControlMode(value)

InvControl: Control Mode (DSS enumeration for InvControl)

AVR = 6
DynamicReaccurr = 3
VoltWatt = 2
Voltvar = 1
WattPF = 4
Wattvar = 5
class InvControlRateOfChangeMode(value)

InvControl: Rate-of-change Mode (DSS enumeration for InvControl)

Inactive = 0
LPF = 1
RiseFall = 2
class InvControlReactivePowerReference(value)

InvControl: Reactive Power Reference (DSS enumeration for InvControl)

VARAVAL = 0
VARMAX = 1
class InvControlVoltWattYAxis(value)

InvControl: Volt-watt Y-Axis (DSS enumeration for InvControl)

KVARatingPU = 3
PAvailablePU = 0
PMPPPU = 1
PctPMPPPU = 2
class InvControlVoltageCurveXRef(value)

InvControl: Voltage Curve X Ref (DSS enumeration for InvControl)

Avg = 1
RAvg = 2
Rated = 0
like(value)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: like, DSS property index: 35.

property ActivePChangeTolerance: float

Required for VOLTWATT. Default is 0.01

Tolerance in pu of the convergence of the control loop associated with active power. For the same control iteration, this value is compared to the difference between the active power limit in pu resulted from the convergence process and the one resulted from the volt-watt function.

This reactive power tolerance value plus the voltage tolerance value (VoltageChangeTolerance) determine, together, when to stop control iterations by the InvControl.

If an InvControl is controlling more than one PVSystem/Storage, each PVSystem/Storage has this quantity calculated independently, and so an individual PVSystem/Storage may reach the tolerance within different numbers of control iterations.

DSS property name: ActivePChangeTolerance, DSS property index: 24.

Return type
float
property ArGraHiV: float

Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 0.1

This is a gradient, expressed in unit-less terms of %/%, to establish the ratio by which percentage inductive reactive power production is increased as the percent delta-voltage decreases above DbVMax.

Percent delta-voltage is defined as the present PVSystem/Storage terminal voltage minus the moving average voltage, expressed as a percentage of the rated voltage for the PVSystem/Storage object.

Note, the moving average voltage for the dynamic reactive current mode is different than the mmoving average voltage for the volt-watt and volt-var modes.

DSS property name: ArGraHiV, DSS property index: 12.

Return type
float
property ArGraLowV: float

Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 0.1

This is a gradient, expressed in unit-less terms of %/%, to establish the ratio by which percentage capacitive reactive power production is increased as the percent delta-voltage decreases below DbVMin.

Percent delta-voltage is defined as the present PVSystem/Storage terminal voltage minus the moving average voltage, expressed as a percentage of the rated voltage for the PVSystem/Storage object.

Note, the moving average voltage for the dynamic reactive current mode is different than the moving average voltage for the volt-watt and volt-var modes.

DSS property name: ArGraLowV, DSS property index: 11.

Return type
float
property CombiMode: InvControlCombiMode

Combination of smart inverter functions in which the InvControl will control the PC elements in DERList, according to the options below:

Must be a combination of the following: {VV_VW | VV_DRC}. Default is to not set this property, in which case the single control mode in Mode is active.

In combined VV_VW mode, both volt-var and volt-watt control modes are active simultaneously. See help individually for volt-var mode and volt-watt mode in Mode property. Note that the PVSystem/Storage will attempt to achieve both the volt-watt and volt-var set-points based on the capabilities of the inverter in the PVSystem/Storage (kVA rating, etc), any limits set on maximum active power,

In combined VV_DRC, both the volt-var and the dynamic reactive current modes are simultaneously active.

DSS property name: CombiMode, DSS property index: 3.

Return type
InvControlCombiMode
property CombiMode_str: str

Combination of smart inverter functions in which the InvControl will control the PC elements in DERList, according to the options below:

Must be a combination of the following: {VV_VW | VV_DRC}. Default is to not set this property, in which case the single control mode in Mode is active.

In combined VV_VW mode, both volt-var and volt-watt control modes are active simultaneously. See help individually for volt-var mode and volt-watt mode in Mode property. Note that the PVSystem/Storage will attempt to achieve both the volt-watt and volt-var set-points based on the capabilities of the inverter in the PVSystem/Storage (kVA rating, etc), any limits set on maximum active power,

In combined VV_DRC, both the volt-var and the dynamic reactive current modes are simultaneously active.

DSS property name: CombiMode, DSS property index: 3.

Return type
str
property DERList: List[str]

Array list of PVSystem and/or Storage elements to be controlled. If not specified, all PVSystem and Storage in the circuit are assumed to be controlled by this control.

No capability of hierarchical control between two controls for a single element is implemented at this time.

DSS property name: DERList, DSS property index: 1.

Return type
List[str]
property DbVMax: float

Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 1.05 per-unit voltage (referenced to the PVSystem object rated voltage or a windowed average value).

This parameter is the maximum voltage that defines the voltage dead-band within which no reactive power is allowed to be generated.

DSS property name: DbVMax, DSS property index: 10.

Return type
float
property DbVMin: float

Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 0.95 per-unit voltage (referenced to the PVSystem/Storage object rated voltage or a windowed average value).

This parameter is the minimum voltage that defines the voltage dead-band within which no reactive power is allowed to be generated.

DSS property name: DbVMin, DSS property index: 9.

Return type
float
property DynReacavgwindowlen: int

Required for the dynamic reactive current mode (DYNAMICREACCURR), and defaults to 1 seconds (1s). do not use a value smaller than 1.0

Sets the length of the averaging window over which the average PVSystem/Storage terminal voltage is calculated for the dynamic reactive current mode.

Units are indicated by appending s, m, or h to the integer value.

Typically this will be a shorter averaging window than the volt-var and volt-watt averaging window.

The averaging window will calculate the average PVSystem/Storage terminal voltage over the specified period of time, up to and including the last power flow solution. Note, if the solution stepsize is larger than the window length, then the voltage will be assumed to have been constant over the time-frame specified by the window length.

DSS property name: DynReacavgwindowlen, DSS property index: 13.

Return type
int
property EventLog: bool

{Yes/True* | No/False} Default is YES for InvControl. Log control actions to Eventlog.

DSS property name: EventLog, DSS property index: 22.

Return type
bool
property LPFTau: float

Not required. Defaults to 0 seconds.

Filter time constant of the LPF option of the RateofChangeMode property. The time constant will cause the low-pass filter to achieve 95% of the target value in 3 time constants.

DSS property name: LPFTau, DSS property index: 19.

Return type
float
property Mode: InvControlControlMode

Smart inverter function in which the InvControl will control the PC elements specified in DERList, according to the options below:

Must be one of: {VOLTVAR* | VOLTWATT | DYNAMICREACCURR | WATTPF | WATTVAR} if the user desires to use modes simultaneously, then set the CombiMode property. Setting the Mode to any valid value disables combination mode.

In volt-var mode (Default). This mode attempts to CONTROL the vars, according to one or two volt-var curves, depending on the monitored voltages, present active power output, and the capabilities of the PVSystem/Storage.

In volt-watt mode. This mode attempts to LIMIT the watts, according to one defined volt-watt curve, depending on the monitored voltages and the capabilities of the PVSystem/Storage.

In dynamic reactive current mode. This mode attempts to increasingly counter deviations by CONTROLLING vars, depending on the monitored voltages, present active power output, and the capabilities of the of the PVSystem/Storage.

In watt-pf mode. This mode attempts to CONTROL the vars, according to a watt-pf curve, depending on the present active power output, and the capabilities of the PVSystem/Storage.

In watt-var mode. This mode attempts to CONTROL the vars, according to a watt-var curve, depending on the present active power output, and the capabilities of the PVSystem/Storage.

DSS property name: Mode, DSS property index: 2.

Return type
InvControlControlMode
property Mode_str: str

Smart inverter function in which the InvControl will control the PC elements specified in DERList, according to the options below:

Must be one of: {VOLTVAR* | VOLTWATT | DYNAMICREACCURR | WATTPF | WATTVAR} if the user desires to use modes simultaneously, then set the CombiMode property. Setting the Mode to any valid value disables combination mode.

In volt-var mode (Default). This mode attempts to CONTROL the vars, according to one or two volt-var curves, depending on the monitored voltages, present active power output, and the capabilities of the PVSystem/Storage.

In volt-watt mode. This mode attempts to LIMIT the watts, according to one defined volt-watt curve, depending on the monitored voltages and the capabilities of the PVSystem/Storage.

In dynamic reactive current mode. This mode attempts to increasingly counter deviations by CONTROLLING vars, depending on the monitored voltages, present active power output, and the capabilities of the of the PVSystem/Storage.

In watt-pf mode. This mode attempts to CONTROL the vars, according to a watt-pf curve, depending on the present active power output, and the capabilities of the PVSystem/Storage.

In watt-var mode. This mode attempts to CONTROL the vars, according to a watt-var curve, depending on the present active power output, and the capabilities of the PVSystem/Storage.

DSS property name: Mode, DSS property index: 2.

Return type
str
property MonBusesVbase: ndarray[Any, dtype[float64]]

Array list of rated voltages of the buses and their nodes presented in the monBus property. This list may have different line-to-line and/or line-to-ground voltages.

DSS property name: MonBusesVbase, DSS property index: 27.

Return type
ndarray[Any, dtype[float64]]
property PVSystemList: List[str]

Deprecated, use DERList instead.

DSS property name: PVSystemList, DSS property index: 31.

Return type
List[str]
property RateofChangeMode: InvControlRateOfChangeMode

Required for VOLTWATT and VOLTVAR mode. Must be one of: {INACTIVE* | LPF | RISEFALL }. The default is INACTIVE.

Auxiliary option that aims to limit the changes of the desired reactive power and the active power limit between time steps, the alternatives are listed below:

INACTIVE. It indicates there is no limit on rate of change imposed for either active or reactive power output.

LPF. A low-pass RC filter is applied to the desired reactive power and/or the active power limit to determine the output power as a function of a time constant defined in the LPFTau property.

RISEFALL. A rise and fall limit in the change of active and/or reactive power expressed in terms of pu power per second, defined in the RiseFallLimit, is applied to the desired reactive power and/or the active power limit.

DSS property name: RateofChangeMode, DSS property index: 18.

Return type
InvControlRateOfChangeMode
property RateofChangeMode_str: str

Required for VOLTWATT and VOLTVAR mode. Must be one of: {INACTIVE* | LPF | RISEFALL }. The default is INACTIVE.

Auxiliary option that aims to limit the changes of the desired reactive power and the active power limit between time steps, the alternatives are listed below:

INACTIVE. It indicates there is no limit on rate of change imposed for either active or reactive power output.

LPF. A low-pass RC filter is applied to the desired reactive power and/or the active power limit to determine the output power as a function of a time constant defined in the LPFTau property.

RISEFALL. A rise and fall limit in the change of active and/or reactive power expressed in terms of pu power per second, defined in the RiseFallLimit, is applied to the desired reactive power and/or the active power limit.

DSS property name: RateofChangeMode, DSS property index: 18.

Return type
str
property RefReactivePower: InvControlReactivePowerReference

Required for any mode that has VOLTVAR, DYNAMICREACCURR and WATTVAR. Defaults to VARAVAL.

Defines the base reactive power for both the provided and absorbed reactive power, according to one of the following options:

VARAVAL. The base values for the provided and absorbed reactive power are equal to the available reactive power.

VARMAX: The base values of the provided and absorbed reactive power are equal to the value defined in the kvarMax and kvarMaxAbs properties, respectively.

DSS property name: RefReactivePower, DSS property index: 23.

Return type
InvControlReactivePowerReference
property RefReactivePower_str: str

Required for any mode that has VOLTVAR, DYNAMICREACCURR and WATTVAR. Defaults to VARAVAL.

Defines the base reactive power for both the provided and absorbed reactive power, according to one of the following options:

VARAVAL. The base values for the provided and absorbed reactive power are equal to the available reactive power.

VARMAX: The base values of the provided and absorbed reactive power are equal to the value defined in the kvarMax and kvarMaxAbs properties, respectively.

DSS property name: RefReactivePower, DSS property index: 23.

Return type
str
property RiseFallLimit: float

Not required. Defaults to no limit (-1). Must be -1 (no limit) or a positive value.

Limit in power in pu per second used by the RISEFALL option of the RateofChangeMode property.The base value for this ramp is defined in the RefReactivePower property and/or in VoltwattYAxis.

DSS property name: RiseFallLimit, DSS property index: 20.

Return type
float
property VarChangeTolerance: float

Required for VOLTVAR and DYNAMICREACCURR modes. Defaults to 0.025 per unit of the base provided or absorbed reactive power described in the RefReactivePower property This parameter should only be modified by advanced users of the InvControl.

Tolerance in pu of the convergence of the control loop associated with reactive power. For the same control iteration, this value is compared to the difference, as an absolute value (without sign), between the desired reactive power value in pu and the output reactive power in pu of the controlled element.

This reactive power tolerance value plus the voltage tolerance value (VoltageChangeTolerance) determine, together, when to stop control iterations by the InvControl.

If an InvControl is controlling more than one PVSystem/Storage, each PVSystem/Storage has this quantity calculated independently, and so an individual PVSystem/Storage may reach the tolerance within different numbers of control iterations.

DSS property name: VarChangeTolerance, DSS property index: 16.

Return type
float
property VoltageChangeTolerance: float

Defaults to 0.0001 per-unit voltage. This parameter should only be modified by advanced users of the InvControl.

Tolerance in pu of the control loop convergence associated to the monitored voltage in pu. This value is compared with the difference of the monitored voltage in pu of the current and previous control iterations of the control loop

This voltage tolerance value plus the var/watt tolerance value (VarChangeTolerance/ActivePChangeTolerance) determine, together, when to stop control iterations by the InvControl.

If an InvControl is controlling more than one PVSystem/Storage, each PVSystem/Storage has this quantity calculated independently, and so an individual PVSystem/Storage may reach the tolerance within different numbers of control iterations.

DSS property name: VoltageChangeTolerance, DSS property index: 15.

Return type
float
property VoltwattYAxis: InvControlVoltWattYAxis

Required for VOLTWATT mode. Must be one of: {PMPPPU* | PAVAILABLEPU| PCTPMPPPU | KVARATINGPU}. The default is PMPPPU.

Units for the y-axis of the volt-watt curve while in volt-watt mode.

When set to PMPPPU. The y-axis corresponds to the value in pu of Pmpp property of the PVSystem.

When set to PAVAILABLEPU. The y-axis corresponds to the value in pu of the available active power of the PVSystem.

When set to PCTPMPPPU. The y-axis corresponds to the value in pu of the power Pmpp multiplied by 1/100 of the %Pmpp property of the PVSystem.

When set to KVARATINGPU. The y-axis corresponds to the value in pu of the kVA property of the PVSystem.

DSS property name: VoltwattYAxis, DSS property index: 17.

Return type
InvControlVoltWattYAxis
property VoltwattYAxis_str: str

Required for VOLTWATT mode. Must be one of: {PMPPPU* | PAVAILABLEPU| PCTPMPPPU | KVARATINGPU}. The default is PMPPPU.

Units for the y-axis of the volt-watt curve while in volt-watt mode.

When set to PMPPPU. The y-axis corresponds to the value in pu of Pmpp property of the PVSystem.

When set to PAVAILABLEPU. The y-axis corresponds to the value in pu of the available active power of the PVSystem.

When set to PCTPMPPPU. The y-axis corresponds to the value in pu of the power Pmpp multiplied by 1/100 of the %Pmpp property of the PVSystem.

When set to KVARATINGPU. The y-axis corresponds to the value in pu of the kVA property of the PVSystem.

DSS property name: VoltwattYAxis, DSS property index: 17.

Return type
str
property Vsetpoint: float

Required for Active Voltage Regulation (AVR).

DSS property name: Vsetpoint, DSS property index: 32.

Return type
float
property avgwindowlen: int

Required for VOLTVAR mode and VOLTWATT mode, and defaults to 0 seconds (0s).

Sets the length of the averaging window over which the average PVSystem/Storage terminal voltage is calculated.

Units are indicated by appending s, m, or h to the integer value.

The averaging window will calculate the average PVSystem/Storage terminal voltage over the specified period of time, up to and including the last power flow solution.

Note, if the solution stepsize is larger than the window length, then the voltage will be assumed to have been constant over the time-frame specified by the window length.

DSS property name: avgwindowlen, DSS property index: 7.

Return type
int
property basefreq: float

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 33.

Return type
float
property deltaP_Factor: float

Required for the VOLTWATT modes. Defaults to -1.0.

Defining -1.0, OpenDSS takes care internally of delta_P itself. It tries to improve convergence as well as speed up process

Defining between 0.05 and 1.0, it sets the maximum change (in unit of the y-axis) from the prior active power output level to the desired active power output level during each control iteration.

If numerical instability is noticed in solutions such as active power changing substantially from one control iteration to the next and/or voltages oscillating between two values with some separation, this is an indication of numerical instability (use the EventLog to diagnose).

If the maximum control iterations are exceeded, and no numerical instability is seen in the EventLog of via monitors, then try increasing the value of this parameter to reduce the number of control iterations needed to achieve the control criteria, and move to the power flow solution.

DSS property name: deltaP_Factor, DSS property index: 21.

Return type
float
property deltaQ_Factor: float

Required for the VOLTVAR and DYNAMICREACCURR modes. Defaults to -1.0.

Defining -1.0, OpenDSS takes care internally of delta_Q itself. It tries to improve convergence as well as speed up process

Sets the maximum change (in per unit) from the prior var output level to the desired var output level during each control iteration.

if numerical instability is noticed in solutions such as var sign changing from one control iteration to the next and voltages oscillating between two values with some separation, this is an indication of numerical instability (use the EventLog to diagnose).

if the maximum control iterations are exceeded, and no numerical instability is seen in the EventLog of via monitors, then try increasing the value of this parameter to reduce the number of control iterations needed to achieve the control criteria, and move to the power flow solution.

DSS property name: deltaQ_Factor, DSS property index: 14.

Return type
float
property enabled: bool

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 34.

Return type
bool
property hysteresis_offset: float

Required for VOLTVAR mode, and defaults to 0.

for the times when the terminal voltage is decreasing, this is the off-set in per-unit voltage of a curve whose shape is the same as vvc_curve. It is offset by a certain negative value of per-unit voltage, which is defined by the base quantity for the x-axis of the volt-var curve (see help for voltage_curvex_ref)

if the PVSystem/Storage terminal voltage has been increasing, and has not changed directions, utilize vvc_curve1 for the volt-var response.

if the PVSystem/Storage terminal voltage has been increasing and changes directions and begins to decrease, then move from utilizing vvc_curve1 to a volt-var curve of the same shape, but offset by a certain per-unit voltage value.

Maintain the same per-unit available var output level (unless head-room has changed due to change in active power or kva rating of PVSystem/Storage). Per-unit var values remain the same for this internally constructed second curve (hysteresis curve).

if the terminal voltage has been decreasing and changes directions and begins to increase , then move from utilizing the offset curve, back to the vvc_curve1 for volt-var response, but stay at the same per-unit available vars output level.

DSS property name: hysteresis_offset, DSS property index: 5.

Return type
float
property monBus: List[str]

Name of monitored bus used by the voltage-dependente control modes. Default is bus of the controlled PVSystem/Storage or Storage.

DSS property name: monBus, DSS property index: 26.

Return type
List[str]
property monVoltageCalc: Union[MonitoredPhase, int]

Number of the phase being monitored or one of {AVG | MAX | MIN} for all phases. Default=AVG.

DSS property name: monVoltageCalc, DSS property index: 25.

Return type
Union[MonitoredPhase, int]
<