annular.market
==============

.. py:module:: annular.market


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/annular/market/base/index
   /autoapi/annular/market/tulipa/index


Attributes
----------

.. autoapisummary::

   annular.market.market_models


Functions
---------

.. autoapisummary::

   annular.market.run_base
   annular.market.run_tulipa


Package Contents
----------------

.. py:function:: run_base(bids: pandas.DataFrame, generator_configs: dict[str, dict], timeseries_data: pandas.DataFrame, snapshots: pandas.DatetimeIndex, output_path: pathlib.Path) -> tuple[numpy.ndarray, numpy.ndarray]

   Run market model.


.. py:function:: run_tulipa(bids: pandas.DataFrame, timeseries_data: pandas.DataFrame, snapshots: pandas.DatetimeIndex, bidding_window: pandas.DatetimeIndex, output_path: pathlib.Path, iteration_id: int, config: dict) -> tuple[numpy.ndarray, numpy.ndarray]

   Create the central market clearing model.

   :param bids: MultiIndex DataFrame of bids for all satellites.
   :param timeseries_data: DataFrame with timeseries_data for entire simulation time.
   :param snapshots: Optimization window of the market model.
   :param bidding_window: Bidding window that matters for bids.
   :param output_path: Path to store the database file with the solved `TulipaEnergyModel`.
                       The file is named `tulipa_iteration-ID.duckdb` where `ID` is
                       the iteration ID (starting at 0).
   :param iteration_id: Identifier of the iteration number. Used internally to
                        manage folder names.
   :param config: config dict

   :returns: market clearing price and quantities allocated by the market.
   :rtype: tuple

   :raises ValueError: If Tulipa configuration is incomplete.
   :raises RuntimeError: - if Tulipa cofiguration caused other problems
       - if the optimization problem is infeasible or unbounded


.. py:data:: market_models