Skip to content

rencal.models.generation_model

rencal.models.generation_model defines the validated generation dataset model for time-indexed plant output.

class GenerationDatasetModel(PandasDatasetModel): GenerationDatasetModel

Dataset model for generation/settlement time series.

Required Columns plant_id, time, quantity

Returns GenerationDatasetModel

validate_data(data: pd.DataFrame) -> pd.DataFrame

Validates required columns, dtypes, and time column.

Returns pd.DataFrame

get_plant_ids() -> list[str]

Returns unique plant IDs.

Returns list[str]

get_time_range() -> dict[str, Any] | None

Returns start/end/period summary for time column.

Returns dict[str, Any] | None

filter_by_plant_id(plant_id: str) -> GenerationDatasetModel

Filters rows for a single plant ID.

Returns GenerationDatasetModel

GenerationDatasetModel.filter_by_date_range

Section titled “GenerationDatasetModel.filter_by_date_range”
filter_by_date_range(start_date: str, end_date: str, date_col: str | None = None) -> GenerationDatasetModel

Filters rows by inclusive date range.

Returns GenerationDatasetModel

Raises

  • ValueError: If date column is not found.
to_pandas() -> pd.DataFrame

Returns DataFrame copy.

Returns pd.DataFrame

to_xarray() -> xr.Dataset

Converts DataFrame to xarray dataset.

Returns xr.Dataset