Skip to content

Commit

Permalink
Improve derive_rc docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Dobson committed Mar 1, 2024
1 parent 1aefae9 commit 911790b
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion swmmanywhere/geospatial_utilities.py
Original file line number Diff line number Diff line change
Expand Up @@ -608,8 +608,13 @@ def remove_(mp): return remove_zero_area_subareas(mp, removed_subareas)
def derive_rc(polys_gdf: gpd.GeoDataFrame,
G: nx.Graph,
building_footprints: gpd.GeoDataFrame) -> gpd.GeoDataFrame:
"""Derive the RC of each subcatchment.
"""Derive the Runoff Coefficient (RC) of each subcatchment.
The runoff coefficient is the ratio of impervious area to total area. The
impervious area is calculated by overlaying the subcatchments with building
footprints and all edges in G buffered by their width parameter (i.e., to
calculate road area).
Args:
polys_gdf (gpd.GeoDataFrame): A GeoDataFrame containing polygons that
represent subcatchments with columns: 'geometry', 'area', and 'id'.
Expand Down

0 comments on commit 911790b

Please sign in to comment.