eelib.data.dataclass.series

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

SeriesData

Dataclass for Series Data.

Attributes

_logger

_logger

class SeriesData

Bases: eelib.data.dataclass.BaseData

Dataclass for Series Data.

start_timestep

The start sim step for the data.

Type:

int | None

n_steps

The number of steps in the data.

Type:

int | None

resolution

The resolution of the series data in seconds.

Type:

int | None

values

A list of int | float values.

Type:

list[int | float]

get_index(timestep: int, sim_resolution: int) → int

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

Parameters:

• timestep (int) – The timestep to find in the series data.

• sim_resolution (int) – The resolution of the simulation in seconds.

Returns:

The index of the timestep in the series data.

Return type:

int

reduce(timestep: int, sim_resolution: int) → None

Reduce the series data to the given time.

Parameters:

• timestep (int) – The timestep to reduce the series data to.

• sim_resolution (int) – The resolution of the simulation in seconds.

resample(target_resolution: int) → None

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

Parameters:

target_resolution (int) – the target resolution for resampling

Raises:

NotImplementedError – fractional resampling factors not supported