add Sld parameters in doc (#775)

* add Sld parameters in doc --------- Signed-off-by: Tiphaine Mouminous <tiphaine.mouminous_externe@rte-france.com>
powsybl · Aug 24, 2024 · 6c2002a · 6c2002a
1 parent d605170
commit 6c2002a
Show file tree

Hide file tree

Showing 12 changed files with 4,953 additions and 0 deletions.
diff --git a/docs/_static/images/SldParam_topologicalcoloringfalse.svg b/docs/_static/images/SldParam_topologicalcoloringfalse.svg
diff --git a/docs/_static/images/SldParam_topologicalcoloringtrue.svg b/docs/_static/images/SldParam_topologicalcoloringtrue.svg
diff --git a/docs/_static/images/ieee14_SldParam_centername.svg b/docs/_static/images/ieee14_SldParam_centername.svg
diff --git a/docs/_static/images/ieee14_SldParam_complib_flatdesign.svg b/docs/_static/images/ieee14_SldParam_complib_flatdesign.svg
diff --git a/docs/_static/images/ieee14_SldParam_default.svg b/docs/_static/images/ieee14_SldParam_default.svg
diff --git a/docs/_static/images/ieee14_SldParam_diagonallabel.svg b/docs/_static/images/ieee14_SldParam_diagonallabel.svg
diff --git a/docs/_static/images/ieee14_SldParam_nodesinfos.svg b/docs/_static/images/ieee14_SldParam_nodesinfos.svg
diff --git a/docs/_static/images/ieee14_SldParam_tooltipenabledtrue.png b/docs/_static/images/ieee14_SldParam_tooltipenabledtrue.png
diff --git a/docs/_static/images/ieee14_SldParam_topologicalcoloringfalse.svg b/docs/_static/images/ieee14_SldParam_topologicalcoloringfalse.svg
diff --git a/docs/_static/images/ieee14_SldParam_topologicalcoloringtrue.svg b/docs/_static/images/ieee14_SldParam_topologicalcoloringtrue.svg
diff --git a/docs/_static/images/ieee14_SldParam_usename.svg b/docs/_static/images/ieee14_SldParam_usename.svg
diff --git a/docs/user_guide/network_visualization.rst b/docs/user_guide/network_visualization.rst
@@ -28,6 +28,110 @@ Note that a loadflow can be run before writing the diagram so that it displays r
 .. image:: ../_static/images/ieee14_vl4.svg
    :class: forced-white-background
 
+Single-line diagrams can be customized through SldParameters:
+
+.. code-block:: python
+
+    >>> network = pp.network.create_ieee14()
+    >>> result = pp.loadflow.run_ac(network)
+    >>> network.get_single_line_diagram('VL4',parameters = pp.network.SldParameters(use_name = False, center_name = False, diagonal_label = False, nodes_infos = False, tooltip_enabled = False, topological_coloring = True, component_library = 'Convergence'))
+
+    - use_name: if true, display components names instead of their id (default value false)
+    - center_name: if true, center the names of feeders (default value false)
+    - diagonal_label: if true, display labels diagonally (default value false)
+    - nodes_infos: if true, display nodes infos (caption on bottom left) (default value false)
+    - tooltip_enabled: if true, display the name of the component pointed by the cursor (default value false)
+    - topological_coloring: if true, set each electrical nodes with a different colour (default value true)
+    - component_library: choose component library (default value 'Convergence')
+
+Let's see some examples down below:
+
+- with default parameters
+.. code-block:: python
+
+    >>> import pypowsybl.network as pn
+    >>> param = pn.SldParameters() #default parameters
+    >>> network.get_single_line_diagram('VL4', parameters = param)
+
+.. image:: ../_static/images/ieee14_SldParam_default.svg
+   :class: forced-white-background
+
+- with use_name = true
+.. code-block:: python
+
+    >>> param = pn.SldParameters(use_name = True)
+    >>> network.get_single_line_diagram('VL4', parameters = param)
+
+.. image:: ../_static/images/ieee14_SldParam_usename.svg
+   :class: forced-white-background
+
+- with center_name = true
+.. code-block:: python
+
+    >>> param = pn.SldParameters(center_name = True)
+    >>> network.get_single_line_diagram('VL4', parameters = param)
+
+.. image:: ../_static/images/ieee14_SldParam_centername.svg
+   :class: forced-white-background
+
+- with diagonal_label = true
+.. code-block:: python
+
+    >>> param = pn.SldParameters(diagonal_label = True)
+    >>> network.get_single_line_diagram('VL4', parameters = param)
+
+.. image:: ../_static/images/ieee14_SldParam_diagonallabel.svg
+   :class: forced-white-background
+
+- with nodes_infos = true
+.. code-block:: python
+
+    >>> param = pn.SldParameters(nodes_infos = True)
+    >>> network.get_single_line_diagram('VL4', parameters = param)
+
+.. image:: ../_static/images/ieee14_SldParam_nodesinfos.svg
+   :class: forced-white-background
+
+- with tooltip enabled
+.. code-block:: python
+
+    >>> param = pn.SldParameters(tooltip_enabled = True)
+    >>> network.get_single_line_diagram('VL4', parameters = param)
+
+.. image:: ../_static/images/ieee14_SldParam_tooltipenabledtrue.png
+   :class: forced-white-background
+
+- with topological coloring = true
+.. code-block:: python
+
+    >>> network = pn.create_four_substations_node_breaker_network()
+    >>> network.update_switches(id="S1VL2_COUPLER",open=True)
+    >>> param = pn.SldParameters(topological_coloring = True)
+    >>> network.get_single_line_diagram('S1VL2', parameters = param)
+
+.. image:: ../_static/images/SldParam_topologicalcoloringtrue.svg
+   :class: forced-white-background
+
+- with topological coloring = false
+.. code-block:: python
+
+    >>> param = pn.SldParameters(topological_coloring = False)
+    >>> network.get_single_line_diagram('S1VL2', parameters = param)
+
+.. image:: ../_static/images/SldParam_topologicalcoloringfalse.svg
+   :class: forced-white-background
+
+- with component_library = "FlatDesign"
+.. code-block:: python
+
+    >>> network = pn.create_ieee14()
+    >>> param = pn.SldParameters(component_library = "FlatDesign")
+    >>> network.get_single_line_diagram('VL4', parameters = param)
+
+.. image:: ../_static/images/ieee14_SldParam_complib_flatdesign.svg
+   :class: forced-white-background
+
+
 It is also possible to display a multi-substation single line diagram (currently a beta feature):
 
 .. code-block:: python