pypsa.statistics.StatisticsAccessor.revenue

pypsa.statistics.StatisticsAccessor.revenue#

StatisticsAccessor.revenue(comps: str | Sequence[str] | None = None, aggregate_time: str | bool = 'sum', aggregate_groups: Callable | str = 'sum', aggregate_across_components: bool = False, groupby: str | Sequence[str] | Callable = 'carrier', at_port: bool | str | Sequence[str] = True, bus_carrier: str | Sequence[str] | None = None, nice_names: bool | None = None, kind: str | None = None) DataFrame#

Calculate the revenue of components in the network in given currency. The revenue is defined as the net revenue of an asset, i.e cost of input - revenue of output. If kind is set to “input” or “output” only the revenue of the input or output is considered.

If bus_carrier is given, only the revenue resulting from buses with carrier bus_carrier is considered.

For information on the list of arguments, see the docs in Network.statistics or pypsa.statistics.StatisticsAccessor.

Parameters:
  • aggregate_time (str, bool, optional) – Type of aggregation when aggregating time series. Note that for {‘mean’, ‘sum’} the time series are aggregated to using snapshot weightings. With False the time series is given in currency/hour. Defaults to ‘sum’.

  • kind (str, optional) – Type of revenue to consider. If ‘input’ only the revenue of the input is considered. If ‘output’ only the revenue of the output is considered. Defaults to None.