floodresilience.dynamic_boundary_conditions.river.osm_waterways

This script handles the fetching of OpenStreetMap (OSM) waterways data for the defined catchment area.

Attributes

log

Functions

configure_osm_cache(→ None)	Change the directory for storing the OSM cache files.
fetch_osm_waterways(→ geopandas.GeoDataFrame)	Fetch OpenStreetMap (OSM) waterways data for the specified catchment area.
get_osm_waterways_data(→ geopandas.GeoDataFrame)	Fetch OpenStreetMap (OSM) waterways data for the specified catchment area.

Module Contents

floodresilience.dynamic_boundary_conditions.river.osm_waterways.log

floodresilience.dynamic_boundary_conditions.river.osm_waterways.configure_osm_cache() → None

Change the directory for storing the OSM cache files.

floodresilience.dynamic_boundary_conditions.river.osm_waterways.fetch_osm_waterways(catchment_area: geopandas.GeoDataFrame) → geopandas.GeoDataFrame

Fetch OpenStreetMap (OSM) waterways data for the specified catchment area.

Parameters:

catchment_area (gpd.GeoDataFrame) – A GeoDataFrame representing the catchment area.

Returns:

A GeoDataFrame containing the retrieved OSM waterways data for the specified catchment area.

Return type:

gpd.GeoDataFrame

floodresilience.dynamic_boundary_conditions.river.osm_waterways.get_osm_waterways_data(catchment_area: geopandas.GeoDataFrame) → geopandas.GeoDataFrame

Fetch OpenStreetMap (OSM) waterways data for the specified catchment area. Only LineString geometries representing waterways of type “river” or “stream” are included.

Parameters:

catchment_area (gpd.GeoDataFrame) – A GeoDataFrame representing the catchment area.

Returns:

A GeoDataFrame containing only LineString geometries representing waterways of type “river” or “stream”.

Return type:

gpd.GeoDataFrame