Network explorer widget¶
Network explorer is an interactive widget, built on pypowsybl-jupyter’s widgets (SLD, NAD, Network map) and some standard ipywidgets: select lists, tabs, etc.
Through the widget, you can select a voltage level from the list (or search of a specific one using the Filter) and the NAD and SLD diagrams for that voltage level will be displayed in the two “Network Area” and “Single Line” tabs, respectively. Both diagrams can be panned and zoomed. A third tab, ‘Network map’ displays the network’s substations and lines on a map, if substations and lines geo data is available in the network. The last displayed voltage levels are listed in a history box, on the explorer’s bottom left corner.
The following code, to be run in a notebook, first creates a network, then displays the network explorer on it.
import pypowsybl.network as pn
from pypowsybl_jupyter import network_explorer
network=pn.create_four_substations_node_breaker_network()
network_explorer(network)
Network Area tab¶
The selected voltage level is the displayed NAD’s center.
A ‘depth’ slider controls the size of the sub network.
In the diagram, nodes can be moved interactively by drag&drop (e.g., to change the diagram layout for presentation purposes). However, the new node positions are not currently saved; Therefore, after switching to a new VL and then switching back to the current VL, the original nodes layout would be restored. Please note that the select and move features require versions of PyPowSyBl equal to or greater than v1.8.1. Right-clicking a VL node displays a context menu to expand or remove the node from the diagram. Note: Changes to the graph are not saved. They will be lost when a new node is selected or the depth parameter changes. The ‘Open in SLD tab’ entry in the context menu will activate the SLD panel on the corresponding voltage level.
Single Line tab¶
By clicking on an arrow in the SLD you can navigate to another voltage level.
Switches can also be clicked, causing their status in the network to change; Please note that, currently, this action does not trigger any computation on the network (e.g., a LF is not automatically run on the network).
Network map tab¶
The ‘Network map’ displays the network’s substations and lines on a map. The map is empty if the network does not contain geo data. Please note that substation’s and line’s IIDM extensions are only available in PyPowSyBl starting from v1.5.0; With earlier versions of PyPowSyBl the map would be empty, too.
By clicking on a substation, a list with the substation’s voltage levels appears.
A further click on an entry in the list will navigate the explorer to the corresponding voltage level.
Widget API¶
Other than the target network, the Network explorer can be customized using additional parameters:
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, nad_profile: NadProfile = None, on_hover:bool = True, on_hover_func: OnHoverFuncType = None, fixed_nad_positions: DataFrame = None)
vl_id: the starting VL to display. If None, display the first VL from network.get_voltage_levels()
use_name: when available, display VLs names instead of their ids (default is to use names)
depth: the diagram depth around the voltage level, controls the size of the sub network. In the SLD tab will be always displayed one diagram, from the VL list currently selected item.
low_nominal_voltage_bound: low bound to filter voltage level according to nominal voltage
high_nominal_voltage_bound: high bound to filter voltage level according to nominal voltage
nominal_voltages_top_tiers_filter: number of nominal voltages to select in the Network map’s nominal voltages filter, starting from the highest. -1 means all the nominal voltages.
nad_parameters: layout properties to adjust the svg rendering for the NAD
sld_parameters: layout properties to adjust the svg rendering for the SLD
use_line_geodata: When False (default) the network map tab does not use the network’s line geodata extensions; Each line is drawn as a straight line connecting two substations.
nad_profile: property to customize labels and style for the NAD
on_hover: when True, the hovering is enabled
on_hover_func: a callback function that is invoked when hovering on equipments in the NAD, SLD and the network-map tabs. The function parameters (OnHoverFuncType = Callable[[str, str], str]) are the equipment id and type; It must return an HTML string. None, the default, will display in the popup all the attributes available in the edquipment’s dataframe; To exemplify, the default function is listed below. Note that, depending on the specific viewer component (the NAD, the SLD and the network-map), not all the equipments are currently hoverable; more details in their detailed documentation.
fixed_nad_positions: positions dataframe to layout the voltage levels in the NAD. The fixed positions dataframe is fully described in Pypowsybl Network visualization guide.
on_hover_func default function¶
def format_to_html_table(row, id, type):
table = (
row.to_frame()
.style.set_caption(f"{type}: {id}")
.set_table_styles(
[
{
"selector": "caption",
"props": "caption-side: top; font-weight: bold; background-color: #f8f8f8; border-bottom: 1px solid #ddd; width: fit-content; white-space: nowrap;",
},
{
"selector": "th",
"props": "text-align: left; font-weight: bold; background-color: #f8f8f8;",
},
{
"selector": "td",
"props": "text-align: left;",
},
]
)
.format(precision=3, thousands=".", decimal=",")
.set_table_attributes('border="0"')
.hide(axis="columns")
.to_html()
)
return table
def get_hovering_equipment_info(id, type):
if type == 'LINE':
return format_to_html_table(network.get_lines().loc[id], id, type)
elif type == 'HVDC_LINE':
return format_to_html_table(network.get_hvdc_lines().loc[id], id, type)
elif type in [ 'PHASE_SHIFT_TRANSFORMER', 'TWO_WINDINGS_TRANSFORMER']:
return format_to_html_table(network.get_2_windings_transformers().loc[id], id, type)
elif type == 'THREE_WINDINGS_TRANSFORMER':
return format_to_html_table(network.get_3_windings_transformers().loc[id], id, type)
elif type == 'DANGLING_LINE':
return format_to_html_table(network.get_dangling_lines().loc[id], id, type)
elif type == 'TIE_LINE':
return format_to_html_table(network.get_tie_lines().loc[id], id, type)
return f"Equipment of type '{type}' with id '{id}'"