rencal.models.generation_model
rencal.models.generation_model defines the validated generation dataset model for time-indexed plant output.
Constructor
Section titled “Constructor”GenerationDatasetModel
Section titled “GenerationDatasetModel”class GenerationDatasetModel(PandasDatasetModel): GenerationDatasetModelDataset model for generation/settlement time series.
Required Columns plant_id, time, quantity
Returns GenerationDatasetModel
Methods
Section titled “Methods”GenerationDatasetModel.validate_data
Section titled “GenerationDatasetModel.validate_data”validate_data(data: pd.DataFrame) -> pd.DataFrameValidates required columns, dtypes, and time column.
Returns pd.DataFrame
GenerationDatasetModel.get_plant_ids
Section titled “GenerationDatasetModel.get_plant_ids”get_plant_ids() -> list[str]Returns unique plant IDs.
Returns list[str]
GenerationDatasetModel.get_time_range
Section titled “GenerationDatasetModel.get_time_range”get_time_range() -> dict[str, Any] | NoneReturns start/end/period summary for time column.
Returns dict[str, Any] | None
GenerationDatasetModel.filter_by_plant_id
Section titled “GenerationDatasetModel.filter_by_plant_id”filter_by_plant_id(plant_id: str) -> GenerationDatasetModelFilters 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) -> GenerationDatasetModelFilters rows by inclusive date range.
Returns GenerationDatasetModel
Raises
ValueError: If date column is not found.
GenerationDatasetModel.to_pandas
Section titled “GenerationDatasetModel.to_pandas”to_pandas() -> pd.DataFrameReturns DataFrame copy.
Returns pd.DataFrame
GenerationDatasetModel.to_xarray
Section titled “GenerationDatasetModel.to_xarray”to_xarray() -> xr.DatasetConverts DataFrame to xarray dataset.
Returns xr.Dataset

