Source code for nwm_region_mgr.parreg.pairer

"""Base model of Pairer for donor-receiver pairing."""

import pandas as pd
from pydantic import BaseModel, ConfigDict, Field




class Pairer(BaseModel):
    """Base Pairer."""

    model_config = ConfigDict(arbitrary_types_allowed=True)

    config: dict
    """Configuration for the Pairer."""

    div_col: str = Field(
        default="div_id", description="Column name for divide (catchment) ID."
    )

    df_attr_all: pd.DataFrame
    """DataFrame containing attributes for all donors and receivers."""

    dist_spatial: pd.DataFrame
    """DataFrame containing spatial distances between donors and receivers."""