(tuto) Create network out of csv files and using "plural" create functions

[kbensafta]

A tutorial that explains how to create networks based on csv files while using the conveniency plural create functions. The longniddry (gas) network is used to illustrate the process. I have numbered the tutorials, in order to make it easier for interested users to know where to begin and what to do next. I have taken the opportunity of this PR to clarify the docstring of the pipe(s) create functions in commit fcc4083 (mentioned in #426)

[codecov[bot]]

Codecov Report

Patch and project coverage have no change.

Comparison is base (513ef67) 85.16% compared to head (3ca4ec8) 85.16%.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #519   +/-   ##
========================================
  Coverage    85.16%   85.16%           
========================================
  Files           90       90           
  Lines         6166     6166           
========================================
  Hits          5251     5251           
  Misses         915      915           

Files Changed	Coverage Δ
pandapipes/create.py	90.43% <ø> (ø)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[jkisse]

If the numbering of the tutorials is merged, please note that all respective links on the pandapipes-website need to be updated too.

[jkisse]

What do you think about numbering the tutorials, @dlohmeier ?

[dlohmeier]

Do we have a mirrored numbering in the documentation or website? In general, I like the idea of showing a useful order of the tutorials, is it also displayed elsewhere? Do we have a way to give the numbering meaning? Is it oriented along the documentation chapters? So, one question is if we should make the numbering inside to tutorials as well, and create a small tutorials chapter in the documentation with the exact same order. Or do we just add some numbers for those who just dive into the tutorials folder of pandapipes?

[jkisse]

Instead of 1.1, 1.2, 2.1 etc. we could use categories, e.g. B_1 , B_2, ... for basic stuff, and H1, 2... (district Heating), G (gas networks), and P (Plotting) for the other topics.

[kbensafta]

@dlohmeier

Or do we just add some numbers for those who just dive into the tutorials folder of pandapipes?

Yes, the idea is just to add some basic/intuitive structure and orientation to those who dive directly into the tutorials folder. The first number (left to the underscore) represents (roughly) the level of advacement of the tutorials, from basic (0) to advanced (4).

Do we have a mirrored numbering in the documentation or website?

I don't understant what you mean with mirrored. Do you mean it in the sens of synchronized/harmonized ?

[dlohmeier]

@dlohmeier

Or do we just add some numbers for those who just dive into the tutorials folder of pandapipes?

Yes, the idea is just to add some basic/intuitive structure and orientation to those who dive directly into the tutorials folder. The first number (left to the underscore) represents (roughly) the level of advacement of the tutorials, from basic (0) to advanced (4).

Do we have a mirrored numbering in the documentation or website?

I don't understant what you mean with mirrored. Do you mean it in the sens of synchronized/harmonized ?

Yes, is there a general way we structure our documentation, along which we can align the tutorials to make the numbering as understandable as possible? Or do we maybe need to restructure the documentation to reach this goal?

[kbensafta]

@dlohmeier By "documentation" you mean the homepage and/or the readthedocs website ?

The tuto numbering in the PR and the way the tutorials are stuctured in the homepage are more or less similar, but not totally consistent. Note that the storage tutorial is not in the homepage. Should I make the tuto numbering consistent with the tuto structuring in the homepage? Is the readthedocs website concerned by the harmonized tuto structure or should we not include it in the issue ?

[dlohmeier]

I mean readthedocs. But it appears to me that the tutorials and the documentation don't have enough overlap to ensure that they are consistent. Maybe it just makes sense to use the numbering you gave the tutorials. I just have some small suggestions for change: 3.2 -> 1.3 , switch 2.1 + 2.2, 2.3 -> 3.1, 3.1 -> 3.2 and maybe even 4.1 -> 3.3 . What do you think?

[kbensafta]

Sorry for not answering earlier.

Based on the website and your comments, I propose to use this structure for the tutotrials (see below). Then if this structure is agreed upon, also use it for the tutorials in the repo, and order them either by sticking to the numbering method (as of now in the PR) or maybe using sub-folders in the tutorial folder. What do you think about using sub-folders?

Section 1: To Get Started

• Minimal example hydraulic calculation

• Creating a simple gas or water network

• Introduction to Plotting

• Einfache Netzwerke in pandapipes modellieren

Section 2: Static thermal calculations

• Pipe temperature
• Circular flow district heating

Section 3: Some Features

• Standard type and fluid library

• Simple timeseries example

• Working with height differences

• Storage

• Create net form csv files

• Modellieren mit Höhendifferenzen

Section 4: Mutlinet

• Introduction to coupled simulation of power and gas networks (multinet)
• German version of tutorial for coupled simulations