natcap.invest.urban_mental_health.reporter

natcap.invest.urban_mental_health.reporter.infer_continuous_or_divergent(raster_path: str) str

Infer if raster should have a ‘continuous’ or ‘divergent’ color ramp.

Rules:
  • If min value < ~0 and max value > ~0–> ‘divergent’

  • Else –> ‘continuous’

Parameters:

raster_path (str) – Path to raster.

Returns:

‘continuous’ or ‘divergent’

Return type:

str

natcap.invest.urban_mental_health.reporter.report(file_registry: dict, args_dict: dict, model_spec: ModelSpec, target_html_filepath: str)

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.

Returns:

None