pypsa.SubNetwork.branches_i

SubNetwork.branches_i(active_only: bool = False) → MultiIndex

Get the index of the branches in the sub-network.

Parameters:

active_only (bool, default False) – If True, only return the index of the active branches.

Returns:

The index of the branches in the sub-network.

Return type:

pd.MultiIndex

Examples

>>> sub_network.branches_i()
MultiIndex([('Line', '0'),
            ('Line', '1'),
            ('Line', '5')],
            names=['type', 'name'])