- class pygeohydro.nwis.NWIS#
Access NWIS web service.
More information about query parameters and codes that NWIS accepts can be found at its help webpage.
- get_info(queries, expanded=False, fix_names=True, nhd_info=False)#
Send multiple queries to USGS Site Web Service.
bool, optional) – Whether to get expanded site information for example drainage area, default to False.
bool, optional) – If
True, reformat station names and some small annoyances, defaults to
bool, optional) – If
True, get NHD information for each site, defaults to
False. This will add four new columns:
nhd_idis the NHD COMID of the flowline that the site is located in,
nhd_reachcodeis the NHD Reach Code that the site is located in, and
nhd_measureis the measure along the flowline that the site is located at.
geopandas.GeoDataFrame– A correctly typed
GeoDataFramecontaining site(s) information.
Search for parameter codes by name or number.
NWIS guideline for keywords is as follows:
By default an exact search is made. To make a partial search the term should be prefixed and suffixed with a % sign. The % sign matches zero or more characters at the location. For example, to find all with “discharge” enter %discharge% in the field. % will match any number of characters (including zero characters) at the location.
str) – Keyword to search for parameters by name of number.
pandas.DataFrame– Matched parameter codes as a dataframe with their description.
>>> from pygeohydro import NWIS >>> nwis = NWIS() >>> codes = nwis.get_parameter_codes("%discharge%") >>> codes.loc[codes.parameter_cd == "00060", "parm_nm"].iloc 'Discharge, cubic feet per second'
- get_streamflow(station_ids, dates, freq='dv', mmd=False, to_xarray=...)#
- get_streamflow(station_ids: Sequence[str] | str, dates: tuple[str, str], freq: str = 'dv', mmd: bool = False, to_xarray: Literal[True] = ...) xarray.Dataset
Get mean daily streamflow observations from USGS.
tuple) – Start and end dates as a tuple (start, end).
str, optional) – The frequency of the streamflow data, defaults to
dv(daily values). Valid frequencies are
iv(instantaneous values). Note that for
ivthe time zone for the input dates is assumed to be UTC.
bool, optional) – Convert cms to mm/day based on the contributing drainage area of the stations. Defaults to False.
bool, optional) – Whether to return a xarray.Dataset. Defaults to False.
xarray.Dataset– Streamflow data observations in cubic meter per second (cms). The stations that don’t provide the requested discharge data in the target period will be dropped. Note that when frequency is set to
ivthe time zone is converted to UTC.
- static retrieve_rdb(url, payloads)#
Retrieve and process requests with RDB format.
- pygeohydro.nwis.streamflow_fillna(streamflow, missing_max=5)#
Fill missing data (NAN) in daily streamflow observations.
It drops stations with more than
missing_maxdays missing data per year. Missing data in the remaining stations, are filled with day-of-year average over the entire dataset.