DaiRiverDataset

Contents

DaiRiverDataset#

class roms_tools.datasets.river_datasets.DaiRiverDataset(*, filename: str | Path | list[str | Path] = <factory>, COAST_SNAP_BUFFER_KM: float = 200.0, DOMAIN_EDGE_BUFFER: int = 20, start_time: datetime, end_time: datetime, dim_names: dict[str, str]=<factory>, var_names: dict[str, str]=<factory>, opt_var_names: dict[str, str]=<factory>, climatology: bool = False)#

River discharge dataset from Dai & Trenberth (2009).

Provides monthly climatological or time-varying discharge for ~1000 of the world’s largest rivers. Time is encoded as numeric YYYYMM values and decoded manually in add_time_info. River mouths may be placed inland, so a generous coastal snap buffer (200 km default) is used.

Methods

DaiRiverDataset.add_time_info(ds)

Adds time information to the dataset based on the climatology flag and dimension names.

DaiRiverDataset.load_data()

Load dataset from the specified file.

Attributes

DaiRiverDataset.COAST_SNAP_BUFFER_KM

DaiRiverDataset.DOMAIN_EDGE_BUFFER

DaiRiverDataset.climatology

DaiRiverDataset.name_prefix

Prefix prepended to Dai river names.

DaiRiverDataset.filename

DaiRiverDataset.dim_names

DaiRiverDataset.var_names

DaiRiverDataset.opt_var_names

DaiRiverDataset.start_time

DaiRiverDataset.end_time

DaiRiverDataset.ds