ShuntImpedances dataclass

ShuntImpedances(
    ctype: ComponentType,
    n: Network | None = None,
    names: str | int | Sequence[int | str] | None = None,
    suffix: str = "",
)

Bases: Components

Shunt impedances components class.

This class is used for shunt impedance components. All functionality specific to shunt impedances is implemented here. Functionality for all components is implemented in the abstract base class.

See Also

pypsa.Components

Examples:

>>> n.components.shunt_impedances
Empty 'ShuntImpedance' Components

Methods:

• add –

  Wrap Components.add() and docstring is patched via decorator.

pypsa.components.ShuntImpedances.add

add(
    name: str | int | Sequence[int | str],
    suffix: str = "",
    overwrite: bool = False,
    return_names: bool | None = None,
    **kwargs: Any,
) -> Index | None

Wrap Components.add() and docstring is patched via decorator.