altdss.AutoTrans

`altdss.AutoTrans`#

Module Contents#

Classes#

`AutoTrans`
`AutoTransBatch`
`AutoTransBatchProperties`	dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)
`AutoTransProperties`	dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)
`IAutoTrans`

API#

class altdss.AutoTrans.AutoTrans(api_util, ptr)#

Bases: altdss.DSSObj.DSSObj, altdss.CircuitElement.CircuitElementMixin, altdss.PDElement.PDElementMixin, altdss.TransformerExtras.TransformerObjMixin

AccumulatedL() → float#

Accumulated failure rate for this branch on downline.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/AccumulatedL.html

Bank: str#

‘property(…)’

Name of the bank this transformer is part of, for CIM, MultiSpeak, and other interfaces.

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

BaseFreq: float#

‘property(…)’

Base Frequency for ratings.

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

Buses: List[str]#

‘property(…)’

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.

Close(terminal: int, phase: int) → None#

Close the specified terminal and phase, if non-zero, or all conductors at the terminal.

Original COM help: https://opendss.epri.com/Close1.html

ComplexSeqCurrents() → altdss.types.ComplexArray#

Complex double array of Sequence Currents for all conductors of all terminals of active circuit element.

Original COM help: https://opendss.epri.com/CplxSeqCurrents.html

ComplexSeqVoltages() → altdss.types.ComplexArray#

Complex double array of Sequence Voltage for all terminals of active circuit element.

Original COM help: https://opendss.epri.com/CplxSeqVoltages1.html

Conns: altdss.enums.AutoTransConnection#

‘property(…)’

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.

Conns_str: List[str]#

‘property(…)’

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.

Core: altdss.enums.CoreType#

‘property(…)’

