rating_gp.providers.usgs

rating_gp.providers.usgs#

Helper functions for pulling USGS data.

Functions

get_daily_stage(site, start_date, end_date)

Get daily data from the USGS NWIS API.

get_measurements(site, start_date, end_date)

Get discharge measurements from the USGS NWIS API.

read_measurements_df(df)

Read a DataFrame of USGS discharge measurements and convert to xarray Dataset.

Classes

NWISColumn(column_name, standard_name[, ...])

USGSParameter(pcode, standard_name[, ...])

class rating_gp.providers.usgs.NWISColumn(column_name: 'str', standard_name: 'str', long_name: '[Optional[str]]' = None, units: '[Optional[str]]' = None, conversion: 'float' = 1.0)#
property name#

Alias for standard_name.

class rating_gp.providers.usgs.USGSParameter(pcode: 'str', standard_name: 'str', long_name: 'Optional[str]' = '', units: 'Optional[str]' = '', suffix: 'Optional[str]' = '', conversion: 'Optional[float]' = 1.0)#
property name#

Alias for standard_name.

property ppcode#

Return the parameter code with a ‘p’ prefix, which is used by the QWData service.

rating_gp.providers.usgs.get_daily_stage(site: str, start_date: str, end_date: str) → Dataset#

Get daily data from the USGS NWIS API.

Parameters:

  • site (str) – USGS site number.

  • start_date (str) – Start date in the format ‘yyyy-mm-dd’.

  • end_date (str) – End date in the format ‘yyyy-mm-dd’.

  • params (List[USGSParameter], optional) – List of parameters to retrieve. The default is flow only [USGSFlow].

Returns:

Dataset with the requested data.

Return type:

Dataset

rating_gp.providers.usgs.get_measurements(site: str, start_date: str, end_date: str)#

Get discharge measurements from the USGS NWIS API.

Parameters:

  • site (str) – Water Quality Portal site id; e.g., ‘USGS-12345678’.

  • start_date (str) – Start date in the format ‘YYYY-MM-DD’.

  • end_date (str) – End date in the format ‘YYYY-MM-DD’.

rating_gp.providers.usgs.read_measurements_df(df: DataFrame) → Dataset#

Read a DataFrame of USGS discharge measurements and convert to xarray Dataset.

Parameters:

df (pd.DataFrame) – Dataframe from dataretrieval.nwis.get_discharge_measurements()

Return type:

xr.Dataset

Example

>>> from dataretrieval import nwis
>>> from rating_gp.providers.usgs import read_measurements_df
>>> df, _ = nwis.get_discharge_measurements(
    sites='03339000',
    start='2020-01-01',
    end='2020-12-31',
    format='rdb_expanded',
    )
>>> ds = read_measurements_df(df)
Contents