common

General utility functions for PyPSA components.

Functions:

• as_components –

  Get component instance from string.

pypsa.components.common.as_components

as_components(
    n: NetworkType, value: str | Components
) -> Components

Get component instance from string.

v0.33.0

E.g. pass 'Generator', 'generators' or Components class instance to get the corresponding Components class instance.

Parameters:

• value (str | Components) –

  String or Components class instance.

• n (Network) –

  Network instance to which the components are attached.

Returns:

• Components –

  Components class instance.

Examples:

>>> # Get generators component from string
>>> generators = pypsa.components.common.as_components(n, 'generators')
>>> generators.name
'Generator'

>>> # Also works with singular form
>>> gen = pypsa.components.common.as_components(n, 'Generator')
>>> gen.name
'Generator'