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()
get_vector_colnames()
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.habitat_quality
- natcap.invest.hra
- natcap.invest.managed_raster
- natcap.invest.models
- 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
BooleanInput
CSVInput
CSVOutput
DirectoryInput
DirectoryOutput
FileInput
FileOutput
Input
IntegerInput
IntegerOutput
IterableWithDotAccess
ModelSpec
NumberInput
NumberOutput
OptionStringInput
OptionStringOutput
Output
PercentInput
PercentOutput
RasterBand
RasterInput
RasterOrVectorInput
RasterOutput
RatioInput
RatioOutput
SingleBandRasterInput
SingleBandRasterOutput
StringInput
StringOutput
VectorInput
VectorOutput
build_input_spec()
build_model_spec()
build_output_spec()
capitalize()
check_headers()
describe_arg_from_name()
describe_arg_from_spec()
format_geometry_types_string()
format_options_string_from_dict()
format_options_string_from_list()
format_permissions_string()
format_required_string()
format_type_string()
format_unit()
generate_metadata_for_outputs()
timeout()
write_metadata_file()
- natcap.invest.stormwater
- natcap.invest.ui_server
build_datastack_archive()
get_args_enabled()
get_dynamic_dropdown_options()
get_geometamaker_profile()
get_invest_getspec()
get_invest_models()
get_invest_validate()
get_is_ready()
get_supported_languages()
log_model_exit()
log_model_start()
post_datastack_file()
save_to_python()
set_geometamaker_profile()
write_parameter_set_file()
- natcap.invest.unit_registry
- natcap.invest.urban_cooling_model
- natcap.invest.urban_flood_risk_mitigation
- natcap.invest.urban_nature_access
- natcap.invest.usage
- natcap.invest.utils
ThreadFilter
build_file_registry()
capture_gdal_logging()
copy_spatial_files()
create_coordinate_transformer()
expand_path()
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
- natcap.invest.wave_energy
- natcap.invest.wind_energy
- natcap.invest