Distribution System Builder

class shift.DistributionSystemBuilder(name: str, dist_graph: DistributionGraph, phase_mapper: BasePhaseMapper, voltage_mapper: BaseVoltageMapper, equipment_mapper: BaseEquipmentMapper, auto_build: bool = True)

Class interface for building distribution system.

Parameters:

• name (str) – Name of the system.

• dist_graph (DistributionGraph) – Instance of the DistributionGraph.

• phase_mapper (BasePhaseMapper) – Instance of class of type BasePhaseMapper.

• voltage_mapper (BaseVoltageMapper) – Instance of class of type BaseVoltageMapper.

• equipment_mapper (BaseEquipmentMapper) – Instance of class of type BaseEquipmentMapper.

build() → DistributionSystem

Build the distribution system from the graph and mappers.

Returns:

The constructed distribution system.

Return type:

DistributionSystem

get_system() → DistributionSystem

Method to return distribution system.

If the system hasn’t been built yet, this will build it first.

Returns:

The constructed distribution system.

Return type:

DistributionSystem