CHS

The Canadian Hydrographic Service (CHS) provides water level and forecast data for Canadian waters. This module offers functions to interact with the CHS API and retrieve station information and water level data.

A DataFrame with the CHS station metadata can be retrieved with get_chs_stations(), while station data can be fetched with fetch_chs_station() and _fetch_chs().

searvey.get_chs_stations(region=None, lon_min=None, lon_max=None, lat_min=None, lat_max=None)

Return CHS station metadata. If region is defined then the stations that are outside of the region are filtered out. If the coordinates of the Bounding Box are defined then stations outside of the BBox are filtered out. If both region and the Bounding Box are defined, then an exception is raised.

Return type:

GeoDataFrame

searvey.fetch_chs_station(station_id, time_series_code, start_date, end_date, rate_limit=None, http_client=None)

Retrieve the TimeSeries of a single CHS station. Make a query to the CHS API for data for station_id and return the results as a pandas dataframe.

Return type:

DataFrame