natcap.invest.urban_flood_risk_mitigation

Urban Flood Risk Mitigation model.

natcap.invest.urban_flood_risk_mitigation.execute(args)

Urban Flood Risk Mitigation.

The model computes the peak flow attenuation for each pixel, delineates areas benefiting from this service, then calculates the monetary value of potential avoided damage to built infrastructure.

Parameters
  • args['workspace_dir'] (string) – a path to the directory that will write output and other temporary files during calculation.

  • args['results_suffix'] (string) – appended to any output file name.

  • args['aoi_watersheds_path'] (string) – path to a shapefile of (sub)watersheds or sewersheds used to indicate spatial area of interest.

  • args['rainfall_depth'] (float) – depth of rainfall in mm.

  • args['lulc_path'] (string) – path to a landcover raster.

  • args['soils_hydrological_group_raster_path'] (string) – Raster with values equal to 1, 2, 3, 4, corresponding to soil hydrologic group A, B, C, or D, respectively (used to derive the CN number).

  • args['curve_number_table_path'] (string) – path to a CSV table that contains at least the headers ‘lucode’, ‘CN_A’, ‘CN_B’, ‘CN_C’, ‘CN_D’.

  • args['built_infrastructure_vector_path'] (string) – (optional) path to a vector with built infrastructure footprints. Attribute table contains a column ‘Type’ with integers (e.g. 1=residential, 2=office, etc.).

  • args['infrastructure_damage_loss_table_path'] (string) – (optional) path to a CSV table with columns ‘Type’ and ‘Damage’ with values of built infrastructure type from the ‘Type’ field in args['built_infrastructure_vector_path'] and potential damage loss (in currency/m^2).

  • args['n_workers'] (int) – (optional) if present, indicates how many worker processes should be used in parallel processing. -1 indicates single process mode, 0 is single process but non-blocking mode, and >= 1 is number of processes.

Returns

None.