GloFASRiverDataset

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

River discharge dataset from GloFAS v4.0.

Expects a NetCDF file preprocessed using the GloFAS Large-scale Drainage Direction (LDD) algorithm, which places river mouths on coastal cells. Time is encoded as CF-compliant datetime64 and decoded directly.

Variable name mappings:

• latitude: lat_mou

• longitude: lon_mou

• flux: FLOW (m³/s)

• ratio: ratio_m2s

• name: riv_name

Methods

GloFASRiverDataset.add_time_info(ds)

Time is CF-compliant datetime64 — decode directly.

Attributes

GloFASRiverDataset.COAST_SNAP_BUFFER_KM
GloFASRiverDataset.DOMAIN_EDGE_BUFFER
GloFASRiverDataset.name_prefix	Prefix prepended to GloFAS river names, stripped back off when naming synthetic overlap_ rivers.
GloFASRiverDataset.dim_names
GloFASRiverDataset.var_names
GloFASRiverDataset.opt_var_names
GloFASRiverDataset.filename
GloFASRiverDataset.start_time
GloFASRiverDataset.end_time
GloFASRiverDataset.ds