API ReferenceΒΆ
Note
For the entrypoint to each model, see InVEST Model Entry Points. The InVEST graphic user interface interacts with the models through these entrypoints. If you want to use the models as they are, such as to automate runs, you should only access the entrypoint function of each model.
If however you want to modify a model, or only use certain components, see below for the complete API reference.
- natcap
- natcap.invest
- natcap.invest.annual_water_yield
- natcap.invest.carbon
- natcap.invest.cli
- natcap.invest.coastal_blue_carbon
- natcap.invest.coastal_vulnerability
aggregate_population_density()assemble_results_and_calculate_exposure()calculate_final_risk()calculate_geomorphology_exposure()calculate_habitat_rank()calculate_relief_exposure()calculate_surge_exposure()calculate_wave_exposure()calculate_wind_exposure()clip_and_project_raster()clip_and_project_vector()compute_wave_height()compute_wave_period()construct_field_list()execute()extract_bathymetry_along_ray()geometry_to_lines()interpolate_sealevelrise_points()interpolate_wwiii_to_shore()mask_positive_values_op()polygon_to_lines()prepare_landmass_line_index_and_interpolate_shore_points()search_for_raster_habitat()search_for_vector_habitat()warp_and_mask_bathymetry()zero_negative_values()
- natcap.invest.crop_production_percentile
- natcap.invest.crop_production_regression
- natcap.invest.datastack
- natcap.invest.delineateit
- natcap.invest.forest_carbon_edge_effect
- natcap.invest.globio
- natcap.invest.habitat_quality
- natcap.invest.hra
- natcap.invest.model_metadata
- natcap.invest.ndr
- natcap.invest.pollination
- natcap.invest.recreation
- natcap.invest.routedem
- natcap.invest.scenario_gen_proximity
- natcap.invest.scenic_quality
- natcap.invest.sdr
- natcap.invest.seasonal_water_yield
- natcap.invest.spec_utils
- natcap.invest.stormwater
- natcap.invest.ui
- natcap.invest.ui.annual_water_yield
- natcap.invest.ui.carbon
- natcap.invest.ui.cbc
- natcap.invest.ui.coastal_vulnerability
- natcap.invest.ui.crop_production
- natcap.invest.ui.delineateit
- natcap.invest.ui.execution
- natcap.invest.ui.forest_carbon
- natcap.invest.ui.globio
- natcap.invest.ui.habitat_quality
- natcap.invest.ui.hra
- natcap.invest.ui.inputs
- natcap.invest.ui.launcher
- natcap.invest.ui.model
- natcap.invest.ui.ndr
- natcap.invest.ui.pollination
- natcap.invest.ui.recreation
- natcap.invest.ui.routedem
- natcap.invest.ui.scenario_gen
- natcap.invest.ui.scenic_quality
- natcap.invest.ui.sdr
- natcap.invest.ui.seasonal_water_yield
- natcap.invest.ui.stormwater
- natcap.invest.ui.urban_cooling_model
- natcap.invest.ui.urban_flood_risk_mitigation
- natcap.invest.ui.wave_energy
- natcap.invest.ui.wind_energy
- natcap.invest.ui_server
- natcap.invest.urban_cooling_model
- natcap.invest.urban_flood_risk_mitigation
- natcap.invest.usage
- natcap.invest.utils
ThreadFilterarray_equals_nodata()build_file_registry()build_lookup_from_csv()capture_gdal_logging()create_coordinate_transformer()expand_path()exponential_decay_kernel_raster()has_utf8_bom()log_to_file()make_directories()make_suffix_string()matches_format_string()mean_pixel_size_and_area()prepare_workspace()read_csv_to_dataframe()reclassify_raster()sandbox_tempdir()
- natcap.invest.validation
CHECK_ALL_KEYScheck_boolean()check_csv()check_directory()check_file()check_freestyle_string()check_headers()check_integer()check_number()check_option_string()check_percent()check_permissions()check_raster()check_ratio()check_spatial_overlap()check_vector()get_headers_to_validate()get_invalid_keys()get_sufficient_keys()invest_validator()load_fields_from_vector()timeout()validate()
- natcap.invest.wave_energy
- natcap.invest.wind_energy
- natcap.invest