cronian.generators
==================

.. py:module:: cronian.generators

.. autoapi-nested-parse::

   This builds all generator agents at once.

   Unlike build_prosumer function that builds a single prosumer agent at a time.
   This is because the focus of DEMOSES is on modeling prosumers in detail.
   Moreover, generator agents here are all modeled with a similar structure and
   only differ in their parameters.



Functions
---------

.. autoapisummary::

   cronian.generators.add_all_generators


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

.. py:function:: add_all_generators(model: pyomo.environ.AbstractModel, generator_agents: dict, timeseries_data: pandas.DataFrame) -> pyomo.environ.AbstractModel

   Build and add all generator agents' to the optimization model.

   Args:
       model: Pyomo AbstractModel to which generators are added.
       generator_agents: Dictionary containing generator agents' details.
       timeseries_data: Timeseries data containing the availability factors for
           VRE generators and EVs doing V2G, demand profiles for prosumers, ...

   Returns:
       Pyomo AbstractModel with generators added.