pynhd.pynhd

Access NLDI and WaterData databases.

Module Contents

class pynhd.pynhd.HP3D(layer, outfields='*', crs=4326)

Access USGS 3D Hydrography Program (3DHP) service.

Notes

For more info visit: https://hydro.nationalmap.gov/arcgis/rest/services/3DHP_all/MapServer

Parameters:

• layer (str, optional) – A valid service layer. Layer names with _hr are high resolution and _mr are medium resolution. Also, layer names with _nonconus are for non-conus areas, i.e., Alaska, Hawaii, Puerto Rico, the Virgin Islands , and the Pacific Islands. Valid layers are:

  • hydrolocation_waterbody for Sink, Spring, Waterbody Outlet

  • hydrolocation_flowline for Headwater, Terminus, Divergence, Confluence, Catchment Outlet

  • hydrolocation_reach for Reach Code, External Connection

  • flowline for river flowlines

  • waterbody for waterbodies

  • drainage_area for drainage areas

  • catchment for catchments

• outfields (str or list, optional) – Target field name(s), default to “*” i.e., all the fields.

• crs (str, int, or pyproj.CRS, optional) – Target spatial reference, default to EPSG:4326.

bygeom(geom, geo_crs=4326, sql_clause='', distance=None, return_m=False, return_geom=True)

Get features within a geometry that can be combined with a SQL where clause.

byids(field, fids, return_m=False, return_geom=True)

Get features by object IDs.

bysql(sql_clause, return_m=False, return_geom=True)

Get features using a valid SQL 92 WHERE clause.

class pynhd.pynhd.NHD(layer, outfields='*', crs=4326)

Access National Hydrography Dataset (NHD), both meduim and high resolution.

Notes

For more info visit: https://hydro.nationalmap.gov/arcgis/rest/services/nhd/MapServer

Parameters:

• layer (str, optional) – A valid service layer. Layer names with _hr are high resolution and _mr are medium resolution. Also, layer names with _nonconus are for non-conus areas, i.e., Alaska, Hawaii, Puerto Rico, the Virgin Islands , and the Pacific Islands. Valid layers are:

  • point

  • point_event

  • line_hr

  • flow_direction

  • flowline_mr

  • flowline_hr_nonconus

  • flowline_hr

  • area_mr

  • area_hr_nonconus

  • area_hr

  • waterbody_mr

  • waterbody_hr_nonconus

  • waterbody_hr

• outfields (str or list, optional) – Target field name(s), default to “*” i.e., all the fields.

• crs (str, int, or pyproj.CRS, optional) – Target spatial reference, default to EPSG:4326.

bygeom(geom, geo_crs=4326, sql_clause='', distance=None, return_m=False, return_geom=True)

Get features within a geometry that can be combined with a SQL where clause.

byids(field, fids, return_m=False, return_geom=True)

Get features by object IDs.

bysql(sql_clause, return_m=False, return_geom=True)

Get features using a valid SQL 92 WHERE clause.

class pynhd.pynhd.NHDPlusHR(layer, outfields='*', crs=4326)

Access National Hydrography Dataset (NHD) Plus high resolution.

Notes

For more info visit: https://hydro.nationalmap.gov/arcgis/rest/services/NHDPlus_HR/MapServer

Parameters:

• layer (str, optional) – A valid service layer. Valid layers are:

  • gage for NHDPlusGage layer

  • sink for NHDPlusSink layer

  • point for NHDPoint layer

  • flowline for NetworkNHDFlowline layer

  • non_network_flowline for NonNetworkNHDFlowline layer

  • flow_direction for FlowDirection layer

  • wall for NHDPlusWall layer

  • line for NHDLine layer

  • area for NHDArea layer

  • waterbody for NHDWaterbody layer

  • catchment for NHDPlusCatchment layer

  • boundary_unit for NHDPlusBoundaryUnit layer

  • huc12 for WBDHU12 layer

• outfields (str or list, optional) – Target field name(s), default to “*” i.e., all the fields.

