def simple_plot(net,
respect_switches=False,
line_width=1.0,
bus_size=1.0,
ext_grid_size=1.0,
trafo_size=1.0,
plot_loads=False,
plot_gens=False,
plot_sgens=False,
load_size=1.0,
gen_size=1.0,
sgen_size=1.0,
switch_size=2.0,
switch_distance=1.0,
plot_line_switches=False,
scale_size=True,
bus_color="b",
line_color='grey',
trafo_color='k',
ext_grid_color='y',
switch_color='k',
library="igraph",
show_plot=True,
ax=None):
"""
Plots a pandapower network as simple as possible. If no geodata is available, artificial
geodata is generated. For advanced plotting see the tutorial
INPUT:
**net** - The pandapower format network.
OPTIONAL:
**respect_switches** (bool, False) - Respect switches if artificial geodata is created.
This Flag is ignored if plot_line_switches is True
**line_width** (float, 1.0) - width of lines
**bus_size** (float, 1.0) - Relative size of buses to plot.
The value bus_size is multiplied with mean_distance_between_buses, which equals the
distance between
the max geoocord and the min divided by 200.
mean_distance_between_buses = sum((net['bus_geodata'].max() - net['bus_geodata'].min()) / 200)
**ext_grid_size** (float, 1.0) - Relative size of ext_grids to plot. See bus sizes for details.
Note: ext_grids are plottet as rectangles
**trafo_size** (float, 1.0) - Relative size of trafos to plot.
**plot_loads** (bool, False) - Flag to decide whether load symbols should be drawn.
**plot_gens** (bool, False) - Flag to decide whether gen symbols should be drawn.
**plot_sgens** (bool, False) - Flag to decide whether sgen symbols should be drawn.
**load_size** (float, 1.0) - Relative size of loads to plot.
**sgen_size** (float, 1.0) - Relative size of sgens to plot.
**switch_size** (float, 2.0) - Relative size of switches to plot. See bus size for details
**switch_distance** (float, 1.0) - Relative distance of the switch to its corresponding \
bus. See bus size for details
**plot_line_switches** (bool, False) - Flag if line switches are plotted
**scale_size** (bool, True) - Flag if bus_size, ext_grid_size, bus_size- and distance \
will be scaled with respect to grid mean distances
**bus_color** (String, colors[0]) - Bus Color. Init as first value of color palette. Usually colors[0] = "b".
**line_color** (String, 'grey') - Line Color. Init is grey
**trafo_color** (String, 'k') - Trafo Color. Init is black
**ext_grid_color** (String, 'y') - External Grid Color. Init is yellow
**switch_color** (String, 'k') - Switch Color. Init is black
**library** (String, "igraph") - library name to create generic coordinates (case of
missing geodata). "igraph" to use igraph package or "networkx" to use networkx package.
**show_plot** (bool, True) - Shows plot at the end of plotting
**ax** (object, None) - matplotlib axis to plot to
OUTPUT:
**ax** - axes of figure
"""
# don't hide lines if switches are plotted
if plot_line_switches:
respect_switches = False
# create geocoord if none are available
if len(net.line_geodata) == 0 and len(net.bus_geodata) == 0:
logger.warning(
"No or insufficient geodata available --> Creating artificial coordinates."
+ " This may take some time")
create_generic_coordinates(net,
respect_switches=respect_switches,
library=library)
if scale_size:
# if scale_size -> calc size from distance between min and max geocoord
sizes = get_collection_sizes(net, bus_size, ext_grid_size, trafo_size,
load_size, sgen_size, switch_size,
switch_distance, gen_size)
bus_size = sizes["bus"]
ext_grid_size = sizes["ext_grid"]
trafo_size = sizes["trafo"]
sgen_size = sizes["sgen"]
load_size = sizes["load"]
switch_size = sizes["switch"]
switch_distance = sizes["switch_distance"]
gen_size = sizes["gen"]
# create bus collections to plot
bc = create_bus_collection(net,
net.bus.index,
size=bus_size,
color=bus_color,
zorder=10)
# if bus geodata is available, but no line geodata
use_bus_geodata = len(net.line_geodata) == 0
in_service_lines = net.line[net.line.in_service].index
nogolines = set(net.switch.element[(net.switch.et == "l") & (net.switch.closed == 0)]) \
if respect_switches else set()
plot_lines = in_service_lines.difference(nogolines)
# create line collections
lc = create_line_collection(net,
plot_lines,
color=line_color,
linewidths=line_width,
use_bus_geodata=use_bus_geodata)
collections = [bc, lc]
# create ext_grid collections
# eg_buses_with_geo_coordinates = set(net.ext_grid.bus.values) & set(net.bus_geodata.index)
if len(net.ext_grid) > 0:
sc = create_ext_grid_collection(net,
size=ext_grid_size,
orientation=0,
ext_grids=net.ext_grid.index,
patch_edgecolor=ext_grid_color,
zorder=11)
collections.append(sc)
# create trafo collection if trafo is available
trafo_buses_with_geo_coordinates = [
t for t, trafo in net.trafo.iterrows()
if trafo.hv_bus in net.bus_geodata.index
and trafo.lv_bus in net.bus_geodata.index
]
if len(trafo_buses_with_geo_coordinates) > 0:
tc = create_trafo_collection(net,
trafo_buses_with_geo_coordinates,
color=trafo_color,
size=trafo_size)
collections.append(tc)
# create trafo3w collection if trafo3w is available
trafo3w_buses_with_geo_coordinates = [
t for t, trafo3w in net.trafo3w.iterrows()
if trafo3w.hv_bus in net.bus_geodata.index and trafo3w.mv_bus in
net.bus_geodata.index and trafo3w.lv_bus in net.bus_geodata.index
]
if len(trafo3w_buses_with_geo_coordinates) > 0:
tc = create_trafo3w_collection(net,
trafo3w_buses_with_geo_coordinates,
color=trafo_color)
collections.append(tc)
if plot_line_switches and len(net.switch):
sc = create_line_switch_collection(
net,
size=switch_size,
distance_to_bus=switch_distance,
use_line_geodata=not use_bus_geodata,
zorder=12,
color=switch_color)
collections.append(sc)
if plot_sgens and len(net.sgen):
sgc = create_sgen_collection(net, size=sgen_size, orientation=0)
collections.append(sgc)
if plot_gens and len(net.gen):
gc = create_gen_collection(net, size=gen_size)
collections.append(gc)
if plot_loads and len(net.load):
lc = create_load_collection(net, size=load_size)
collections.append(lc)
if len(net.switch):
bsc = create_bus_bus_switch_collection(net, size=switch_size)
collections.append(bsc)
ax = draw_collections(collections, ax=ax)
if show_plot:
plt.show()
return ax
def simple_plot(net,
respect_switches=False,
line_width=1.0,
bus_size=1.0,
ext_grid_size=1.0,
switch_size=1.0,
switch_distance=1.0,
plot_line_switches=False,
scale_size=True,
bus_color="b",
line_color='grey',
trafo_color='k',
ext_grid_color='y',
switch_color='k',
library="igraph",
show_plot=True):
"""
Plots a pandapower network as simple as possible. If no geodata is available, artificial
geodata is generated. For advanced plotting see the tutorial
INPUT:
**net** - The pandapower format network.
OPTIONAL:
**respect_switches** (bool, False) - Respect switches if artificial geodata is created.
.. note::
This Flag is ignored if plot_line_switches is True
**line_width** (float, 1.0) - width of lines
**bus_size** (float, 1.0) - Relative size of buses to plot.
The value bus_size is multiplied with mean_distance_between_buses, which equals the
distance between
the max geoocord and the min divided by 200.
mean_distance_between_buses = sum((net['bus_geodata'].max()
- net['bus_geodata'].min()) / 200)
**ext_grid_size** (float, 1.0) - Relative size of ext_grids to plot.
See bus sizes for details. Note: ext_grids are plottet as rectangles
**switch_size** (float, 1.0) - Relative size of switches to plot. See bus size for details
**switch_distance** (float, 1.0) - Relative distance of the switch to its corresponding \
bus. See bus size for details
**plot_line_switches** (bool, False) - Flag if line switches are plotted
**scale_size** (bool, True) - Flag if bus_size, ext_grid_size, bus_size- and distance \
will be scaled with respect to grid mean distances
**bus_color** (String, colors[0]) - Bus Color. Init as first value of color palette.
Usually colors[0] = "b".
**line_color** (String, 'grey') - Line Color. Init is grey
**trafo_color** (String, 'k') - Trafo Color. Init is black
**ext_grid_color** (String, 'y') - External Grid Color. Init is yellow
**switch_color** (String, 'k') - Switch Color. Init is black
**plot_show** (bool, True) - Shows plot at the end of plotting
OUTPUT:
**ax** - axes of figure
"""
# don't hide lines if switches are plotted
if plot_line_switches:
respect_switches = False
# create geocoord if none are available
if len(net.line_geodata) == 0 and len(net.bus_geodata) == 0:
logger.warning(
"No or insufficient geodata available --> Creating artificial coordinates."
+ " This may take some time")
create_generic_coordinates(net,
respect_switches=respect_switches,
library=library)
if scale_size:
# if scale_size -> calc size from distance between min and max geocoord
mean_distance_between_buses = sum(
(net['bus_geodata'].max() - net['bus_geodata'].min()) / 200)
# set the bus / ext_grid sizes accordingly
# Comment: This is implemented because if you would choose a fixed values
# (e.g. bus_size = 0.2), the size
# could be to small for large networks and vice versa
bus_size *= mean_distance_between_buses
ext_grid_size *= mean_distance_between_buses * 1.5
switch_size *= mean_distance_between_buses * 1
switch_distance *= mean_distance_between_buses * 2
# create bus collections to plot
bc = create_bus_collection(net,
net.bus.index,
size=bus_size,
color=bus_color,
zorder=10)
# if bus geodata is available, but no line geodata
use_bus_geodata = len(net.line_geodata) == 0
in_service_lines = net.line[net.line.in_service].index
nogolines = set(net.switch.element[(net.switch.et == "l") & (net.switch.closed == 0)]) \
if respect_switches else set()
plot_lines = in_service_lines.difference(nogolines)
# create line collections
lc = create_line_collection(net,
plot_lines,
color=line_color,
linewidths=line_width,
use_bus_geodata=use_bus_geodata)
collections = [bc, lc]
# create ext_grid collections
eg_buses_with_geo_coordinates = set(net.ext_grid.bus.values) & set(
net.bus_geodata.index)
if len(eg_buses_with_geo_coordinates) > 0:
sc = create_bus_collection(net,
eg_buses_with_geo_coordinates,
patch_type="rect",
size=ext_grid_size,
color=ext_grid_color,
zorder=11)
collections.append(sc)
# create trafo collection if trafo is available
trafo_buses_with_geo_coordinates = [
t for t, trafo in net.trafo.iterrows()
if trafo.hv_bus in net.bus_geodata.index
and trafo.lv_bus in net.bus_geodata.index
]
if len(trafo_buses_with_geo_coordinates) > 0:
tc = create_trafo_collection(net,
trafo_buses_with_geo_coordinates,
color=trafo_color)
collections.append(tc[0])
collections.append(tc[1])
# create trafo3w collection if trafo3w is available
trafo3w_buses_with_geo_coordinates = [
t for t, trafo3w in net.trafo3w.iterrows()
if trafo3w.hv_bus in net.bus_geodata.index and trafo3w.mv_bus in
net.bus_geodata.index and trafo3w.lv_bus in net.bus_geodata.index
]
if len(trafo3w_buses_with_geo_coordinates) > 0:
tc = create_trafo3w_collection(net,
trafo3w_buses_with_geo_coordinates,
color=trafo_color)
collections.append(tc[0])
collections.append(tc[1])
if plot_line_switches and len(net.switch):
sc = create_line_switch_collection(
net,
size=switch_size,
distance_to_bus=switch_distance,
use_line_geodata=not use_bus_geodata,
zorder=12,
color=switch_color)
collections.append(sc)
ax = draw_collections(collections)
if show_plot:
plt.show()
return ax
def simple_plot(net=None,
respect_switches=False,
line_width=1.0,
bus_size=1.0,
ext_grid_size=1.0,
bus_color=colors[0],
line_color='grey',
trafo_color='g',
ext_grid_color='y'):
"""
Plots a pandapower network as simple as possible. If no geodata is available, artificial geodata is generated. For advanced plotting see the tutorial
INPUT:
**net** - The pandapower format network. If none is provided, mv_oberrhein() will be plotted as an example
OPTIONAL:
**respect_switches** (bool, False) - Respect switches when artificial geodata is created
**line_width** (float, 1.0) - width of lines
**bus_size** (float, 1.0) - Relative size of buses to plot.
The value bus_size is multiplied with mean_distance_between_buses, which equals the distance between
the max geoocord and the min divided by 200.
mean_distance_between_buses = sum((net['bus_geodata'].max() - net['bus_geodata'].min()) / 200)
**ext_grid_size** (float, 1.0) - Relative size of ext_grids to plot.
See bus sizes for details. Note: ext_grids are plottet as rectangles
**bus_color** (String, colors[0]) - Bus Color. Init as first value of color palette. Usually colors[0] = "b".
**line_color** (String, 'grey') - Line Color. Init is grey
**trafo_color** (String, 'g') - Trafo Color. Init is green
**ext_grid_color** (String, 'y') - External Grid Color. Init is yellow
"""
if net is None:
import pandapower.networks as nw
logger.warning(
"No pandapower network provided -> Plotting mv_oberrhein")
net = nw.mv_oberrhein()
# create geocoord if none are available
if len(net.line_geodata) == 0 and len(net.bus_geodata) == 0:
logger.warning(
"No or insufficient geodata available --> Creating artificial coordinates."
+ " This may take some time")
create_generic_coordinates(net, respect_switches=respect_switches)
if bus_size or ext_grid_size is None:
# if either bus_size or ext_grid size is None -> calc size from distance between min and
# max geocoord
mean_distance_between_buses = sum(
(net['bus_geodata'].max() - net['bus_geodata'].min()) / 200)
# set the bus / ext_grid sizes accordingly
# Comment: This is implemented because if you would choose a fixed values
# (e.g. bus_size = 0.2), the size
# could be to small for large networks and vice versa
bus_size *= mean_distance_between_buses
ext_grid_size *= mean_distance_between_buses * 1.5
# if bus geodata is available, but no line geodata
use_line_geodata = False if len(net.line_geodata) == 0 else True
# create bus collections ti plot
bc = create_bus_collection(net,
net.bus.index,
size=bus_size,
color=bus_color,
zorder=10)
lc = create_line_collection(net,
net.line.index,
color=line_color,
linewidths=line_width,
use_line_geodata=use_line_geodata)
collections = [bc, lc]
eg_buses_with_geocoordinates = set(net.ext_grid.bus.values) & set(
net.bus_geodata.index)
if len(eg_buses_with_geocoordinates) > 0:
sc = create_bus_collection(net,
eg_buses_with_geocoordinates,
patch_type="rect",
size=ext_grid_size,
color=ext_grid_color,
zorder=11)
collections.append(sc)
# create trafo collection if trafo is available
trafo_buses_with_geocoordinates = [t for t, trafo in net.trafo.iterrows() \
if trafo.hv_bus in net.bus_geodata.index \
and trafo.lv_bus in net.bus_geodata.index]
if len(trafo_buses_with_geocoordinates) > 0:
tc = create_trafo_collection(net,
trafo_buses_with_geocoordinates,
color=trafo_color)
collections.append(tc)
draw_collections(collections)
plt.show()