{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.

Core_str: str#

‘property(…)’

{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.

Currents() → altdss.types.ComplexArray#

Complex array of currents into each conductor of each terminal

Original COM help: https://opendss.epri.com/Currents1.html

DisplayName: str#

‘property(…)’

Display name of the object (not necessarily unique)

Original COM help: https://opendss.epri.com/DisplayName.html

EmergAmps: float#

‘property(…)’

Maximum or emerg current.

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

EmergHkVA: float#

‘property(…)’

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

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

Enabled: bool#

‘property(…)’

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

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

EnergyMeter() → Optional[altdss.DSSObj.DSSObj]#

Energy Meter this element is assigned to.

Requires an energy meter with an updated zone.

Original COM help: https://opendss.epri.com/EnergyMeter.html

EnergyMeterName() → str#

Name of the Energy Meter this element is assigned to.

Requires an energy meter with an updated zone.

Original COM help: https://opendss.epri.com/EnergyMeter.html

FLRise: float#

‘property(…)’

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

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

FaultRate: float#

‘property(…)’

Failure rate per year.

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

FromTerminal() → int#

Number of the terminal of this PD element that is on the “from” side.

Requires an energy meter with an updated zone.

FullName() → str#

GUID() → str#

Object’s GUID/UUID. Currently used only in the CIM-related methods.

Original COM help: https://opendss.epri.com/GUID.html

HSRise: float#

‘property(…)’

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

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

Handle() → int#

Index of this element into the circuit’s element list.

Original COM help: https://opendss.epri.com/Handle.html

HasOCPDevice() → bool#

Returns true if a recloser, relay, or fuse controlling the circuit element.

OCP = Overcurrent Protection

Original COM help: https://opendss.epri.com/HasOCPDevice.html

HasSwitchControl() → bool#

Returns true if the element has a SwtControl attached.

Original COM help: https://opendss.epri.com/HasSwitchControl.html

HasVoltControl() → bool#

Returns true if the element has a CapControl or RegControl attached.

Original COM help: https://opendss.epri.com/HasVoltControl.html

IsIsolated() → bool#: Returns true if the element is isolated. Note that this only fetches the current value. See also the Topology interface.

IsOpen(terminal: int, phase: int) → bool#

Returns true if the specified terminal and phase are open.

If the phase parameter is zero, returns if any conductor at the terminal is open.

IsShunt() → bool#

Indicates if this PD element should be treated as a shunt element rather than a series element.

Applies to Capacitor, Reactor, Fault and GICTransformer elements.

Lambda() → float#

Failure rate for this branch. Faults per year including length of line.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/Lambda1.html

LeadLag: altdss.enums.PhaseSequence#

‘property(…)’

{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: 40.

LeadLag_str: str#

‘property(…)’

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

Like(value: AnyStr)#

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: Like, DSS property index: 49.

Losses() → complex#

Total (complex) losses in the element, in VA (watts, vars)

Original COM help: https://opendss.epri.com/Losses1.html

LossesByType() → altdss.types.ComplexArray#: Complex array with the losses by type (total losses, load losses, no-load losses), in VA

MaxCurrent(terminal: int) → float#: Returns the maximum current (magnitude) at the specified terminal. Use -1 as terminal to get the value across all terminals.

MaxTap: altdss.types.Float64Array#

‘property(…)’

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

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

MinTap: altdss.types.Float64Array#

‘property(…)’

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

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

property Name: str#

NodeOrder() → altdss.types.Int32Array#

Array of integer containing the node numbers (representing phases, for example) for each conductor of each terminal.

Be sure to run a solution to initialize the values after the circuit is created or modified.

NodeRef() → altdss.types.Int32Array#

Array of integers, a copy of the internal NodeRef of the CktElement.

Be sure to run a solution to initialize the values after the circuit is created or modified.

NormAmps: float#

‘property(…)’

Normal rated current.

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

NormHkVA: float#

‘property(…)’

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

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

NumConductors() → int#

Number of conductors per terminal

Original COM help: https://opendss.epri.com/NumConductors.html

NumControllers() → int#

Number of controllers connected to this device.

Original COM help: https://opendss.epri.com/NumControls.html

NumCustomers() → int#

Number of customers, this branch.

Requires an energy meter with an updated zone.

Original COM help: https://opendss.epri.com/Numcustomers.html

NumPhases() → int#

Number of phases

Original COM help: https://opendss.epri.com/NumPhases.html

NumTaps: altdss.types.Int32Array#

‘property(…)’

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.

NumTerminals() → int#

Number of terminals in this circuit element

Original COM help: https://opendss.epri.com/NumTerminals.html

OCPDevice() → Union[altdss.DSSObj.DSSObj, None]#: Returns (as a Python object) the OCP device controlling this element, if any.

OCPDeviceIndex() → int#

Index into controller list of OCP Device controlling this circuit element

Original COM help: https://opendss.epri.com/OCPDevIndex.html

OCPDeviceType() → dss.enums.OCPDevType#

Type of OCP controller device

Original COM help: https://opendss.epri.com/OCPDevType.html

Open(terminal: int, phase: int) → None#

Open the specified terminal and phase, if non-zero, or all conductors at the terminal.

Original COM help: https://opendss.epri.com/Open1.html

ParentPDElement() → Optional[altdss.DSSObj.DSSObj]#

Parent PD element of this element, if any.

Requires an energy meter with an updated zone.

PhaseLosses() → altdss.types.ComplexArray#

Complex array of losses (kVA) by phase

Original COM help: https://opendss.epri.com/PhaseLosses.html

Phases: int#

‘property(…)’

Number of phases this AutoTrans. Default is 3.

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

Powers() → altdss.types.ComplexArray#

Complex array of powers (kVA) into each conductor of each terminal

Original COM help: https://opendss.epri.com/Powers.html

RDCOhms: altdss.types.Float64Array#

‘property(…)’

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.

Repair: float#

‘property(…)’

Hours to repair.

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

Residuals() → altdss.types.Float64Array#

Residual currents for each terminal: (magnitude, angle in degrees)

Original COM help: https://opendss.epri.com/Residuals.html

SectionID() → int#

Integer ID of the feeder section that this PDElement branch is part of.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/SectionID1.html

SeqCurrents() → altdss.types.Float64Array#

Array of symmetrical component currents (magnitudes only) into each 3-phase terminal

Original COM help: https://opendss.epri.com/SeqCurrents.html

SeqPowers() → altdss.types.ComplexArray#

Complex array of sequence powers (kW, kvar) into each 3-phase terminal

Original COM help: https://opendss.epri.com/SeqPowers.html

SeqVoltages() → altdss.types.Float64Array#

Double array of symmetrical component voltages (magnitudes only) at each 3-phase terminal

Original COM help: https://opendss.epri.com/SeqVoltages1.html

Sub: bool#

‘property(…)’

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

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

SubName: str#

‘property(…)’

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

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

Taps: altdss.types.Float64Array#

‘property(…)’

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

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

Thermal: float#

‘property(…)’

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

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

TotalCustomers() → int#

Total number of customers from this branch to the end of the zone

Requires a circuit with an energy meter with an updated zone.

Original COM help: https://opendss.epri.com/TotalCustomers1.html

TotalKilometers() → float#

Total kilometers of line from this element to the end of the zone. For recloser siting algorithm.

Requires a previous call to RelCalc command

TotalMiles() → float#

Total miles of line from this element to the end of the zone. For recloser siting algorithm.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/TotalMiles1.html

TotalPowers() → altdss.types.ComplexArray#

Returns an array with the total powers (complex, kVA) at ALL terminals of the active circuit element.

Original COM help: https://opendss.epri.com/TotalPowers.html

Voltages() → altdss.types.ComplexArray#

Complex array of voltages at terminals

Original COM help: https://opendss.epri.com/Voltages1.html

VoltagesMagAng() → altdss.types.Float64Array#

Voltages at each conductor in magnitude, angle form as array of doubles.

Original COM help: https://opendss.epri.com/VoltagesMagAng.html

WindingCurrents() → altdss.types.ComplexArray#

All Winding currents (ph1, wdg1, wdg2,… ph2, wdg1, wdg2 …)

WARNING: If the transformer has open terminal(s), results may be wrong, i.e. avoid using this in those situations. For more information, see dss-extensions/dss-extensions#24

WindingVoltages(winding: int) → altdss.types.ComplexArray#

Complex array of voltages for a target winding

WARNING: If the transformer has open terminal(s), results may be wrong, i.e. avoid using this in those situations. For more information, see dss-extensions/dss-extensions#24

Windings: int#

‘property(…)’

Number of windings, this AutoTrans. (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.

XHT: float#

‘property(…)’

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.

XHX: float#

‘property(…)’

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.

XRConst: bool#

‘property(…)’

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

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

XSCArray: altdss.types.Float64Array#

‘property(…)’

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.

XXT: float#

‘property(…)’

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.

YPrim() → altdss.types.ComplexArray#

YPrim matrix, column order, complex numbers

Original COM help: https://opendss.epri.com/Yprim.html

__hash__()#: Return hash(self).

__init__(api_util, ptr)#

__ne__(other)#: Return self!=value.

__repr__()#: Return repr(self).

begin_edit() → None#

Marks a DSS object for editing

In the editing mode, some final side-effects of changing properties are postponed until end_edit is called. This side-effects can be somewhat costly, like updating the model parameters or internal matrices.

If you don’t have any performance constraint, you may edit each property individually without worrying about using begin_edit and end_edit. For convenience, those are emitted automatically when editing single properties outside an edit block.

edit(**kwargs: typing_extensions.Unpack[altdss.AutoTrans.AutoTransProperties]) → altdss.AutoTrans.AutoTrans#

Edit this AutoTrans.

This method will try to open a new edit context (if not already open), edit the properties, and finalize the edit context. It can be seen as a shortcut to manually setting each property, or a Pythonic analogous (but extended) to the DSS Edit command.

Parameters:: **kwargs – Pass keyword arguments equivalent to the DSS properties of the object.
Returns:: Returns itself to allow call chaining.

end_edit(num_changes: int = 1) → None#

Leaves the editing state of a DSS object

num_changes is required for a few classes to correctly match the official OpenDSS behavior and must be the number of properties modified in the current editing block. As of DSS C-API v0.13, this is only required for the Monitor class, when the Action property is used with the Process value.

kVAs: altdss.types.Float64Array#

‘property(…)’

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

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

kVs: altdss.types.Float64Array#

‘property(…)’

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.

m: float#

‘property(…)’

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

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

n: float#

‘property(…)’

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

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

pctEmergency(allNodes=False) → float#

Maximum current across the conductors as a percentage of the emergency ampere rating.

By default, only the nodes from the first terminal is used for the maximum current, matching the behavior of the “export capacity” command. Pass allNodes=True to force the analysis to all terminals.

pctIMag: float#

‘property(…)’

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.

pctLoadLoss: float#

‘property(…)’

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.

pctNoLoadLoss: float#

‘property(…)’

Percent no load losses at rated excitation 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.

pctNormal(allNodes=False) → float#

Maximum current across the conductors as a percentage of the normal ampere rating.

pctPerm: float#

‘property(…)’

Percent of failures that become permanent.

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

pctR: altdss.types.Float64Array#

‘property(…)’

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.

pctRs: altdss.types.Float64Array#

‘property(…)’

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.

ppm_Antifloat: float#

‘property(…)’

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.

to_json(options: Union[int, dss.enums.DSSJSONFlags] = 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.
SkipDSSClass: do not add the “DSSClass” property to the JSON objects.

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)

class altdss.AutoTrans.AutoTransBatch(api_util, **kwargs)#

Bases: altdss.Batch.DSSBatch, altdss.CircuitElement.CircuitElementBatchMixin, altdss.PDElement.PDElementBatchMixin

AccumulatedL() → altdss.types.Float64Array#

Accumulated failure rate for the branch on downline, for each branch in this batch.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/AccumulatedL.html

Bank: List[str]#

‘property(…)’

Name of the bank this transformer is part of, for CIM, MultiSpeak, and other interfaces.

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

BaseFreq: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Base Frequency for ratings.

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

Buses: List[List[str]]#

‘property(…)’

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.

ComplexSeqCurrents() → altdss.types.ComplexArray#

Complex double array of Sequence Currents for all conductors of all terminals of active circuit element.

Original COM help: https://opendss.epri.com/CplxSeqCurrents.html

ComplexSeqVoltages() → altdss.types.ComplexArray#

Complex double array of Sequence Voltage for all terminals of active circuit element.

Original COM help: https://opendss.epri.com/CplxSeqVoltages1.html

Conns: List[altdss.types.Int32Array]#

‘property(…)’

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.

Conns_str: List[List[str]]#

‘property(…)’

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.

Core: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

{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.

Core_str: List[str]#

‘property(…)’

{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.

Currents() → altdss.types.ComplexArray#

Complex array of currents into each conductor of each terminal

Original COM help: https://opendss.epri.com/Currents1.html

CurrentsMagAng() → altdss.types.Float64Array#

Currents in magnitude, angle (degrees) format as a array of doubles.

Original COM help: https://opendss.epri.com/CurrentsMagAng.html

EmergAmps: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Maximum or emerg current.

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

EmergHkVA: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

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

Enabled: List[bool]#

‘property(…)’

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

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

EnergyMeter() → List[Optional[altdss.DSSObj.DSSObj]]#

Return the energy meter for each of the elements in this batch.

Requires an energy meter with an updated zone.

EnergyMeterName() → List[str]#

Return the energy meter name for each of the elements in this batch.

Requires an energy meter with an updated zone.

FLRise: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

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

FaultRate: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Failure rate per year.

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

FromTerminal() → altdss.types.Int32Array#

Number of the terminal of each PD element of this batch that is on the “from” side.

Requires an energy meter with an updated zone.

FullName() → List[str]#: Returns the full name (including object type) for all objects in this batch

GUID() → List[str]#

GUID/UUID for each object. Currently used only in the CIM-related methods.

Original COM help: https://opendss.epri.com/GUID.html

HSRise: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

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

Handle() → altdss.types.Int32Array#

Index of each element into the circuit’s element list.

Original COM help: https://opendss.epri.com/Handle.html

HasOCPDevice() → altdss.types.BoolArray#

For each element in the batch: returns true if a recloser, relay, or fuse controlling the circuit element.

OCP = Overcurrent Protection

Original COM help: https://opendss.epri.com/HasOCPDevice.html

HasSwitchControl() → altdss.types.BoolArray#

For each element in the batch: returns true if the element has a SwtControl attached.

Original COM help: https://opendss.epri.com/HasSwitchControl.html

HasVoltControl() → altdss.types.BoolArray#

For each element in the batch: returns true if the element has a CapControl or RegControl attached.

Original COM help: https://opendss.epri.com/HasVoltControl.html

IsIsolated() → altdss.types.BoolArray#: For each element in the batch: returns true if the element is isolated. Note that this only fetches the current value. See also the Topology interface.

IsShunt() → List[bool]#

Indicates if each of the PD elements in the batch should be treated as a shunt element rather than a series element.

Applies to Capacitor, Reactor, Fault and GICTransformer elements.

Lambda() → altdss.types.Float64Array#

Failure rate for each of the branches in the batch. Faults per year including length of line.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/Lambda1.html

LeadLag: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

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

LeadLag_str: List[str]#

‘property(…)’

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

Like(value: AnyStr, flags: altdss.enums.SetterFlags = 0)#

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: Like, DSS property index: 49.

Losses() → altdss.types.ComplexArray#

For each element in the batch: total losses in the element, in VA (watts, vars).

Original COM help: https://opendss.epri.com/Losses1.html

MaxCurrent(terminal: int) → altdss.types.Float64Array#: Returns the maximum current (magnitude) at the specified terminal for each element in this batch. Use -1 as terminal to get the value across all terminals.

MaxTap: List[altdss.types.Float64Array]#

‘property(…)’

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

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

MinTap: List[altdss.types.Float64Array]#

‘property(…)’

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

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

property Name: List[str]#

NormAmps: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Normal rated current.

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

NormHkVA: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

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

NumConductors() → altdss.types.Int32Array#

Number of conductors per terminal for each element in the batch.

Original COM help: https://opendss.epri.com/NumConductors.html

NumControllers() → altdss.types.Int32Array#

Number of controllers connected to each device in the batch.

Original COM help: https://opendss.epri.com/NumControls.html

NumCustomers() → altdss.types.Int32Array#

Number of customers for each branch in the batch.

Requires an energy meter with an updated zone.

Original COM help: https://opendss.epri.com/Numcustomers.html

NumPhases() → altdss.types.Int32Array#

Number of Phases for each element in this batch.

Original COM help: https://opendss.epri.com/NumPhases.html

NumTaps: List[altdss.types.Int32Array]#

‘property(…)’

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.

NumTerminals() → altdss.types.Int32Array#

Number of terminals for each Circuit Element in the batch.

Original COM help: https://opendss.epri.com/NumTerminals.html

OCPDevice() → List[Union[altdss.DSSObj.DSSObj, None]]#: Returns (as a list of Python objects) the OCP device controlling each element.

OCPDeviceIndex() → altdss.types.Int32Array#

For each element in the batch: index into each controller list of the OCP Device controlling each circuit element

Original COM help: https://opendss.epri.com/OCPDevIndex.html

OCPDeviceType() → List[dss.enums.OCPDevType]#

For each element in the batch: type of OCP controller device

Original COM help: https://opendss.epri.com/OCPDevType.html

ParentPDElement() → List[Optional[altdss.DSSObj.DSSObj]]#

Returns the parent PD element for each element in this batch.

Requires an energy meter with an updated zone.

PhaseLosses() → altdss.types.ComplexArray#

Complex array of losses (kVA) by phase

Original COM help: https://opendss.epri.com/PhaseLosses.html

Phases: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

Number of phases this AutoTrans. Default is 3.

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

Powers() → altdss.types.ComplexArray#

Complex array of powers (kVA) into each conductor of each terminal, of each element in the batch.

Original COM help: https://opendss.epri.com/Powers.html

RDCOhms: List[altdss.types.Float64Array]#

‘property(…)’

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.

Repair: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Hours to repair.

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

SectionID() → altdss.types.Int32Array#

Integer ID of the feeder section that each PDElement branch in this batch is part of.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/SectionID1.html

SeqCurrents() → altdss.types.Float64Array#

Array of symmetrical component currents (magnitudes only) into each 3-phase terminal of each element

Original COM help: https://opendss.epri.com/SeqCurrents.html

SeqPowers() → altdss.types.ComplexArray#

Complex array of sequence powers (kW, kvar) into each 3-phase terminal of each element

Original COM help: https://opendss.epri.com/SeqPowers.html

SeqVoltages() → altdss.types.Float64Array#

Double array of symmetrical component voltages (magnitudes only) at each 3-phase terminal

Original COM help: https://opendss.epri.com/SeqVoltages1.html

Sub: List[bool]#

‘property(…)’

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

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

SubName: List[str]#

‘property(…)’

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

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

Taps: List[altdss.types.Float64Array]#

‘property(…)’

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

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

Thermal: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

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

TotalCustomers() → altdss.types.Int32Array#

Total number of customers from each branch of this batch to the end of the zone

Requires a circuit with an energy meter with an updated zone.

Original COM help: https://opendss.epri.com/TotalCustomers1.html

TotalKilometers() → altdss.types.Float64Array#

Total kilometers of line from this element to the end of the zone. For recloser siting algorithm.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/TotalMiles1.html

TotalMiles() → altdss.types.Float64Array#

Total miles of line from this element to the end of the zone. For recloser siting algorithm.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/TotalMiles1.html

TotalPowers() → altdss.types.ComplexArray#

Returns an array with the total powers (complex, kVA) at all terminals of the circuit elements in this batch.

The resulting array is equivalent to concatenating the TotalPowers for each element.

Voltages() → altdss.types.ComplexArray#

Complex array of voltages at terminals

Original COM help: https://opendss.epri.com/Voltages1.html

VoltagesMagAng() → altdss.types.Float64Array#

Voltages at each conductor in magnitude, angle form as array of doubles.

Original COM help: https://opendss.epri.com/VoltagesMagAng.html

Windings: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

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

XHT: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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.

XHX: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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.

XRConst: List[bool]#

‘property(…)’

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

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

XSCArray: List[altdss.types.Float64Array]#

‘property(…)’

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.

XXT: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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.

__call__()#

__getitem__(idx0) → altdss.DSSObj.DSSObj#: Get element at 0-based index of the batch pointer array

__init__(api_util, **kwargs)#

__iter__()#

__len__() → int#

batch(**kwargs) → altdss.Batch.DSSBatch#

Filter a batch using integer or float DSS properties, returning a new batch.

For integers, provide a single value to match.

For floats, provide a range as a 2-valued tuple/list (min value, max value), or an exact value to value (not recommended).

Multiple properties can be listed to allow filtering various conditions.

Example for loads:

    # Create an initial batch using a regular expression
    abc_loads = altdss.Load.batch(re=r'^abc.*$') # a batch of all loads with names starting with "abc"
    abc_loads_filtered = abc_loads.batch(Class=1, Phases=1, kV=(0.1, 1.0))

    # Create an initial batch, already filtered
    abc_loads_filtered = altdss.Load.batch(re=r'^abc.*$', Class=1, Phases=1, kV=(0.1, 1.0))

begin_edit() → None#

Marks for editing all DSS objects in the batch

edit(**kwargs: typing_extensions.Unpack[altdss.AutoTrans.AutoTransBatchProperties]) → altdss.AutoTrans.AutoTransBatch#

Edit this AutoTrans batch.

This method will try to open a new edit context (if not already open), edit the properties, and finalize the edit context for objects in the batch. It can be seen as a shortcut to manually setting each property, or a Pythonic analogous (but extended) to the DSS BatchEdit command.

Parameters:: **kwargs – Pass keyword arguments equivalent to the DSS properties of the objects.
Returns:: Returns itself to allow call chaining.

end_edit(num_changes: int = 1) → None#

Leaves the editing states of all DSS objects in the batch

kVAs: List[altdss.types.Float64Array]#

‘property(…)’

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

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

kVs: List[altdss.types.Float64Array]#

‘property(…)’

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.

m: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

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

n: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

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

pctEmergency(allNodes=False) → altdss.types.Float64Array#

For each element in the batch, calculate the maximum current across the conductors as a percentage of the emergency ampere rating.

pctIMag: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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.

pctLoadLoss: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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.

pctNoLoadLoss: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Percent no load losses at rated excitation 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.

pctNormal(allNodes=False) → altdss.types.Float64Array#

For each element in the batch, calculate the maximum current across the conductors as a percentage of the normal ampere rating.

pctPerm: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Percent of failures that become permanent.

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

pctR: List[altdss.types.Float64Array]#

‘property(…)’

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.

pctRs: List[altdss.types.Float64Array]#

‘property(…)’

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.

ppm_Antifloat: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

to_json(options: Union[int, dss.enums.DSSJSONFlags] = 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.

to_list()#

class altdss.AutoTrans.AutoTransBatchProperties#

Bases: typing_extensions.TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Bank: Union[AnyStr, List[AnyStr]]#: None

BaseFreq: Union[float, altdss.types.Float64Array]#: None

Buses: List[AnyStr]#: None

Conns: Union[List[Union[int, altdss.enums.AutoTransConnection]], List[AnyStr]]#: None

Core: Union[AnyStr, int, altdss.enums.CoreType, List[AnyStr], List[int], List[altdss.enums.CoreType], altdss.types.Int32Array]#: None

EmergAmps: Union[float, altdss.types.Float64Array]#: None

EmergHkVA: Union[float, altdss.types.Float64Array]#: None

Enabled: bool#: None

FLRise: Union[float, altdss.types.Float64Array]#: None

FaultRate: Union[float, altdss.types.Float64Array]#: None

HSRise: Union[float, altdss.types.Float64Array]#: None

LeadLag: Union[AnyStr, int, altdss.enums.PhaseSequence, List[AnyStr], List[int], List[altdss.enums.PhaseSequence], altdss.types.Int32Array]#: None

Like: AnyStr#: None

MaxTap: altdss.types.Float64Array#: None

MinTap: altdss.types.Float64Array#: None

NormAmps: Union[float, altdss.types.Float64Array]#: None

NormHkVA: Union[float, altdss.types.Float64Array]#: None

NumTaps: altdss.types.Int32Array#: None

Phases: Union[int, altdss.types.Int32Array]#: None

RDCOhms: altdss.types.Float64Array#: None

Repair: Union[float, altdss.types.Float64Array]#: None

Sub: bool#: None

SubName: Union[AnyStr, List[AnyStr]]#: None

Taps: altdss.types.Float64Array#: None

Thermal: Union[float, altdss.types.Float64Array]#: None

Windings: Union[int, altdss.types.Int32Array]#: None

XHT: Union[float, altdss.types.Float64Array]#: None

XHX: Union[float, altdss.types.Float64Array]#: None

XRConst: bool#: None

XSCArray: altdss.types.Float64Array#: None

XXT: Union[float, altdss.types.Float64Array]#: None

__contains__()#: True if the dictionary has the specified key, else False.

__delattr__()#: Implement delattr(self, name).

__delitem__()#: Delete self[key].

__dir__()#: Default dir() implementation.

__format__()#

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__()#: Return self>=value.

__getattribute__()#: Return getattr(self, name).

__getitem__()#: Return self[key].

__getstate__()#: Helper for pickle.

__gt__()#: Return self>value.

__init__()#: Initialize self. See help(type(self)) for accurate signature.

__ior__()#: Return self|=value.

__iter__()#: Implement iter(self).

__le__()#: Return self<=value.

__len__()#: Return len(self).

__lt__()#: Return self<value.

__ne__()#: Return self!=value.

__new__()#: Create and return a new object. See help(type) for accurate signature.

__or__()#: Return self|value.

__reduce__()#: Helper for pickle.

__reduce_ex__()#: Helper for pickle.

__repr__()#: Return repr(self).

__reversed__()#: Return a reverse iterator over the dict keys.

__ror__()#: Return value|self.

__setitem__()#: Set self[key] to value.

__sizeof__()#: D.sizeof() -> size of D in memory, in bytes

__str__()#: Return str(self).

__subclasshook__()#

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.subclasscheck(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

clear()#: D.clear() -> None. Remove all items from D.

copy()#: D.copy() -> a shallow copy of D

get()#: Return the value for key if key is in the dictionary, else default.

items()#: D.items() -> a set-like object providing a view on D’s items

kVAs: altdss.types.Float64Array#: None

kVs: altdss.types.Float64Array#: None

keys()#: D.keys() -> a set-like object providing a view on D’s keys

m: Union[float, altdss.types.Float64Array]#: None

n: Union[float, altdss.types.Float64Array]#: None

pctIMag: Union[float, altdss.types.Float64Array]#: None

pctLoadLoss: Union[float, altdss.types.Float64Array]#: None

pctNoLoadLoss: Union[float, altdss.types.Float64Array]#: None

pctPerm: Union[float, altdss.types.Float64Array]#: None

pctR: altdss.types.Float64Array#: None

pctRs: altdss.types.Float64Array#: None

pop()#

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

ppm_Antifloat: Union[float, altdss.types.Float64Array]#: None

setdefault()#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update()#: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()#: D.values() -> an object providing a view on D’s values

class altdss.AutoTrans.AutoTransProperties#

Bases: typing_extensions.TypedDict

Bank: AnyStr#: None

BaseFreq: float#: None

Buses: List[AnyStr]#: None

Conns: Union[List[Union[int, altdss.enums.AutoTransConnection]], List[AnyStr]]#: None

Core: Union[AnyStr, int, altdss.enums.CoreType]#: None

EmergAmps: float#: None

EmergHkVA: float#: None

Enabled: bool#: None

FLRise: float#: None

FaultRate: float#: None

HSRise: float#: None

LeadLag: Union[AnyStr, int, altdss.enums.PhaseSequence]#: None

Like: AnyStr#: None

MaxTap: altdss.types.Float64Array#: None

MinTap: altdss.types.Float64Array#: None

NormAmps: float#: None

NormHkVA: float#: None

NumTaps: altdss.types.Int32Array#: None

Phases: int#: None

RDCOhms: altdss.types.Float64Array#: None

Repair: float#: None

Sub: bool#: None

SubName: AnyStr#: None

Taps: altdss.types.Float64Array#: None

Thermal: float#: None

Windings: int#: None

XHT: float#: None

XHX: float#: None

XRConst: bool#: None

XSCArray: altdss.types.Float64Array#: None

XXT: float#: None

__contains__()#: True if the dictionary has the specified key, else False.

__delattr__()#: Implement delattr(self, name).

__delitem__()#: Delete self[key].

__dir__()#: Default dir() implementation.

__format__()#

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__()#: Return self>=value.

__getattribute__()#: Return getattr(self, name).

__getitem__()#: Return self[key].

__getstate__()#: Helper for pickle.

__gt__()#: Return self>value.

__init__()#: Initialize self. See help(type(self)) for accurate signature.

__ior__()#: Return self|=value.

__iter__()#: Implement iter(self).

__le__()#: Return self<=value.

__len__()#: Return len(self).

__lt__()#: Return self<value.

__ne__()#: Return self!=value.

__new__()#: Create and return a new object. See help(type) for accurate signature.

__or__()#: Return self|value.

__reduce__()#: Helper for pickle.

__reduce_ex__()#: Helper for pickle.

__repr__()#: Return repr(self).

__reversed__()#: Return a reverse iterator over the dict keys.

__ror__()#: Return value|self.

__setitem__()#: Set self[key] to value.

__sizeof__()#: D.sizeof() -> size of D in memory, in bytes

__str__()#: Return str(self).

__subclasshook__()#

Abstract classes can override this to customize issubclass().

clear()#: D.clear() -> None. Remove all items from D.

copy()#: D.copy() -> a shallow copy of D

get()#: Return the value for key if key is in the dictionary, else default.

items()#: D.items() -> a set-like object providing a view on D’s items

kVAs: altdss.types.Float64Array#: None

kVs: altdss.types.Float64Array#: None

keys()#: D.keys() -> a set-like object providing a view on D’s keys

m: float#: None

n: float#: None

pctIMag: float#: None

pctLoadLoss: float#: None

pctNoLoadLoss: float#: None

pctPerm: float#: None

pctR: altdss.types.Float64Array#: None

pctRs: altdss.types.Float64Array#: None

pop()#

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

ppm_Antifloat: float#: None

setdefault()#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update()#: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()#: D.values() -> an object providing a view on D’s values

class altdss.AutoTrans.IAutoTrans(iobj)#

Bases: altdss.DSSObj.IDSSObj, altdss.AutoTrans.AutoTransBatch

AccumulatedL() → altdss.types.Float64Array#

Accumulated failure rate for the branch on downline, for each branch in this batch.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/AccumulatedL.html

Bank: List[str]#

‘property(…)’

Name of the bank this transformer is part of, for CIM, MultiSpeak, and other interfaces.

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

BaseFreq: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Base Frequency for ratings.

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

Buses: List[List[str]]#

‘property(…)’

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.

ComplexSeqCurrents() → altdss.types.ComplexArray#

Complex double array of Sequence Currents for all conductors of all terminals of active circuit element.

Original COM help: https://opendss.epri.com/CplxSeqCurrents.html

ComplexSeqVoltages() → altdss.types.ComplexArray#

Complex double array of Sequence Voltage for all terminals of active circuit element.

Original COM help: https://opendss.epri.com/CplxSeqVoltages1.html

Conns: List[altdss.types.Int32Array]#

‘property(…)’

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.

Conns_str: List[List[str]]#

‘property(…)’

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.

Core: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

{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.

Core_str: List[str]#

‘property(…)’

{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.

Currents() → altdss.types.ComplexArray#

Complex array of currents into each conductor of each terminal

Original COM help: https://opendss.epri.com/Currents1.html

CurrentsMagAng() → altdss.types.Float64Array#

Currents in magnitude, angle (degrees) format as a array of doubles.

Original COM help: https://opendss.epri.com/CurrentsMagAng.html

EmergAmps: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Maximum or emerg current.

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

EmergHkVA: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

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

Enabled: List[bool]#

‘property(…)’

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

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

EnergyMeter() → List[Optional[altdss.DSSObj.DSSObj]]#

Return the energy meter for each of the elements in this batch.

Requires an energy meter with an updated zone.

EnergyMeterName() → List[str]#

Return the energy meter name for each of the elements in this batch.

Requires an energy meter with an updated zone.

FLRise: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

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

FaultRate: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Failure rate per year.

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

FromTerminal() → altdss.types.Int32Array#

Number of the terminal of each PD element of this batch that is on the “from” side.

Requires an energy meter with an updated zone.

FullName() → List[str]#: Returns the full name (including object type) for all objects in this batch

GUID() → List[str]#

GUID/UUID for each object. Currently used only in the CIM-related methods.

Original COM help: https://opendss.epri.com/GUID.html

HSRise: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

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

Handle() → altdss.types.Int32Array#

Index of each element into the circuit’s element list.

Original COM help: https://opendss.epri.com/Handle.html

HasOCPDevice() → altdss.types.BoolArray#

For each element in the batch: returns true if a recloser, relay, or fuse controlling the circuit element.

OCP = Overcurrent Protection

Original COM help: https://opendss.epri.com/HasOCPDevice.html

HasSwitchControl() → altdss.types.BoolArray#

For each element in the batch: returns true if the element has a SwtControl attached.

Original COM help: https://opendss.epri.com/HasSwitchControl.html

HasVoltControl() → altdss.types.BoolArray#

For each element in the batch: returns true if the element has a CapControl or RegControl attached.

Original COM help: https://opendss.epri.com/HasVoltControl.html

IsIsolated() → altdss.types.BoolArray#: For each element in the batch: returns true if the element is isolated. Note that this only fetches the current value. See also the Topology interface.

IsShunt() → List[bool]#

Indicates if each of the PD elements in the batch should be treated as a shunt element rather than a series element.

Applies to Capacitor, Reactor, Fault and GICTransformer elements.

Lambda() → altdss.types.Float64Array#

Failure rate for each of the branches in the batch. Faults per year including length of line.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/Lambda1.html

LeadLag: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

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

LeadLag_str: List[str]#

‘property(…)’

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

Like(value: AnyStr, flags: altdss.enums.SetterFlags = 0)#

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: Like, DSS property index: 49.

Losses() → altdss.types.ComplexArray#

For each element in the batch: total losses in the element, in VA (watts, vars).

Original COM help: https://opendss.epri.com/Losses1.html

MaxCurrent(terminal: int) → altdss.types.Float64Array#: Returns the maximum current (magnitude) at the specified terminal for each element in this batch. Use -1 as terminal to get the value across all terminals.

MaxTap: List[altdss.types.Float64Array]#

‘property(…)’

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

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

MinTap: List[altdss.types.Float64Array]#

‘property(…)’

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

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

property Name: List[str]#

NormAmps: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Normal rated current.

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

NormHkVA: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

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

NumConductors() → altdss.types.Int32Array#

Number of conductors per terminal for each element in the batch.

Original COM help: https://opendss.epri.com/NumConductors.html

NumControllers() → altdss.types.Int32Array#

Number of controllers connected to each device in the batch.

Original COM help: https://opendss.epri.com/NumControls.html

NumCustomers() → altdss.types.Int32Array#

Number of customers for each branch in the batch.

Requires an energy meter with an updated zone.

Original COM help: https://opendss.epri.com/Numcustomers.html

NumPhases() → altdss.types.Int32Array#

Number of Phases for each element in this batch.

Original COM help: https://opendss.epri.com/NumPhases.html

NumTaps: List[altdss.types.Int32Array]#

‘property(…)’

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.

NumTerminals() → altdss.types.Int32Array#

Number of terminals for each Circuit Element in the batch.

Original COM help: https://opendss.epri.com/NumTerminals.html

OCPDevice() → List[Union[altdss.DSSObj.DSSObj, None]]#: Returns (as a list of Python objects) the OCP device controlling each element.

OCPDeviceIndex() → altdss.types.Int32Array#

For each element in the batch: index into each controller list of the OCP Device controlling each circuit element

Original COM help: https://opendss.epri.com/OCPDevIndex.html

OCPDeviceType() → List[dss.enums.OCPDevType]#

For each element in the batch: type of OCP controller device

Original COM help: https://opendss.epri.com/OCPDevType.html

ParentPDElement() → List[Optional[altdss.DSSObj.DSSObj]]#

Returns the parent PD element for each element in this batch.

Requires an energy meter with an updated zone.

PhaseLosses() → altdss.types.ComplexArray#

Complex array of losses (kVA) by phase

Original COM help: https://opendss.epri.com/PhaseLosses.html

Phases: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

Number of phases this AutoTrans. Default is 3.

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

Powers() → altdss.types.ComplexArray#

Complex array of powers (kVA) into each conductor of each terminal, of each element in the batch.

Original COM help: https://opendss.epri.com/Powers.html

RDCOhms: List[altdss.types.Float64Array]#

‘property(…)’

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.

Repair: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Hours to repair.

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

SectionID() → altdss.types.Int32Array#

Integer ID of the feeder section that each PDElement branch in this batch is part of.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/SectionID1.html

SeqCurrents() → altdss.types.Float64Array#

Array of symmetrical component currents (magnitudes only) into each 3-phase terminal of each element

Original COM help: https://opendss.epri.com/SeqCurrents.html

SeqPowers() → altdss.types.ComplexArray#

Complex array of sequence powers (kW, kvar) into each 3-phase terminal of each element

Original COM help: https://opendss.epri.com/SeqPowers.html

SeqVoltages() → altdss.types.Float64Array#

Double array of symmetrical component voltages (magnitudes only) at each 3-phase terminal

Original COM help: https://opendss.epri.com/SeqVoltages1.html

Sub: List[bool]#

‘property(…)’

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

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

SubName: List[str]#

‘property(…)’

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

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

Taps: List[altdss.types.Float64Array]#

‘property(…)’

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

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

Thermal: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

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

TotalCustomers() → altdss.types.Int32Array#

Total number of customers from each branch of this batch to the end of the zone

Requires a circuit with an energy meter with an updated zone.

Original COM help: https://opendss.epri.com/TotalCustomers1.html

TotalKilometers() → altdss.types.Float64Array#

Total kilometers of line from this element to the end of the zone. For recloser siting algorithm.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/TotalMiles1.html

TotalMiles() → altdss.types.Float64Array#

Total miles of line from this element to the end of the zone. For recloser siting algorithm.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/TotalMiles1.html

TotalPowers() → altdss.types.ComplexArray#

Returns an array with the total powers (complex, kVA) at all terminals of the circuit elements in this batch.

The resulting array is equivalent to concatenating the TotalPowers for each element.

Voltages() → altdss.types.ComplexArray#

Complex array of voltages at terminals

Original COM help: https://opendss.epri.com/Voltages1.html

VoltagesMagAng() → altdss.types.Float64Array#

Voltages at each conductor in magnitude, angle form as array of doubles.

Original COM help: https://opendss.epri.com/VoltagesMagAng.html

Windings: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

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

XHT: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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.

XHX: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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.

XRConst: List[bool]#

‘property(…)’

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

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

XSCArray: List[altdss.types.Float64Array]#

‘property(…)’

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.

XXT: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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.

__call__()#

__contains__(name: str) → bool#

__getitem__(name_or_idx)#

__init__(iobj)#

__iter__()#

__len__() → int#

batch(**kwargs)#: Creates a new batch handler of (existing) objects

batch_new(names: Optional[List[AnyStr]] = None, *, df=None, count: Optional[int] = None, begin_edit: Optional[bool] = None, **kwargs: typing_extensions.Unpack[altdss.AutoTrans.AutoTransBatchProperties]) → altdss.AutoTrans.AutoTransBatch#

Creates a new batch of AutoTrans objects

Either names, count or df is required.

Parameters:

begin_edit – The argument begin_edit indicates if the user want to leave the elements in the edit state, and requires a call to end_edit() or equivalent. The default begin_edit is set to None. With None, the behavior will be adjusted according the default of how the batch is created.
**kwargs – Pass keyword arguments equivalent to the DSS properties of the object.
names – When using a list of names, each new object will match the names from this list. begin_edit defaults to True if no arguments for properties were passed, False otherwise.
count – When using count, new objects will be created with based on a random prefix, with an increasing integer up to count. begin_edit defaults to True if no arguments for properties were passed, False otherwise.
df – Currently EXPERIMENTAL AND LIMITED, tries to get the columns from a dataframe to populate the names and the DSS properties. begin_edit defaults to False.

Returns:

Returns the new batch of DSS objects, wrapped in Python.

Note that, to make it easier for new users where the edit context might not be too relevant, AltDSS automatically opens/closes edit contexts for single properties if the object is not in the edit state already.

begin_edit() → None#

Marks for editing all DSS objects in the batch

edit(**kwargs: typing_extensions.Unpack[altdss.AutoTrans.AutoTransBatchProperties]) → altdss.AutoTrans.AutoTransBatch#

Edit this AutoTrans batch.

Parameters:: **kwargs – Pass keyword arguments equivalent to the DSS properties of the objects.
Returns:: Returns itself to allow call chaining.

end_edit(num_changes: int = 1) → None#

Leaves the editing states of all DSS objects in the batch

find(name_or_idx: Union[AnyStr, int]) → altdss.DSSObj.DSSObj#: Returns an object from the collection by name or index; the index must be zero-based.

kVAs: List[altdss.types.Float64Array]#

‘property(…)’

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

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

kVs: List[altdss.types.Float64Array]#

‘property(…)’

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.

m: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

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

n: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

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

new(name: AnyStr, *, begin_edit: Optional[bool] = None, activate=False, **kwargs: typing_extensions.Unpack[altdss.AutoTrans.AutoTransProperties]) → altdss.AutoTrans.AutoTrans#

Creates a new AutoTrans.

Parameters:

name – The object’s name is a required positional argument.
activate – Activation (setting activate to true) is useful for integration with the classic API, and some internal OpenDSS commands. If you interact with this object only via the Alt API, no need to activate it (due to performance costs).
begin_edit – This controls how the edit context is left after the object creation:

True: The object will be left in the edit state, requiring an end_edit call or equivalent.
False: No edit context is started.
None: If no properties are passed as keyword arguments, the object will be left in the edit state (assumes the user will fill the properties from Python attributes). Otherwise, the internal edit context will be finalized.

Parameters:: **kwargs – Pass keyword arguments equivalent to the DSS properties of the object.
Returns:: Returns the new DSS object, wrapped in Python.

pctEmergency(allNodes=False) → altdss.types.Float64Array#

For each element in the batch, calculate the maximum current across the conductors as a percentage of the emergency ampere rating.

pctIMag: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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.

pctLoadLoss: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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.

pctNoLoadLoss: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Percent no load losses at rated excitation 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.

pctNormal(allNodes=False) → altdss.types.Float64Array#

For each element in the batch, calculate the maximum current across the conductors as a percentage of the normal ampere rating.

pctPerm: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Percent of failures that become permanent.

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

pctR: List[altdss.types.Float64Array]#

‘property(…)’

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.

pctRs: List[altdss.types.Float64Array]#

‘property(…)’

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.

ppm_Antifloat: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

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

to_json(options: Union[int, dss.enums.DSSJSONFlags] = 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.

to_list()#

altdss.AutoTrans

Contents

altdss.AutoTrans#

Module Contents#

Classes#

API#

`altdss.AutoTrans`#