Default NAD depth set to 1

Signed-off-by: Florian Dupuy <[email protected]>
powsybl · Sep 4, 2024 · c7131d6 · c7131d6
1 parent 09c70e1
commit c7131d6
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/docs/user_guide/nad_explorer.md b/docs/user_guide/nad_explorer.md
@@ -26,7 +26,7 @@ Pan and zoom features are available for the diagram.
 Other than the target network, the NAD explorer can be customized using additional parameters:
 
 ```python
-nad_explorer(network: Network, voltage_level_ids : list = None, depth: int = 0, low_nominal_voltage_bound: float = -1, high_nominal_voltage_bound: float = -1, parameters: NadParameters = None):
+nad_explorer(network: Network, voltage_level_ids : list = None, depth: int = 1, low_nominal_voltage_bound: float = -1, high_nominal_voltage_bound: float = -1, parameters: NadParameters = None):
 ```
 
 - network: the input network

diff --git a/docs/user_guide/network_explorer.md b/docs/user_guide/network_explorer.md
@@ -48,7 +48,7 @@ A further click on an entry in the list will navigate the explorer to the corres
 Other than the target network, the Network explorer can be customized using additional parameters:
 
 ```python
-network_explorer(network: Network, vl_id : str = None, use_name:bool  = True, depth: int = 0, high_nominal_voltage_bound: float = -1, low_nominal_voltage_bound: float = -1, nad_parameters: NadParameters = None, sld_parameters: SldParameters = None, use_line_geodata:bool = False):
+network_explorer(network: Network, vl_id : str = None, use_name:bool  = True, depth: int = 1, high_nominal_voltage_bound: float = -1, low_nominal_voltage_bound: float = -1, nad_parameters: NadParameters = None, sld_parameters: SldParameters = None, use_line_geodata:bool = False):
 ```
 
 - vl_id: the starting VL to display. If None, display the first VL from network.get_voltage_levels()

diff --git a/src/pypowsybl_jupyter/nadexplorer.py b/src/pypowsybl_jupyter/nadexplorer.py
@@ -10,7 +10,7 @@
 
 import ipywidgets as widgets
 
-def nad_explorer(network: Network, voltage_level_ids : list = None, depth: int = 0, low_nominal_voltage_bound: float = -1, high_nominal_voltage_bound: float = -1, parameters: NadParameters = None):
+def nad_explorer(network: Network, voltage_level_ids : list = None, depth: int = 1, low_nominal_voltage_bound: float = -1, high_nominal_voltage_bound: float = -1, parameters: NadParameters = None):
     """
     Creates a basic nad explorer widget for a network, built with the nad widget.
 

diff --git a/src/pypowsybl_jupyter/networkexplorer.py b/src/pypowsybl_jupyter/networkexplorer.py
@@ -13,7 +13,7 @@
 
 import ipywidgets as widgets
 
-def network_explorer(network: Network, vl_id : str = None, use_name:bool = True, depth: int = 0,
+def network_explorer(network: Network, vl_id : str = None, use_name:bool = True, depth: int = 1,
                      high_nominal_voltage_bound: float = -1, low_nominal_voltage_bound: float = -1,
                      nominal_voltages_top_tiers_filter:int = -1,
                      nad_parameters: NadParameters = None, sld_parameters: SldParameters = None,