:py:mod:`eelib.data.dataclass.tariff`
=====================================

.. py:module:: eelib.data.dataclass.tariff

.. autoapi-nested-parse::

   Dataclasses for tariffs and market data used in eELib.

   | Author: elenia@TUBS
   | Copyright 2024 elenia
   | This file is part of eELib, which is free software under the terms of the GNU GPL Version 3.



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   eelib.data.dataclass.tariff.MarketData
   eelib.data.dataclass.tariff.Tariff
   eelib.data.dataclass.tariff.TariffSignal
   eelib.data.dataclass.tariff.GridTariff
   eelib.data.dataclass.tariff.GridTariffSignal




.. py:class:: MarketData


   Bases: :py:obj:`eelib.data.dataclass._base.BaseData`

   Dataclass for Market Data.

   price_weighted_avg (float): weighted average price
   price_low (float): lowest market price
   price_high (float): highest market price
   price_last (float): last market price

   .. py:attribute:: price_weighted_avg
      :type: float

      

   .. py:attribute:: price_low
      :type: float

      

   .. py:attribute:: price_high
      :type: float

      

   .. py:attribute:: price_last
      :type: float

      


.. py:class:: Tariff


   Bases: :py:obj:`eelib.data.dataclass._base.BaseData`

   Dataclass for Prosumer Tariff.

   elec_price (float): electricity consumption price info [EUR/kWh]. Defaults to 35ct/kWh
   feedin_tariff (float): electricity feed-in price info [EUR/kWh]. Defaults to 7ct/kWh
   capacity_fee_dem (float): Price for max. power demand at connection [EUR/kW]. Defaults to 0
   capacity_fee_gen (float): Price for max. power generation at connection [EUR/kW]. Defaults to 0
   capacity_fee_horizon_sec (int): Horizon for capacity fee [seconds]. Defaults to 86400 (1 day)

   .. py:attribute:: elec_price
      :type: float

      

   .. py:attribute:: feedin_tariff
      :type: float

      

   .. py:attribute:: capacity_fee_dem
      :type: float

      

   .. py:attribute:: capacity_fee_gen
      :type: float

      

   .. py:attribute:: capacity_fee_horizon_sec
      :type: int

      


.. py:class:: TariffSignal


   Bases: :py:obj:`eelib.data.dataclass._base.BaseData`

   Dataclass for Tariff that is sent as a Signal to a Household.

   bool_is_list (bool): Whether signal is for multi-step tariff. Defaults to False
   elec_price (float, list): electricity consumption price info [EUR/kWh]. Defaults to 0.35
   feedin_tariff (float, list): electricity feed-in price info [EUR/kWh]. Defaults to 0.07
   steps (list): timesteps for the corresponding list of prices. Defaults to empty list
   capacity_fee_dem (float): Price for max. power demand at connection [EUR/kW]. Defaults to 0
   capacity_fee_gen (float): Price for max. power generation at connection [EUR/kW]. Defaults to 0
   capacity_fee_horizon_sec (int): Horizon for capacity fee [seconds]. Defaults to 86400 (1 day)

   .. py:attribute:: bool_is_list
      :type: bool

      

   .. py:attribute:: elec_price
      :type: float | list

      

   .. py:attribute:: feedin_tariff
      :type: float | list

      

   .. py:attribute:: steps
      :type: list

      

   .. py:attribute:: capacity_fee_dem
      :type: float

      

   .. py:attribute:: capacity_fee_gen
      :type: float

      

   .. py:attribute:: capacity_fee_horizon_sec
      :type: int

      


.. py:class:: GridTariff


   Bases: :py:obj:`eelib.data.dataclass._base.BaseData`

   Dataclass for Grid Usage Fees.

   grid_tariff_model (str): which control model is selected for households. Defaults to "flat-rate"
   energy_price (float): Energy-dependent price for electr. consump. [EUR/kWh]. Defaults to 8ct/kWh
   capacity_fee_dem (float): Price for max. power demand at connection [EUR/kW]. Defaults to 0
   capacity_fee_gen (float): Price for max. power generation at connection [EUR/kW]. Defaults to 0
   capacity_fee_horizon_sec (int): Horizon for capacity fee [seconds]. Defaults to 86400 (1 day)

   .. py:attribute:: grid_tariff_model
      :type: str

      

   .. py:attribute:: energy_price
      :type: float

      

   .. py:attribute:: capacity_fee_dem
      :type: float

      

   .. py:attribute:: capacity_fee_gen
      :type: float

      

   .. py:attribute:: capacity_fee_horizon_sec
      :type: int

      


.. py:class:: GridTariffSignal


   Bases: :py:obj:`eelib.data.dataclass._base.BaseData`

   Dataclass for Signal regarding Grid Usage Fees.

   bool_is_list (bool): Whether signal is for multi-step tariff. Defaults to False
   energy_price (float, list): Energy-dependent price for el. cons. [EUR/kWh]. Defaults to 8ct/kWh
   steps (list): timesteps for the corresponding list of prices. Defaults to empty list
   capacity_fee_dem (float): Price for max. power demand at connection [EUR/kW]. Defaults to 0
   capacity_fee_gen (float): Price for max. power generation at connection [EUR/kW]. Defaults to 0
   capacity_fee_horizon_sec (int): Horizon for capacity fee [seconds]. Defaults to 86400 (1 day)

   .. py:attribute:: bool_is_list
      :type: bool

      

   .. py:attribute:: energy_price
      :type: float | list

      

   .. py:attribute:: steps
      :type: list

      

   .. py:attribute:: capacity_fee_dem
      :type: float

      

   .. py:attribute:: capacity_fee_gen
      :type: float

      

   .. py:attribute:: capacity_fee_horizon_sec
      :type: int