• crs (str, int, or pyproj.CRS, optional) – Target spatial reference, default to EPSG:4326.

bygeom(geom, geo_crs=4326, sql_clause='', distance=None, return_m=False, return_geom=True)

Get features within a geometry that can be combined with a SQL where clause.

byids(field, fids, return_m=False, return_geom=True)

Get features by object IDs.

bysql(sql_clause, return_m=False, return_geom=True)

Get features using a valid SQL 92 WHERE clause.

class pynhd.pynhd.WaterData(layer, crs=4326)

Access WaterData service.

Parameters:

• layer (str) – A valid layer from the WaterData service. Valid layers are:

  • catchmentsp

  • gagesii

  • gagesii_basins

  • nhdarea

  • nhdflowline_network

  • nhdflowline_nonnetwork

  • nhdwaterbody

  • wbd02

  • wbd04

  • wbd06

  • wbd08

  • wbd10

  • wbd12

  Note that all wbd* layers provide access to the October 2020 snapshot of the Watershed Boundary Dataset (WBD). If you need the latest version, please use the WBD class from the PyGeoHydro package.

• crs (str, int, or pyproj.CRS, optional) – The target spatial reference system, defaults to epsg:4326.

bybox(bbox, box_crs=4326, sort_attr=None)

Get features within a bounding box.

Parameters:

• bbox (tuple of floats) – A bounding box in the form of (minx, miny, maxx, maxy).

• box_crs (str, int, or pyproj.CRS, optional) – The spatial reference system of the bounding box, defaults to epsg:4326.

• sort_attr (str, optional) – The column name in the database to sort request by, defaults to the first attribute in the schema that contains id in its name.

Returns:

geopandas.GeoDataFrame – The requested features in a GeoDataFrames.

Return type:

geopandas.GeoDataFrame

bydistance(coords, distance, loc_crs=4326, sort_attr=None)

Get features within a radius (in meters) of a point.

Parameters:

• coords (tuple of float) – The x, y coordinates of the point.

• distance (int) – The radius (in meters) to search within.

• loc_crs (str, int, or pyproj.CRS, optional) – The CRS of the input coordinates, default to epsg:4326.

• sort_attr (str, optional) – The column name in the database to sort request by, defaults to the first attribute in the schema that contains id in its name.

Returns:

geopandas.GeoDataFrame – Requested features as a GeoDataFrame.

Return type:

geopandas.GeoDataFrame

byfilter(cql_filter, method='GET', sort_attr=None)

Get features based on a CQL filter.

Parameters:

• cql_filter (str) – The CQL filter to use for requesting the data.

• method (str, optional) – The HTTP method to use for requesting the data, defaults to GET. Allowed methods are GET and POST.

• sort_attr (str, optional) – The column name in the database to sort request by, defaults to the first attribute in the schema that contains id in its name.

Returns:

geopandas.GeoDataFrame – The requested features as a GeoDataFrames.

Return type:

geopandas.GeoDataFrame

bygeom(geometry, geo_crs=4326, xy=True, predicate='intersects', sort_attr=None)

Get features within a geometry.

Parameters:

• geometry (shapely.Polygon or shapely.MultiPolygon) – The input (multi)polygon to request the data.

• geo_crs (str, int, or pyproj.CRS, optional) – The CRS of the input geometry, default to epsg:4326.

• xy (bool, optional) – Whether axis order of the input geometry is xy or yx.

• predicate (str, optional) – The geometric prediacte to use for requesting the data, defaults to INTERSECTS. Valid predicates are:

  • equals

  • disjoint

  • intersects

  • touches

  • crosses

  • within

  • contains

  • overlaps

  • relate

  • beyond

• sort_attr (str, optional) – The column name in the database to sort request by, defaults to the first attribute in the schema that contains id in its name.

Returns:

geopandas.GeoDataFrame – The requested features in the given geometry.

Return type:

geopandas.GeoDataFrame

byid(featurename, featureids)

Get features based on IDs.