3.14.0

This release includes the following fixes and features:

• General
  • Fixed a bug in the CLI where invest getspec --json failed on
    non-json-serializable objects such as pint.Unit.
    #1280
  • A new directory at ./doc/decision-records has been created for
    "Architecture/Any Decision Records", which will serve as a record of
    nontrivial decisions that were made to InVEST and why. This is
    intended for reference by our science and software teams, and also by
    the community at large when inquiring about a nontrivial change.
    #1079
  • Updated the package installation instructions in the API docs for clarity
    and also to highlight the ease of installation through conda-forge.
    #1256
  • utils.build_lookup_from_csv has been deprecated and its functionality
    has been merged into utils.read_csv_to_dataframe
    (#1319 <https://github.com/natcap/invest/issues/1319>),
    (#1327 <https://github.com/natcap/invest/issues/1327>)
  • Standardized on keeping the execute and validate functions
    orthogonal. Now no models call validate from execute. This
    affected AWY, CV, UFRM, Wave Energy, and Wind Energy.
    (#1373 <https://github.com/natcap/invest/issues/1373>_)
  • Improved the validation message that is returned when not all spatial
    inputs overlap (#502 <https://github.com/natcap/invest/issues/502>_)
  • Standardized the name and location of the taskgraph cache directory for
    all models. It is now called taskgraph_cache and located in the top
    level of the workspace directory.
    (#1230 <https://github.com/natcap/invest/issues/1230>_)
  • InVEST is now distributed under the Apache 2.0 License.
• Workbench
  • Fixed a bug where sampledata downloads failed silently (and progress bar
    became innacurate) if the Workbench did not have write permission to
    the download location. #1070
  • The workbench app is now distributed with a valid code signature
    (#727 <https://github.com/natcap/invest/issues/727>_)
  • Changing the language setting will now cause the app to relaunch
    (#1168 <https://github.com/natcap/invest/issues/1168>_)
  • Closing the main window will now close any user's guide windows that are
    open. Fixed a bug where the app could not be reopened after closing.
    (#1258 <https://github.com/natcap/invest/issues/1258>_)
  • Fixed a bug where invalid metadata for a recent run would result
    in an uncaught exception.
    (#1286 <https://github.com/natcap/invest/issues/1286>_)
  • Middle clicking an InVEST model tab was opening a blank window. Now
    middle clicking will close that tab as expected.
    (#1261 <https://github.com/natcap/invest/issues/1261>_)
  • Updated InVEST logo to use new version with registered trademark symbol.
    (InVEST TM and Logo Use Policy <https://naturalcapitalproject.stanford.edu/invest-trademark-and-logo-use-policy>_)
  • InVEST is licensed using a permissive open source license. But we have
    decided to add back the license and agreement step to the installer to
    be upfront and explicit about how InVEST is licensed.
• Coastal Blue Carbon
  • Added validation for the transition table, raising a validation error if
    unexpected values are encountered.
    (#729 <https://github.com/natcap/invest/issues/729>_)
• Forest Carbon
  • The biophysical table is now case-insensitive.
• HRA
  • Fixed a bug in HRA where the model would error when all exposure and
    consequence criteria were skipped for a single habitat. The model now
    correctly handles this case. #1250
  • Tables in the .xls format are no longer supported. This format was
    deprecated by pandas.
    (#1271 <https://github.com/natcap/invest/issues/1271>_)
  • Fixed a bug where vector inputs could be rasterized onto a grid that is
    not exactly aligned with other raster inputs.
    (#1312 <https://github.com/natcap/invest/issues/1312>_)
  • Dropped support for Excel (.xlsx) files
    (#1391 <https://github.com/natcap/invest/issues/1391>_)
• NDR
  • The contents of the output cache_dir have been consolidated into
    intermediate_outputs.
  • Fixed a bug where results were calculated incorrectly if the runoff proxy
    raster (or the DEM or LULC) had no nodata value
    (#1005 <https://github.com/natcap/invest/issues/1005>_)
• Pollination
  • Several exceptions have been tidied up so that only fieldnames are
    printed instead of the python data structures representing the whole
    table. #1283
• RouteDEM
  • RouteDEM now allows the user to calculate Strahler Stream Orders, which
    will be written to a new vector in the user's workspace. This stream
    order vector is dependent on the user's Threshold Flow Accumulation value
    and is only available for the D8 routing model.
    #884
  • RouteDEM now allows the user to create a vector of subwatersheds, which
    are written to a new vector in the user's workspace. This vector is
    dependent on the calculation of Strahler Stream Orders and is only
    available for the D8 routing model. #349
• Scenic Quality
  • The Scenic Quality model will now raise an error when it encounters a
    geometry that is not a simple Point. This is in line with the user's
    guide chapter. #1245
  • The Scenic Quality model now supports both uppercase and lowercase
    fieldnames. Leading and trailing spaces are now also stripped for the
    user's convenience. #1276
• SDR
  • Fixed an issue with sediment deposition progress logging that was
    causing the "percent complete" indicator to not progress linearly.
    #1262
  • The contents of the output churn_dir_not_for_humans have been
    consolidated into intermediate_outputs.
  • We implemented two major functional changes to the InVEST LS Factor
    that significantly affect most outputs of SDR and will bring the LS
    factor output more in line with the outputs of SAGA-GIS's LS Factor.
    A discussion of differences between these two implementations can be
    viewed at https://github.com/natcap/invest/tree/main/doc/decision-records/ADR-0001-Update-SDR-LS-Factor.md.
    The two specific changes implemented are: