easysnowdata.hydroclimatology.get_hydroBASINS#

easysnowdata.hydroclimatology.get_hydroBASINS(bbox_input: GeoDataFrame | tuple | BaseGeometry | None = None, level: int = 5, **kwargs) → GeoDataFrame[source]#

Deprecated since version 0.1.0: easysnowdata.hydroclimatology.get_hydroBASINS is deprecated since easysnowdata 0.1.0 and will be removed in 0.3.0. Use easysnowdata.hydro.basins.hydrobasins instead.

Retrieves HydroATLAS sub-basin boundaries at specified hierarchical level.

Deprecated since version 0.1.0: Use easysnowdata.hydro.basins.hydrobasins(), which adds the lighter per-region HydroSHEDS zips (source="hydrosheds") and the Earth Engine route.

Parameters:

bbox_input (geopandas.GeoDataFrame, tuple, or Shapely Geometry, optional) – The bounding box for spatial subsetting. If None, the entire global dataset is returned.
level (int, optional) – The hierarchical level (1-12) of sub-basin delineation. Higher levels represent finer subdivisions. Default is 5.
**kwargs – Additional keyword arguments passed to easysnowdata.hydro.basins.hydrobasins() (and on to geopandas.read_file).

Returns:

geopandas.GeoDataFrame – A GeoDataFrame containing the HydroATLAS sub-basin boundaries with associated attributes.

Notes

Data citation: Linke, S., Lehner, B., Ouellet Dallaire, C., Ariwi, J., Grill, G., Anand, M., Beames, P., Burchard-Levine, V., Maxwell, S., Moidu, H., Tan, F., Thieme, M. (2019). Global hydro- environmental sub-basin and river reach characteristics at high spatial resolution. Scientific Data 6: 283. doi: 10.1038/s41597-019-0300-6