plot_network_jupyter

openpnm.topotools.plot_network_jupyter(network, node_color=0, edge_color=0, node_size=1, node_scale=20, edge_scale=5, colormap='viridis')[source]

Visualize a network in 3D using Plotly.

The pores and throats are scaled and colored by their properties. The final figure can be rotated and zoomed.

Parameters
  • network (GenericNetwork) – The network to visualize

  • node_color (ndarray) – An array of values used for coloring the pores. If not given, the lowest value of the employed colormap is assigned to all markers.

  • edge_color (ndarray) – An array of values used for coloring the throats. If not given, the lowest value of the employed colormap is assigned to all lines.

  • node_size (ndarray) – An array of values controlling the size of the markers. If not given all markers will be the same size

  • node_scale (scalar) – A scaler to resize the markers

  • edge_scale (scalar) – A scaler to the line thickness

  • colormap (str) – The colormap to use

Returns

fig – The graph object containing the generated plots. The object has several useful methods.

Return type

Plotly graph object

Notes

Important

a) This does not work in Spyder. It should only be called from a Jupyter Notebook.

b) This is only meant for relatively small networks. For proper visualization use Paraview.