roseau.load_flow#

Welcome to the API reference of Roseau Load Flow.

For the most part, public classes and functions can be imported directly from this module.

See Package Contents below for a list of available classes and functions.

Subpackages#

Submodules#

Package Contents#

Classes#

RoseauLoadFlowExceptionCode

Error codes used by Roseau Load Flow.

License

A class to access the main data of the License.

AbstractBranch

Base class of all the branches (lines, switches and transformers) of the network.

AbstractLoad

An abstract class of an electric load.

Bus

A multi-phase electrical bus.

Control

Control class for flexible loads.

CurrentLoad

A constant current load.

Element

An abstract class of an element in an Electrical network.

FlexibleParameter

Flexible parameters of a flexible load.

Ground

This element defines the ground.

ImpedanceLoad

A constant impedance load.

Line

An electrical line PI model with series impedance and optional shunt admittance.

LineParameters

Parameters that define electrical models of lines.

PotentialRef

A potential reference.

PowerLoad

A constant power load.

Projection

This class defines the projection on the feasible circle for a flexible load.

Switch

A general purpose switch branch.

Transformer

A generic transformer model.

TransformerParameters

Parameters that define electrical models of transformers.

VoltageSource

A voltage source.

ElectricalNetwork

Electrical network class.

ConductorType

The type of the material of the conductor.

InsulatorType

The type of the insulator for a wire.

LineType

The type of a line.

Functions#

activate_license(→ None)

Activate a license in the current process.

deactivate_license(→ None)

Deactivate the currently active license.

get_license(→ License | None)

Get the currently active license or None if no license is activated.

show_versions(→ None)

Print system and python environment information.

Attributes#

__authors__

__copyright__

__credits__

__email__

__license__

__maintainer__

__status__

__url__

Q_

ureg

__version