3.20.0

Highlights

• InVEST Reports are now available for these additional models:

  • Annual Water Yield
  • Urban Cooling
  • Urban Nature Access

  Reports are visual summaries of model results. View sample reports.

General

• To ensure consistent raster plot sizing in reports, padding is now
  added to the top of raster plots if an adjacent raster plot has a units subheading.
  (#2471)
• The deploy_dist Makefile target was split into deploy_wheel and deploy_sdist.
• Input, Output, and ModelSpec classes now create immutable objects.
  Use model_copy(update=dict(...)) to copy an object and update attributes. (#2228)
• Replaced natcap.invest.spec.DirectoryInput with
  natcap.invest.spec.WorkspaceInput (for workspace directories only).
  Input data that was previously grouped in a directory should instead
  use an individual Input for each file, or a CSVInput to list out multiple files.
  (#2179)
• Made some styling and usability improvements to the Vega-Lite visualizations (e.g., vector plots, histograms) that appear in some InVEST reports.
  (#2532)
• Added a .gitignore for InVEST build files and common editor files.
  (#258)
• Fixed an issue with Windows binary builds where users would see runtime warnings saying GDAL_DATA is not defined.
  (#2555)
• Avoid logging a Python traceback and avoid attempting to generate
  metadata and an html report if a model's execute function does not
  return a FileRegistry.registry dictionary.
  (#2555)
• Reports now display a Raster Attribute Table for Land Use/Land Cover input rasters.
  (#2333)
• When saving a datastack, CSVs are now copied into argument-named
  subfolders, which preserves original filenames and ensures metadata
  compatibility.
  (#2442)
• Added the --no-report flag to the command line interface, which allows users to disable report generation.
  (#2573)

Workbench

• Fixed a bug in Workbench application logs where the label referring to
  the origin of the log message was inaccurate. Messages are now labeled
  as from either the "main" or "renderer" process.
  (#2522)
• Attempting to load a datastack or logfile with a model ID the
  Workbench doesn't recognize (such as the ID of a plugin that isn't
  installed, or an otherwise malformed model ID) now presents an error
  message instead of failing silently.
  (#2489)
• Added a link to the InVEST Plugin Developer's Guide to the Workbench
  Manage Plugins modal.
  (#2145)
• Added a disclosure about InVEST usage data to the Workbench installer
  and to the in-Workbench "About InVEST" page. For more details, refer
  to the InVEST Usage Data
  Notice.
  (#2553)
• Removed outdated usage-logging code to reflect current data collection
  practices. (#2600)

Annual Water Yield

• Allow watershed input to have a POLYGON or MULTIPOLYGON geometry type.
  (#2513)
• The model now generates a report, a visual summary of results,
  available in the output workspace and also viewable from the Workbench
  after the model run completes.
  (#2533)

Carbon Storage and Sequestration

• Added a new output, raster_values_summary.csv, which provides a
  summary of the model's raster outputs. This table already appeared at
  the top of the Carbon report but is now created by the model module
  itself rather than the reporter, in order to make it available as a
  CSV in the output directory.
  (#2531)

SDR

• Added exception-handling when checking if watershed geoemtries
  overlap. Invalid geometries will no longer raise an exception during
  this check because they can still be rasterized and used in
  zonal_statistics.
  (#2386)

Urban Cooling

• The Urban Cooling model now generates a report, a visual summary of
  results, available in the output workspace and also viewable from the
  Workbench after the model run completes.
  (#2322)
• The T_air and cc outputs have been moved out of the intermediate
  directory and into the main output workspace.
  (#2564)

Urban Nature Access

• The model now generates a report which displays a visual summary of
  results and metadata.
  (#2534)