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
      • compute_rsupply_volume()
      • compute_water_yield_volume()
      • compute_watershed_valuation()
      • convert_vector_to_csv()
      • copy_vector()
      • execute()
      • fractp_op()
      • write_output_vector_attributes()
      • wyield_op()
      • zonal_stats_tofile()
    • natcap.invest.carbon
      • execute()
      • sum_op()
    • natcap.invest.cli
      • SelectModelAction
      • build_model_list_json()
      • build_model_list_table()
      • export_to_python()
      • main()
    • natcap.invest.coastal_blue_carbon
      • natcap.invest.coastal_blue_carbon.coastal_blue_carbon
      • natcap.invest.coastal_blue_carbon.preprocessor
    • 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
      • aggregate_to_polygons()
      • calculate_crop_production()
      • execute()
      • tabulate_results()
    • natcap.invest.crop_production_regression
      • aggregate_regression_results_to_polygons()
      • execute()
      • tabulate_regression_results()
    • natcap.invest.datastack
      • ParameterSet
      • build_datastack_archive()
      • build_parameter_set()
      • extract_datastack_archive()
      • extract_parameter_set()
      • extract_parameters_from_logfile()
      • format_args_dict()
      • get_datastack_info()
    • natcap.invest.delineateit
      • natcap.invest.delineateit.delineateit
      • natcap.invest.delineateit.delineateit_core
    • natcap.invest.forest_carbon_edge_effect
      • combine_carbon_maps()
      • execute()
    • natcap.invest.habitat_quality
      • execute()
    • natcap.invest.hra
      • execute()
    • natcap.invest.managed_raster
    • natcap.invest.models
      • is_invest_compliant_model()
    • natcap.invest.ndr
      • natcap.invest.ndr.ndr
      • natcap.invest.ndr.ndr_core
    • natcap.invest.pollination
      • execute()
      • on_farm_pollinator_abundance_op()
      • pollinator_supply_op()
      • pyt_op()
      • pyw_op()
    • natcap.invest.recreation
      • natcap.invest.recreation.buffered_numpy_disk_map
      • natcap.invest.recreation.out_of_core_quadtree
      • natcap.invest.recreation.recmodel_client
      • natcap.invest.recreation.recmodel_server
      • natcap.invest.recreation.recmodel_workspace_fetcher
    • natcap.invest.routedem
      • execute()
    • natcap.invest.scenario_gen_proximity
      • execute()
    • natcap.invest.scenic_quality
      • natcap.invest.scenic_quality.scenic_quality
      • natcap.invest.scenic_quality.viewshed
    • natcap.invest.sdr
      • natcap.invest.sdr.sdr
      • natcap.invest.sdr.sdr_core
    • natcap.invest.seasonal_water_yield
      • natcap.invest.seasonal_water_yield.seasonal_water_yield
      • natcap.invest.seasonal_water_yield.seasonal_water_yield_core
    • 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
      • adjust_op()
      • aggregate_results()
      • execute()
      • is_near()
      • lookup_ratios()
      • pollutant_load_op()
      • raster_average()
      • retention_to_runoff_op()
      • retention_value_op()
      • volume_op()
    • 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
      • calc_cc_op_factors()
      • calc_cc_op_intensity()
      • calc_eti_op()
      • calc_t_air_nomix_op()
      • calculate_energy_savings()
      • calculate_uhi_result_vector()
      • calculate_wbgt()
      • convolve_2d_by_exponential()
      • execute()
      • hm_op()
      • map_work_loss()
      • mask_cc_green_areas_op()
      • pickle_zonal_stats()
    • natcap.invest.urban_flood_risk_mitigation
      • execute()
    • natcap.invest.urban_nature_access
      • execute()
      • validate()
    • natcap.invest.usage
      • log_run()
    • 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
      • CHECK_ALL_KEYS
      • args_enabled()
      • check_spatial_overlap()
      • get_invalid_keys()
      • get_message()
      • get_sufficient_keys()
      • invest_validator()
      • load_fields_from_vector()
      • validate()
    • natcap.invest.wave_energy
      • IntersectionError
      • execute()
    • natcap.invest.wind_energy
      • execute()