cronian.all_assets
==================

.. py:module:: cronian.all_assets

.. autoapi-nested-parse::

   Function to add prosumers' assets to the optimization model.



Functions
---------

.. autoapisummary::

   cronian.all_assets.add_prosumer_assets_to_model


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

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

   Add prosumer's assets to the optimization model.

   Args:
       model: AbstractModel to which the prosumer's asset will be added.
       prosumer: Dictionary describing the prosumer's attributes.
       timeseries_data: Timeseries data containing the availability factors for
           VRE generators and EVs doing V2G, demand profiles for prosumers, ...
       number_of_timesteps: Number of timesteps to run the optimization for.
       storage_model: Type of storage model to use: `simple` or `complex`.

   Returns:
       Pyomo AbstractModel with the prosumer's assets added to it.