finesse.model.Model.get_network¶

Model.get_network(network_type: str | finesse.utilities.network_filter.NetworkType = NetworkType.FULL, add_edge_info=False) → Graph[source]¶

Get specified network.

Parameters

network_typestr, optional: The network type to export: full (nodes, ports and components), “components” (just components), or “optical” (the optical subnetwork).

Returns

networkx.DiGraph: The network.

Raises

ValueError: If the specified network_type is unknown.