Welcome to the Roseau Load Flow documentation

Roseau Load Flow is a load flow solver capable of modeling 3-phase unbalanced power systems with a wide variety of models for lines, transformers, loads, and sources. This software is developed by Roseau Technologies.

With this library, there is a sample of 20 low-voltage and 20 medium-voltage feeders included for an easy start! Each network is given with its summer and winter load point. At Roseau Technologies, we are able to provide the major part of the French medium and low voltage networks. For more information, please contact us at contact@roseautechnologies.com.

More details are given in the Catalogues page.

Installation

roseau-load-flow is the python interface to the solver. It is compatible with Python version 3.10 and newer and can be installed with:

Installation and License

• Installation
  • Using pip
  • Using pip in Jupyter Notebooks

License

Read more about the license of this project:

• Get and activate your license
  • Types of licenses
  • How to activate the license in your project?
  • How to set an environment variable?

Usage

The following tutorials are available to help you get started:

Usage

• Getting started with Roseau Load Flow
  • Creating a network
  • Solving a load flow
  • Getting the results
  • Analyzing the results and detecting violations
  • Updating elements of the network
  • Saving/loading the network
• Creating and editing a network
  • Creating a network
  • Disconnecting an element
  • Connecting an element
  • Modifying an element
• Connecting flexible loads
  • Creating a network
  • \(P(U)\) control
  • \(PQ(U)\) control
• Short-circuit calculations
  • Phase-to-phase
  • Multi-phase
  • Phase-to-ground
  • Additional notes
• Catalogues
  • Networks
  • Transformers
  • Lines
• Plotting
  • Plotting a network on a map
  • Plotting a network with no geometries
  • Plotting voltage phasors
• Extra features
  • Graph theory
  • Conversion to symmetrical components
  • Potentials to voltages conversion
  • Constants
  • Voltage unbalance
  • Bibliography
• Data Exchange
  • Power Factory
  • OpenDSS
  • Roseau Load Flow (JSON)

Models

A description of the electrical models used for each component, an example usage, and a reference to the API of the classes are available here:

Models

• Potential Reference
  • Definition
  • Usage
  • API Reference
• Ground
  • Definition
  • Usage
  • API Reference
• Bus
  • Definition
  • Usage
  • Short-circuit
  • API Reference
• Voltage source
  • Definition
  • Connections
  • Usage
  • API Reference
• Loads
  • Definition
  • Connections
  • Available models
  • API Reference
• Lines
  • Definition
  • Matrices definition
  • Line parameters
  • Available models
  • API Reference
• Switch
  • Definition
  • Equations
  • Example
  • API Reference
• Transformers
  • Definition
  • Transformer parameters
  • Usage
  • Available models
  • API Reference

Advanced

Advanced concepts, edge cases and more are explained in this section:

Advanced

• Solvers
  • General information
  • Newton-Raphson
  • Goldstein and Price
• Floating Neutral
  • What is floating neutral
  • Modelling floating neutral in Roseau Load Flow
• Potential Reference
  • Introduction
  • Potential reference in Roseau Load Flow
  • Galvanic isolation and potential references

Changelog

More

• Changelog
  • Version 0.10.0
  • Version 0.9.1
  • Version 0.9.0
  • Version 0.8.1
  • Version 0.8.0
  • Version 0.7.0
  • Version 0.6.0
  • Version 0.5.0
  • Version 0.4.0
  • Version 0.3.0

API Reference

If you want the full documentation of all the classes and functions, you can refer to the following references:

• roseau.load_flow
  • Subpackages
  • Submodules
  • Attributes
  • Exceptions
  • Classes
  • Functions
  • Package Contents