hydrotools.nwm_client.NWMFileProcessor module

NWM File Processor

Tools for processing NWM data in NetCDF (.nc) format.

Classes

NWMFileProcessor

class hydrotools.nwm_client.NWMFileProcessor.NWMFileProcessor

Bases: object

Provides a concrete interface for methods used to process National Water Model data from NetCDF (.nc) format to xarray.Dataset, dask.dataframe.Dataframe, or pandas.DataFrame.

classmethod convert_to_dask_dataframe(ds: Dataset) → DataFrame

Generate a dask.dataframe.DataFrame from an xarray.Dataset.

Parameters:

ds (xarray.Dataset, required) – xarray.Dataset containing National Water Model data.

Return type:

dask.dataframe.DataFrame of NWM data.

classmethod convert_to_dataframe(ds: Dataset) → DataFrame

Generate a pandas.DataFrame from an xarray.Dataset.

Parameters:

ds (xarray.Dataset, required) – xarray.Dataset containing National Water Model data.

Return type:

pandas.DataFrame of NWM data.

classmethod get_dataset(paths: str | ~numpy._typing._array_like._SupportsArray[~numpy.dtype[~typing.Any]] | ~numpy._typing._nested_sequence._NestedSequence[~numpy._typing._array_like._SupportsArray[~numpy.dtype[~typing.Any]]] | bool | int | float | complex | bytes | ~numpy._typing._nested_sequence._NestedSequence[bool | int | float | complex | str | bytes], feature_id_filter: ~numpy._typing._array_like._SupportsArray[~numpy.dtype[~typing.Any]] | ~numpy._typing._nested_sequence._NestedSequence[~numpy._typing._array_like._SupportsArray[~numpy.dtype[~typing.Any]]] | bool | int | float | complex | str | bytes | ~numpy._typing._nested_sequence._NestedSequence[bool | int | float | complex | str | bytes] = Index([800010123, 800012331, 800005662, 800006277, 800009690, 800015240,        800016809, 800001894, 800005664, 800006488,        ...         41028035,  41028026,  41025904,  15489152,  41022861,  41022723,         15465127,  15456882,  15476223,  15448784],       dtype='int64', name='nwm_feature_id', length=8866), variables: ~typing.List[str] = ['streamflow']) → Dataset

Generate an xarray.Dataset from an input directory of NWM .nc files.

Parameters:

  • paths (str or array-like of paths, required) – Glob string or array-like of paths passed directly to xarray.open_mfdataset

  • feature_id_filter (array-like, optional) – Subset of feature IDs to return. Defaults to USGS assimilation locations.

  • variables (list of str, optional, default ["streamflow"]) – List of variables to retrieve from source files. Options include: ‘streamflow’, ‘nudge’, ‘velocity’, ‘qSfcLatRunoff’, ‘qBucket’, ‘qBtmVertRunoff’

Return type:

xarray.Dataset of paths lazily loaded.