Metadata-Version: 2.4
Name: roseau-load-flow
Version: 0.16.0a0
Summary: Highly capable multi-phase load flow solver
Author: Roseau Technologies
Author-email: Roseau Technologies <contact@roseautechnologies.com>
License-Expression: BSD-3-Clause
License-File: LICENSE.md
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Free Threading :: 2 - Beta
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Dist: certifi>=2023.5.7
Requires-Dist: geopandas>=1.0.0
Requires-Dist: numpy>=2.0.0
Requires-Dist: pandas>=2.1.0
Requires-Dist: pint>=0.21.0
Requires-Dist: platformdirs>=4.0.0
Requires-Dist: pyproj>=3.3.0
Requires-Dist: roseau-load-flow-engine==0.19.2a0
Requires-Dist: shapely>=2.0.0
Requires-Dist: typing-extensions>=4.6.2
Requires-Dist: orjson>=3.6.0 ; extra == 'fast-json'
Requires-Dist: networkx>=3.3.0 ; extra == 'graph'
Requires-Dist: matplotlib>=3.9.0 ; extra == 'plot'
Maintainer: Roseau Technologies
Maintainer-email: Roseau Technologies <contact@roseautechnologies.com>
Requires-Python: >=3.12
Project-URL: documentation, https://roseau-load-flow.roseautechnologies.com/
Project-URL: homepage, https://www.roseautechnologies.com/roseau-load-flow/
Project-URL: issues, https://github.com/RoseauTechnologies/Roseau_Load_Flow/issues/
Project-URL: repository, https://github.com/RoseauTechnologies/Roseau_Load_Flow/
Provides-Extra: fast-json
Provides-Extra: graph
Provides-Extra: plot
Description-Content-Type: text/markdown

# Roseau Load Flow

![CI](https://github.com/RoseauTechnologies/Roseau_Load_Flow/workflows/CI/badge.svg)
![pre-commit](https://github.com/RoseauTechnologies/Roseau_Load_Flow/actions/workflows/pre-commit.yml/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/roseau-load-flow/badge/?version=latest)](https://roseau-load-flow.readthedocs.io/en/latest/?badge=latest)
[![CodSpeed](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://app.codspeed.io/RoseauTechnologies/Roseau_Load_Flow?utm_source=badge)

<!-- start rlf-pitch -->

_Roseau Load Flow_ is a powerful load flow solver and static analysis tool that offers:

- **Multi-phase**, **unbalanced** power flow analysis
- A performance optimized solver written in C++
- A catalogue of real-world transformer and line models
- An ergonomic object-oriented Python interface with unit-aware quantities
- A comprehensive documentation with code examples
- Advanced built-in plotting tools for network visualization on interactive maps and voltage profile plots
- Real-world distribution network data samples in the library (with more available
  [here](https://github.com/RoseauTechnologies/Representative_French_Power_Grids))

In addition to the following **unique** set of features:

- _Floating neutrals_ for loads, sources, and transformers
- Actual four-wire multi-phase modelling with no Kron's reduction and no transformations
- Ideal or impedant ground connections at any point in the network
- _Flexible loads_ with Volt-Watt and Volt-VAr control directly in the Newton loop, which is more stable and results in
  a faster convergence than with the traditional outer loop approach
- Out-of-the-box support for Single-Wire Earth Return (SWER), American bi-phase systems with center-tapped transformers,
  zero-sequence modelling, and other non-standard configurations

<!-- end rlf-pitch -->

This project is compatible with Python version 3.12 and newer. The
[installation instructions](https://roseau-load-flow.roseautechnologies.com/en/latest/Installation.html) will guide you
through the installation process. If you are new to _Roseau Load Flow_, we recommend you start with the
[getting started tutorial](https://roseau-load-flow.roseautechnologies.com/en/latest/usage/Getting_Started.html). You
can find the complete documentation at https://roseau-load-flow.roseautechnologies.com/.

## License

This project is _partially_ open source but using the solver requires a license. The license key
`A8C6DA-9405FB-E74FB9-C71C3C-207661-V3` can be used free of charge with networks containing up to 50 buses. To obtain a
personal or commercial license, please contact us at
[contact@roseautechnologies.com](mailto:contact@roseautechnologies.com).

> [!NOTE]
> Licenses are given free of charge for **students and teachers**. Please contact us at contact@roseautechnologies.com
> for more information.

Read more at [License](https://roseau-load-flow.roseautechnologies.com/en/latest/License.html).

## Network data

<!-- start rlf-networks -->

_Roseau Load Flow_ ships with a sample of 20 low-voltage and 20 medium-voltage feeder networks. Each network is provided
with its summer and winter load points.

<!-- start representative-networks -->

We also maintain a set of 150 MV feeders representative of the French distribution system at
https://github.com/RoseauTechnologies/Representative_French_Power_Grids. Each feeder is modeled with its downstream LV
networks. The repository also contains the cluster size that indicates how representative is each network of the French
distribution system. These networks are the result of the study
[Representative MV feeders for the analysis of French distribution networks](https://www.roseautechnologies.com/en/electrical-model-of-the-french-distribution-network/),
made and published by [Mines Paris Tech](https://www.minesparis.psl.eu/).

<!-- end representative-networks -->

<!-- end rlf-networks -->

<div align="center">
  <img alt="Catalogue of networks" src="https://github.com/RoseauTechnologies/Roseau_Load_Flow/blob/main/doc/_static/Network/Catalogue.webp?raw=True" />
</div>

## Bug reports / Feature requests

For bug reports, feature requests, or questions, please open an issue on
[GitHub](https://github.com/RoseauTechnologies/Roseau_Load_Flow/issues)

## Credits

This software is developed by [Roseau Technologies](https://www.roseautechnologies.com/en).

Follow us on:
[![Linkedin](https://i.sstatic.net/gVE0j.png) LinkedIn](https://www.linkedin.com/company/roseau-technologies/)
[![GitHub](https://i.sstatic.net/tskMh.png) GitHub](https://github.com/RoseauTechnologies)
