altdss.Bus

Module Contents

Classes

Bus
BusBatch
IBuses	This is the general bus container, encapsulating operations on all buses. Use it to find, iterate and operate on individual buses, or extract data from all buses.

API

class altdss.Bus.Bus(api_util, ptr)

property ComplexSeqVoltages: altdss.types.ComplexArray

Complex sequence voltages (0, 1, 2) at this bus.

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

property CoordDefined: bool

Indicates whether a coordinate has been defined for this bus

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

property CustDuration: float

Accumulated customer outage durations.

Requires a previous call to RelCalc command

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

property CustInterrupts: 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 this 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 ISC: altdss.types.ComplexArray

Short circuit currents (\(I_{SC}\)) at this bus.

Requires a previous solution in FaultStudy mode.

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

property IntDuration: float

Average interruption duration in hours.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/Int_Duration.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

Lines() → altdss.Line.LineBatch

Batch of line objects connected to this bus.

Loads() → altdss.Load.LoadBatch

Batch of load objects connected to this bus.

property Name: str

Name of this bus

property Nodes: altdss.types.Int32Array

Node numbers defined at the bus in same order as the voltages.

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

property NumCustomers: 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 NumInterrupts: float

Number of interruptions on this bus per year

Requires a previous call to RelCalc command

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

property NumNodes: int

Number of nodes this bus.

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

PCElements() → altdss.PCElement.PCElementBatch

Batch of all PC elements connected to this bus.

PDElements() → altdss.PDElement.PDElementBatch

Batch of all PD elements connected to this bus.

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: altdss.types.Float64Array

Sequence voltages at this bus. Magnitudes only.

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

property TotalKilometers: float

Total length of line downline from this bus, in kilometers.

Requires a previous call to RelCalc command

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: altdss.types.ComplexArray

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: altdss.types.Float64Array

Voltages in magnitude (VLN) and angle (degrees) pairs.

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

property VOC: altdss.types.ComplexArray

Open circuit voltages.

Requires a previous solution in FaultStudy mode.

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

property Voltages: altdss.types.ComplexArray

Complex voltages at this bus.

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

property X: float

X coordinate for the bus

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

property Y: float

Y coordinate for the bus

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

property YSC: altdss.types.ComplexArray

YSC (\(Y_{SC}\)) matrix at bus.

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

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

property ZSC: altdss.types.ComplexArray

ZSC (\(Z_{SC}\)) matrix at the bus.

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

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

property ZSC0: 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 ZSC012: altdss.types.ComplexArray

Complete 012 ZSC (\(Z_{SC}\)) matrix. Only available for buses with 3 nodes. Only available after Zsc is computed.

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

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

property ZSC1: 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

ZSCRefresh() → bool

Refreshes the Zsc matrix for this bus.

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

__init__(api_util, ptr)

__repr__()

Return repr(self).

property kVBase: float

Base voltage at bus in kV

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

property puVLL: altdss.types.ComplexArray

Complex 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: altdss.types.Float64Array

Voltage magnitudes and angles (degrees), paired, in per unit

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

property puVoltages: altdss.types.ComplexArray

Complex pu voltages at the bus.

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

to_json(options: Union[int, dss.enums.DSSJSONFlags] = 0)

Returns the data of this bus as a JSON-encoded string.

Currently, only the basic data is included (name, coordinates, base voltage).

class altdss.Bus.BusBatch(api_util, prefer_lists=False)

Bases: altdss.common.Base

CustDuration() → altdss.types.Float64Array

For each bus in the batch: accumulated customer outage durations for the bus.

CustInterrupts() → altdss.types.Float64Array

For each bus in the batch: annual number of customer-interruptions from the bus.

Distance() → altdss.types.Float64Array

For each bus in the batch: distance from energymeter (if non-zero)

IntDuration() → altdss.types.Float64Array

For each bus in the batch: average interruption duration, hours.

Lambda() → altdss.types.Float64Array

For each bus in the batch: accumulated failure rate downstream from the bus; faults per year

Name() → List[str]

Array of strings containing names of all buses in circuit.

