cronian.base_model
==================

.. py:module:: cronian.base_model

.. autoapi-nested-parse::

   Create the base model to which all generators, prosumers, constraints, and the objective function will be added.



Functions
---------

.. autoapisummary::

   cronian.base_model.create_optimization_model


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

.. py:function:: create_optimization_model(base_load: pandas.Series | None, price_timeseries: pandas.DataFrame, number_of_timesteps: int | None) -> pyomo.environ.AbstractModel

   Create optimization model with common parameters.

   Args:
       base_load: pd.Series of Base load from passive consumers.
       price_timeseries: Dataframe containing the prices of energy carriers.
       number_of_timesteps: Number of timesteps to run the optimization for.

   Returns:
       Abstract Pyomo model with general parameters.