Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Version 0.12.0-alpha #314

Merged
merged 21 commits into from
Jan 9, 2025
Merged
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
3e44152
Minor tweaks to the README
alihamdan Dec 9, 2024
1e991e1
Improve singular matrix error (#301)
Saelyos Dec 27, 2024
951853f
De-duplicate the documentation welcome section and fix ipython code-b…
alihamdan Dec 27, 2024
f9d78f1
Fix voltage_level network result when missing limits (#303)
alihamdan Dec 31, 2024
6e3fd78
Fix broken links in the README
alihamdan Dec 31, 2024
f187513
Move important modules to top-level (#304)
alihamdan Dec 31, 2024
52d1615
Run pytest with cov in CI
alihamdan Dec 31, 2024
83c3937
Bump astral-sh/setup-uv from 4 to 5
dependabot[bot] Jan 1, 2025
2c01df3
Merge pull request #305 from RoseauTechnologies/dependabot/github_act…
benoit9126 Jan 1, 2025
9118949
Add missing information and improve performance (#306)
alihamdan Jan 2, 2025
6e558f6
Make violations of lines and buses per-phase (#307)
alihamdan Jan 3, 2025
71daae0
Remove the tutorials (#309)
alihamdan Jan 6, 2025
a7e8a61
Support star and zigzag transformers with non brought out neutrals (#…
alihamdan Jan 6, 2025
613c085
Improve line enumeration types and fix errors in Coiffier's model (#311)
alihamdan Jan 7, 2025
472511a
Fix comment
alihamdan Jan 8, 2025
44bd45c
DOC: RTD generates sitemap
benoit9126 Jan 9, 2025
b00071a
Merge pull request #312 from RoseauTechnologies/doc
benoit9126 Jan 9, 2025
9acfa74
Update network files
alihamdan Jan 9, 2025
b1f629a
Merge pull request #313 from RoseauTechnologies/update-networks
benoit9126 Jan 9, 2025
d3205ff
ENH: Bump version
benoit9126 Jan 9, 2025
e548d80
ENH: Use the last version of the engine
benoit9126 Jan 9, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
De-duplicate the documentation welcome section and fix ipython code-b…
…lock (#302)
  • Loading branch information
alihamdan authored Dec 27, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 951853f66ef41461e1e4c3dd2267e0a1826f9208
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -4,6 +4,8 @@
![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)

<!-- start rlf-pitch -->

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

- **Multi-phase**, **unbalanced** power flow analysis
@@ -21,6 +23,8 @@ In addition to the following **unique** set of features:
- Support for **flexible**, voltage-dependent, loads directly in the Newton algorithm for better
convergence and stability

<!-- end rlf-pitch -->

This project is compatible with Python version 3.10 and newer. The
[installation instructions](https://roseau-load-flow.roseautechnologies.com/Installation.html)
will guide you through the installation process. If you are new to _Roseau Load Flow_, we recommend
@@ -43,11 +47,15 @@ Read more at [License](https://roseau-load-flow.roseautechnologies.com/License.h

## 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. At _Roseau Technologies_, we can provide
the major part of the French medium and low voltage networks on demand. For more information, please
contact us at [email protected].

<!-- 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.png?raw=True" />
</div>
2 changes: 1 addition & 1 deletion doc/Installation.md
Original file line number Diff line number Diff line change
@@ -114,7 +114,7 @@ the corresponding functions. They can be installed with the
If you are using Jupyter Notebooks, you can install `roseau-load-flow` directly from a notebook
cell with:

```python-console
```ipython
In [1]: %pip install roseau-load-flow
```

2 changes: 1 addition & 1 deletion doc/License.md
Original file line number Diff line number Diff line change
@@ -124,7 +124,7 @@ variable:
ROSEAU_LOAD_FLOW_LICENSE_KEY="A8C6DA-9405FB-E74FB9-C71C3C-207661-V3"
```
2. Add a cell to the beginning of your notebook with the following content and execute it:
```python-console
```ipython
%pip install python-dotenv
%load_ext dotenv
%dotenv
35 changes: 9 additions & 26 deletions doc/index.md
Original file line number Diff line number Diff line change
@@ -15,32 +15,15 @@ myst:

# Welcome to the Roseau Load Flow documentation

_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
- Real-world distribution network data samples in the library (with more available on request)

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

- Support for _floating neutrals_ for loads and sources
- Four-wire multi-phase modelling with no Kron's reduction, no transformations, no assumptions on the
network topology and no implicit earthing everywhere
- Support for **flexible**, voltage-dependent, loads directly in the Newton algorithm for better
convergence and stability

This software is developed by [Roseau Technologies](https://www.roseautechnologies.com/en).
<a href="https://www.linkedin.com/company/roseau-technologies/"><i class="fa-brands fa-linkedin" ></i></a>
<a href="https://github.com/RoseauTechnologies/"><i class="fa-brands fa-github" ></i></a>

_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. At _Roseau Technologies_, we can provide
the major part of the French medium and low voltage networks on demand. For more information, please
contact us at
[[email protected]](mailto:[email protected]).
```{include} ../README.md
:start-after: <!-- start rlf-pitch -->
:end-before: <!-- end rlf-pitch -->
```

```{include} ../README.md
:start-after: <!-- start rlf-networks -->
:end-before: <!-- end rlf-networks -->
```

<iframe src="./_static/Network/Catalogue.html" height="600px" width="100%" frameborder="0"></iframe>

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -73,6 +73,7 @@ doc = [
"sphinxcontrib-bibtex>=2.5.0",
"sphinx-sitemap>=2.5.1",
"sphinxext-opengraph>=0.9.1",
"ipython>=8.31.0",
]

[tool.uv]
158 changes: 158 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading