:py:mod:`eelib.data.dataclass.series`
=====================================

.. py:module:: eelib.data.dataclass.series

.. autoapi-nested-parse::

   Dataclasses for tariffs and market data used in eELib.

   | Author: elenia@TUBS
   | Copyright 2025 elenia
   | This file is part of eELib, which is free software under the terms of the GNU GPL Version 3.



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

Classes
~~~~~~~

.. autoapisummary::

   eelib.data.dataclass.series.SeriesData




Attributes
~~~~~~~~~~

.. autoapisummary::

   eelib.data.dataclass.series._logger


.. py:data:: _logger

   

.. py:class:: SeriesData


   Bases: :py:obj:`eelib.data.dataclass.BaseData`

   Dataclass for Series Data.

   .. attribute:: start_timestep

      The start sim step for the data.

      :type: int | None

   .. attribute:: n_steps

      The number of steps in the data.

      :type: int | None

   .. attribute:: resolution

      The resolution of the series data in seconds.

      :type: int | None

   .. attribute:: values

      A list of int | float values.

      :type: list[int | float]

   .. py:method:: get_index(timestep: int, sim_resolution: int) -> int

      Get the index of the given timestep in the series data.

      :param timestep: The timestep to find in the series data.
      :type timestep: int
      :param sim_resolution: The resolution of the simulation in seconds.
      :type sim_resolution: int

      :returns: The index of the timestep in the series data.
      :rtype: int


   .. py:method:: reduce(timestep: int, sim_resolution: int) -> None

      Reduce the series data to the given time.

      :param timestep: The timestep to reduce the series data to.
      :type timestep: int
      :param sim_resolution: The resolution of the simulation in seconds.
      :type sim_resolution: int


   .. py:method:: resample(target_resolution: int) -> None

      Resample the series to fit target_resolution
      Limited to mean agg function -> power, prices
      Not suitable for energy.

      :param target_resolution: the target resolution for resampling
      :type target_resolution: int

      :raises NotImplementedError: fractional resampling factors not supported