cronian.DERs.vre_generator
==========================

.. py:module:: cronian.DERs.vre_generator

.. autoapi-nested-parse::

   Model of a prosumer's variable renewable energy generator.



Functions
---------

.. autoapisummary::

   cronian.DERs.vre_generator.add_vre_generator_to_model


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

.. py:function:: add_vre_generator_to_model(model: pyomo.environ.AbstractModel, prosumer: dict, asset_name: str, timeseries_data: pandas.DataFrame, number_of_timesteps: int | None) -> pyomo.environ.AbstractModel

   Add a prosumer's VRE generator to the optimization model.

   This includes any renewable energy source that is variable in nature with an
   arbitrary carrier: wind, solar_pv, geothermal, solar thermal, etc.

   Args:
       model: Pyomo model to which a prosumer's VRE generator will be added.
       prosumer: Dictionary containing prosumer details.
       asset_name: Name of the VRE generator asset.
       timeseries_data: Timeseries data containing the availability factors.
       number_of_timesteps: Number of timesteps to run the optimization for.
       asset_name: Name of the VRE generator asset.

   Returns:
       model: AbstractModel with the added VRE generator.

   Raises:
       KeyError: If a required asset parameter is missing