Skip to content

rencal.models.base

rencal.models.base defines abstract and concrete base classes for pandas/xarray-backed dataset models and schema validation.

These Pydantic-backed models are the primary typed data contract returned by LocalDataLoader.

class DatasetModel(BaseModel, ABC): DatasetModel

Abstract base model for shared metadata and conversion/validation contracts.

Returns DatasetModel

class PandasDatasetModel(DatasetModel): PandasDatasetModel

Concrete validation mixin for pandas DataFrame-backed models.

Returns PandasDatasetModel

class XArrayDatasetModel(DatasetModel): XArrayDatasetModel

Concrete validation mixin for xarray Dataset-backed models.

Returns XArrayDatasetModel

_validate_required_columns(data: Any) -> Any

Abstract required-columns/variables validation contract.

_validate_datatypes(data: Any) -> Any

Abstract datatype validation contract.

_validate_time_column(data: Any) -> Any

Abstract time column/dimension validation contract.

to_pandas() -> pd.DataFrame

Abstract conversion contract to pandas DataFrame.

to_xarray() -> xr.Dataset

Abstract conversion contract to xarray Dataset.

PandasDatasetModel._validate_required_columns

Section titled “PandasDatasetModel._validate_required_columns”
_validate_required_columns(data: pd.DataFrame) -> pd.DataFrame

Checks configured required columns exist in DataFrame.

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

Checks configured dtype expectations for DataFrame columns.

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

Validates configured time column existence/type/null/emptiness checks.

XArrayDatasetModel._validate_required_columns

Section titled “XArrayDatasetModel._validate_required_columns”
_validate_required_columns(data: xr.Dataset) -> xr.Dataset

Checks configured required variables in xarray dataset.

_validate_datatypes(data: xr.Dataset) -> xr.Dataset

Validates configured variable dtypes in xarray dataset.

_validate_time_column(data: xr.Dataset) -> xr.Dataset

Validates time dimension/coordinate presence, datetime type, duplicates, and sort order.