annular.utils
=============

.. py:module:: annular.utils


Functions
---------

.. autoapisummary::

   annular.utils.read_csv_with_utc_timestamps
   annular.utils.patch_expected_price


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

.. py:function:: read_csv_with_utc_timestamps(path: pathlib.Path | str) -> pandas.DataFrame

   Load a CSV file, using column 0 as index, and converting the index to UTC timestamps.

   :param path: Path to the CSV file.

   :returns: DataFrame of the CSV file with index as UTC timestamps.


.. py:function:: patch_expected_price(base_forecast: pandas.DataFrame, horizon: pandas.Index, forecast: pandas.DataFrame) -> list[float]

   Create a list of expected prices.

   For the specified horizon, replaces the base forecast with the given forecast.

   :param base_forecast: The base forecast.
   :param horizon: Time horizon to use.
   :param forecast: Dataframe with to-be-used forecast.

   :returns: A list of expected prices.