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

DOC: Update the tutorials #266

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ [email protected].

![Catalogue of networks](https://github.com/RoseauTechnologies/Roseau_Load_Flow/blob/main/doc/_static/Network/Catalogue.png?raw=True)

## Tutorials

The folder `tutorials` contains some Jupyter Notebooks designed to help new users of _Roseau Load Flow_. Currently,
some tutorials dedicated to _OpenDSS_ users are available.

## Bug reports / Feature requests

If you find a bug or have a feature request, please open an issue on
Expand Down
6 changes: 5 additions & 1 deletion doc/Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,13 @@ og:description: See what's new in the latest release of Roseau Load Flow !

# Changelog

## Unreleased

- {gh-pr}`266` Update the tutorials with the new version of _Roseau Load Flow_.

## Version 0.10.0

- A wheel for Python 3.13 is also available.
- A wheel for Python 3.13 is available.
- The wheels for Windows are now available. The problem was the same as the one of the
[issue 28551](https://github.com/matplotlib/matplotlib/issues/28551) of the Matplotlib repository.
- {gh-pr}`237` Improvements of the Sphinx configuration.
Expand Down
33 changes: 15 additions & 18 deletions tutorials/OpenDSS/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,25 @@
# Roseau Load Flow Tutorials
# OpenDSS

This series of tutorials provides a step-by-step guide to modelling, solving, and analyzing
electrical networks using the Roseau Load Flow solver by following the
[OpenDSS tutorials by prof. Nando Ochoa](https://github.com/Team-Nando).

## Pre-Requisites

Please follow the instructions in the [main README](../README.md) file to install the required packages.
In this directory, there are tutorials related to _OpenDSS_. The two tutorials of this section uses the network of
the [Tutorial on
DER Hosting Capacity - Part 1: Advanced Tools for the Analysis of Three-Phase Unbalanced LV Networks](https://github.com/Team-Nando/Tutorial-DERHostingCapacity-1-AdvancedTools_LV) provided by
[TeamNando](https://github.com/Team-Nando).

## Tutorial 1

This tutorial involves modelling a simple LV network and is designed to familiarize the user with
the basic workflow of Roseau Load Flow (RLF). You will learn the following:
This tutorial involves modelling a simple LV network and is designed to familiarize the user with the basic workflow
of _Roseau Load Flow (RLF)_. You will learn the following:

1. How to model common network components such as buses, lines, transformers, etc. in RLF as well
as RLF-specific components.
2. How to build a network and run power flow simulations in RLF.
1. How to model common network components such as buses, lines, transformers, etc. in _RLF_ as well as RLF-specific
components.
2. How to build a network and run power flow simulations in _RLF_.
3. How to access different types of results for various network elements

## Tutorial 2

This tutorial focuses on the modelling flexibility of RLF as well as benchmarking RLF. It also
demonstrates the interoperability of RLF with OpenDSS. In this tutorial, you will learn the
following:
This series of tutorials focuses on the modelling flexibility of _RLF_ as well as benchmarking _RLF_ with _OpenDSS_, a
popular power flow solver. It will also demonstrate the interoperability of RLF with OpenDSS. In this tutorial, you
will learn the following:

1. How to convert OpenDSS parameters into RLF parameters
2. How to model networks with a single-wire, earth-return systems in RLF
1. How to convert OpenDSS parameters into _RLF_ parameters
2. How to model networks with a single-wire earth return systems in _RLF_
340 changes: 162 additions & 178 deletions tutorials/OpenDSS/Tutorial_1/Exercise_1.ipynb

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions tutorials/OpenDSS/Tutorial_1/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Modelling and analyzing a simple unbalanced network with Roseau Load Flow solver

This tutorial is meant to introduce the procedure for modelling components of a given low voltage (LV) network using
the _Roseau Load Flow_ solver. It will also cover the process of running a power flow, accessing results, and analysis
such as voltage regulation and energy losses.

In this tutorial, we use the simple network coming from the tutorial of _OpenDSS_ provided by
[TeamNando](https://github.com/Team-Nando) and called `Tutorial-DERHostingCapacity-1-AdvancedTools_LV`. Cf
[here](https://github.com/Team-Nando/Tutorial-DERHostingCapacity-1-AdvancedTools_LV) for the original tutorial.

This simple LV network is shown in the figure below containing a MV/LV, $\Delta$-Y transformer (20kV/0.4kV,
250 kVA) between the source bus and bus A, a 240 mm², 3-phase line connecting buses A and B, and three 16 mm²
single-phase lines connecting bus B with buses C, D and E each of which serves as a connection point for a house.

!["Simple LV network"](../images/LV_Network_With_Neutral.png)
**<div style="text-align: center;"> Figure 1. Simple LV Network</div>**
38 changes: 38 additions & 0 deletions tutorials/OpenDSS/Tutorial_2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Modelling and Analysis of a Simple Unbalanced LV Network

## Introduction

This tutorial will demonstrate how to model an unbalanced LV network with _Roseau Load Flow (RLF)_ solver. We use
the simple network coming from the tutorial of _OpenDSS_ provided by
[TeamNando](https://github.com/Team-Nando) and called `Tutorial-DERHostingCapacity-1-AdvancedTools_LV`. Cf
[here](https://github.com/Team-Nando/Tutorial-DERHostingCapacity-1-AdvancedTools_LV) for the original tutorial.

Before attempting this tutorial, you should have finished "Tutorial 1" in this repository for a basic knowledge of
how the _RLF_ solver works. We'll be using a modified form of the network in Tutorial 1. The network consists of an
MV bus, a MV/LV, $\Delta$-Y transformer (11kV/0.4kV, 250 kVA) between the source bus and bus A, a 240 mm² 3-phase
line connecting buses A and B, and three 16 mm² single-phase lines connecting bus B with buses C, D and E each of
which serves as a connection point for a house.

The [original tutorial](https://github.com/Team-Nando/Tutorial-DERHostingCapacity-1-AdvancedTools_LV) uses _OpenDSS_
to model this LV network using an earth return system as depicted in Figure 1.

!["Simple LV Network with Earth Return System"](../images/LV_Network_Without_Neutral.png)
**<div style="text-align: center;"> Figure 1. Simple LV Network with Earth Return System</div>**

This first tutorial allows the user of _RLF_ to get the same results as in the original tutorial.

In a second tutorial, we propose to add a neutral to this network as depicted in Figure 2.

!["Simple LV Network with a Neutral"](../images/LV_Network_With_Neutral.png)
**<div style="text-align: center;"> Figure 2. Simple LV Network with a Neutral Wire</div>**

The details for the loads in the network are given in the table below.
| Load Name | Phases | Connected bus | Peak Demand (kW) | PF |
| :-------- | :----- | :------------ | :--------------- | :--- |
| Load_1 | 1 | C | 7 | 0.95 |
| Load_2 | 1 | D | 6 | 0.95 |
| Load_3 | 1 | E | 8 | 0.95 |

Because this tutorial focuses on the _RLF_ solver, we will only provide a brief overview of how to model the above
network in _OpenDSS_. For a detailed explanation of how to model this network in _OpenDSS_, we refer you to this origin
of this tutorial which is available [here](https://github.com/Team-Nando/Tutorial-DERHostingCapacity-1-AdvancedTools_LV).
Loading
Loading