download_fr.hydrometry

download_fr.hydrometry(*, dst_folder, masks, start_year, end_year=None, quantities='QmnJ', file_formats='geojson')

Function to facilitate the downloading of French hydrometry data from EauFrance API.

Parameters

dst_folderstr or pathlib.Path

Destination folder in which the downloaded data will be stored.

maskslist of-, or single element among str, pathlib.Path, xarray.Dataset, xarray.DataArray or geopandas.GeoDataFrame, optional

Mask on which the data will be retrieved.

start_yearint, optional

Year from which the data will be retrieved.

end_yearint, optional

Year until which the data will be retrieved.

quantities : str or list of str, default ‘QmnJ’

• ‘QmnJ’: average daily discharge

• ‘QmM’: average monthly discharge

• ‘HIXM’: maximum instant height per month

• ‘HIXnJ’: maximum instant height per day

• ‘QINM’: minimum instant discharge per month

• ‘QINnJ’: minimum instant discharge per day

• ‘QixM’: maximum instant discharge per month

• ‘QIXnJ’: maximum instant discharge per day

file_formatsstr or list of str, {‘csv’, ‘json’, ‘geojson’}, default ‘geojson’

File format in which the data will be retrieved.

Returns

None. Downloaded data is stored in dst_folder