natcap.invest.scenario_gen_proximity

Scenario Generation: Proximity Based.

natcap.invest.scenario_gen_proximity.execute(args)

Scenario Generator: Proximity-Based.

Main entry point for proximity based scenario generator model.

Parameters:

• args['workspace_dir'] (string) – output directory for intermediate, temporary, and final files

• args['results_suffix'] (string) – (optional) string to append to any output files

• args['base_lulc_path'] (string) – path to the base landcover map

• args['replacement_lucode'] (string or int) – code to replace when converting pixels

• args['area_to_convert'] (string or float) – max area (Ha) to convert

• args['focal_landcover_codes'] (string) – a space separated string of landcover codes that are used to determine the proximity when refering to “towards” or “away” from the base landcover codes

• args['convertible_landcover_codes'] (string) – a space separated string of landcover codes that can be converted in the generation phase found in args[‘base_lulc_path’].

• args['n_fragmentation_steps'] (string) – an int as a string indicating the number of steps to take for the fragmentation conversion

• args['aoi_path'] (string) – (optional) path to a shapefile that indicates area of interest. If present, the expansion scenario operates only under that AOI and the output raster is clipped to that shape.

• args['convert_farthest_from_edge'] (boolean) – if True will run the conversion simulation starting from the furthest pixel from the edge and work inwards. Workspace will contain output files named ‘toward_base{suffix}.{tif,csv}.

• args['convert_nearest_to_edge'] (boolean) – if True will run the conversion simulation starting from the nearest pixel on the edge and work inwards. Workspace will contain output files named ‘toward_base{suffix}.{tif,csv}.

• args['n_workers'] (int) – (optional) The number of worker processes to use for processing this model. If omitted, computation will take place in the current process.

Returns:

None.