natcap.invest.reports.sdr_ndr_report_generator

natcap.invest.reports.sdr_ndr_report_generator.report(file_registry, args_dict, model_spec, target_html_filepath, input_raster_plot_configs, output_raster_plot_configs, intermediate_raster_plot_configs, results_vector_id, results_vector_cols_to_sum)

Generate an HTML summary of model results.

Parameters:

  • file_registry (dict) – the natcap.invest.FileRegistry.registry that was returned by the model’s execute method.

  • args_dict (dict) – the arguments that were passed to the model’s execute method.

  • model_spec (natcap.invest.spec.ModelSpec) – the model’s MODEL_SPEC.

  • target_html_filepath (str) – path to an HTML file to be generated by this function.

  • input_raster_plot_configs (list[raster_utils.RasterPlotConfig]) – used to plot input rasters

  • output_raster_plot_configs (list[raster_utils.RasterPlotConfig]) – used to plot output rasters

  • intermediate_raster_plot_configs (list[raster_utils.RasterPlotConfig]) – used to plot intermediate rasters

  • results_vector_id (str) – id of the results vector generated by the model (e.g., for NDR, watershed_results_ndr),

  • results_vector_cols_to_sum (list[str]) – list of column names in the results vector to include when calculating totals.

Returns:

None