NumCustomers() → altdss.types.Int32Array

For each bus in the batch: total numbers of customers served downline from the bus

NumInterrupts() → altdss.types.Float64Array

For each bus in the batch: number of interruptions on the bus per year

NumNodes() → altdss.types.Int32Array

For each bus in the batch: number of nodes in the bus.

SectionID() → altdss.types.Int32Array

For each bus in the batch: integer ID of the feeder section in which the bus is located.

TotalKilometers() → altdss.types.Float64Array

For each bus in the batch: total length of line downline from the bus, in kilometers.

TotalMiles() → altdss.types.Float64Array

For each bus in the batch: total length of line downline from the bus, in miles. For recloser siting algorithm.

X() → altdss.types.Float64Array

For each bus in the batch: get X coordinate

Y() → altdss.types.Float64Array

For each bus in the batch: get Y coordinate

ZSCRefresh() → bool

Refreshes the Zsc matrix for all buses in the batch

__call__(index: Union[int, str]) → altdss.Bus.Bus

__getitem__(index: int) → altdss.Bus.Bus

__init__(api_util, prefer_lists=False)

__iter__() → Iterator[altdss.Bus.Bus]

__len__() → int

Total number of buses in this batch.

kVBase() → altdss.types.Float64Array

For each bus in the batch: base voltage in kV

to_json(options: Union[int, dss.enums.DSSJSONFlags] = 0)

Returns the data of the buses in this batch as a JSON-encoded string.

Currently, only the basic data is included (name, coordinates, base voltage).

class altdss.Bus.IBuses(api_util, prefer_lists=False)

Bases: altdss.Bus.BusBatch

This is the general bus container, encapsulating operations on all buses. Use it to find, iterate and operate on individual buses, or extract data from all buses.

CustDuration() → altdss.types.Float64Array

For each bus in the batch: accumulated customer outage durations for the bus.

CustInterrupts() → altdss.types.Float64Array

For each bus in the batch: annual number of customer-interruptions from the bus.

Distance() → altdss.types.Float64Array

For each bus in the batch: distance from energymeter (if non-zero)

IntDuration() → altdss.types.Float64Array

For each bus in the batch: average interruption duration, hours.

Lambda() → altdss.types.Float64Array

For each bus in the batch: accumulated failure rate downstream from the bus; faults per year

Name() → List[str]

Array of strings containing names of all buses in circuit.

NumCustomers() → altdss.types.Int32Array

For each bus in the batch: total numbers of customers served downline from the bus

NumInterrupts() → altdss.types.Float64Array

For each bus in the batch: number of interruptions on the bus per year

NumNodes() → altdss.types.Int32Array

For each bus in the batch: number of nodes in the bus.

SectionID() → altdss.types.Int32Array

For each bus in the batch: integer ID of the feeder section in which the bus is located.

TotalKilometers() → altdss.types.Float64Array

For each bus in the batch: total length of line downline from the bus, in kilometers.

TotalMiles() → altdss.types.Float64Array

For each bus in the batch: total length of line downline from the bus, in miles. For recloser siting algorithm.

X() → altdss.types.Float64Array

For each bus in the batch: get X coordinate

Y() → altdss.types.Float64Array

For each bus in the batch: get Y coordinate

ZSCRefresh() → bool

Refreshes the Zsc matrix for all buses in the batch

__call__(index: Union[int, str]) → altdss.Bus.Bus

__getitem__(index: Union[int, str]) → altdss.Bus.Bus

__init__(api_util, prefer_lists=False)

__iter__() → Iterator[altdss.Bus.Bus]

__len__() → int

Total number of buses in the circuit.

find(index_or_name: Union[int, str]) → altdss.Bus.Bus

Returns a bus object for the selected index or name.

Also available as Buses[index].

kVBase() → altdss.types.Float64Array

For each bus in the batch: base voltage in kV

to_json(options: Union[int, dss.enums.DSSJSONFlags] = 0)

Returns the data of the buses in this batch as a JSON-encoded string.

Currently, only the basic data is included (name, coordinates, base voltage).