dss.IBus#

Module Contents#

Classes#

IBus

API#

class dss.IBus.IBus(api_util, prefer_lists=False)#

Bases: dss._cffi_api_util.Base

property AllPCEatBus: List[str]#

Returns an array with the names of all PCE connected to the active bus

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

property AllPDEatBus: List[str]#

Returns an array with the names of all PDE connected to the active bus

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

property Coorddefined: bool#

Indicates whether a coordinate has been defined for this bus

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

property CplxSeqVoltages: dss._types.Float64ArrayOrComplexArray#

Complex array of Sequence Voltages (0, 1, 2) at this Bus.

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

property Cust_Duration: float#

Accumulated customer outage durations

Requires a previous call to RelCalc command

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

property Cust_Interrupts: float#

Annual number of customer-interruptions from this bus

Requires a previous call to RelCalc command

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

property Distance: float#

Distance from EnergyMeter (if non-zero)

Requires an energy meter with an updated zone.

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

GetUniqueNodeNumber(StartNumber: int) int#

Return a unique node number at the active bus to avoid node collisions and adds it to the node list for the bus.

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

property Int_Duration: float#

Average interruption duration, hours.

Requires a previous call to RelCalc command

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

property Isc: dss._types.Float64ArrayOrComplexArray#

Short circuit currents at bus; Complex Array.

Requires a previous solution in FaultStudy mode.

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

property Lambda: float#

Accumulated failure rate downstream from this bus; faults per year

Requires a previous call to RelCalc command

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

property LineList: List[str]#

List of strings: Full Names of LINE elements connected to the active bus.

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

property LoadList: List[str]#

List of strings: Full Names of LOAD elements connected to the active bus.

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

property N_Customers: int#

Total numbers of customers served downline from this bus

Requires a previous call to RelCalc command

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

property N_interrupts: float#

Number of interruptions this bus per year

Requires a previous call to RelCalc command

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

property Name: str#

Name of Bus

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

property Nodes: dss._types.Int32Array#

Integer Array of Node Numbers defined at the bus in same order as the voltages.

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

property NumNodes: int#

Number of Nodes this bus.

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

property SectionID: int#

Integer ID of the feeder section in which this bus is located.

Requires a previous call to RelCalc command

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

property SeqVoltages: dss._types.Float64Array#

Double Array of sequence voltages at this bus. Magnitudes only.

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

property TotalMiles: float#

Total length of line downline from this bus, in miles. For recloser siting algorithm.

Requires a previous call to RelCalc command

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

property VLL: dss._types.Float64ArrayOrComplexArray#

For 2- and 3-phase buses, returns array of complex numbers representing L-L voltages in volts. Returns -1.0 for 1-phase bus. If more than 3 phases, returns only first 3.

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

property VMagAngle: dss._types.Float64Array#

Array of doubles containing voltages in Magnitude (VLN), angle (degrees)

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

property Voc: dss._types.Float64ArrayOrComplexArray#

Open circuit voltage; Complex array.

Requires a previous solution in FaultStudy mode.

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

property Voltages: dss._types.Float64ArrayOrComplexArray#

Complex array of voltages at this bus.

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

property YscMatrix: dss._types.Float64ArrayOrComplexArray#

Complex array of Ysc matrix at bus. Column by column.

Requires a previous solution in FaultStudy mode or a call to ZSCRefresh.

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

property ZSC012Matrix: dss._types.Float64ArrayOrComplexArray#

Array of doubles (complex) containing the complete 012 Zsc matrix. Only available after Zsc is computed, either through the “ZscRefresh” command, or running a “FaultStudy” solution. Only available for buses with 3 nodes.

Requires a previous solution in FaultStudy mode or a call to ZSCRefresh.

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

property Zsc0: dss._types.Float64ArrayOrSimpleComplex#

Complex Zero-Sequence short circuit impedance at bus.

Requires a previous solution in FaultStudy mode or a call to ZSCRefresh.

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

property Zsc1: dss._types.Float64ArrayOrSimpleComplex#

Complex Positive-Sequence short circuit impedance at bus.

Requires a previous solution in FaultStudy mode or a call to ZSCRefresh.

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

property ZscMatrix: dss._types.Float64ArrayOrComplexArray#

Complex array of Zsc matrix at bus. Column by column.

Requires a previous solution in FaultStudy mode or a call to ZSCRefresh.

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

ZscRefresh() bool#

Refreshes the Zsc matrix for the active bus.

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

__call__(index: Union[int, str]) dss.IBus.IBus#
__getitem__(index: Union[int, str]) dss.IBus.IBus#
__init__(api_util, prefer_lists=False)#
__iter__() Iterator[dss.IBus.IBus]#
__len__() int#

Total number of Buses in the circuit.

property kVBase: float#

Base voltage at bus in kV

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

property puVLL: dss._types.Float64ArrayOrComplexArray#

Returns Complex array of pu L-L voltages for 2- and 3-phase buses. Returns -1.0 for 1-phase bus. If more than 3 phases, returns only 3 phases.

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

property puVmagAngle: dss._types.Float64Array#

Array of doubles containing voltage magnitude, angle (degrees) pairs in per unit

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

property puVoltages: dss._types.Float64ArrayOrComplexArray#

Complex Array of pu voltages at the bus.

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

property x: float#

X Coordinate for bus

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

property y: float#

Y coordinate for bus

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