3.14.2

This release includes the following fixes and features:

• General

  • Validation now covers file paths contained in CSVs. CSV validation
    will fail if the files listed in a CSV fail to validate.
    #327

  • We have updated validation in several ways that will improve the
    developer experience of working with InVEST models, and we hope will also
    improve the user experience:

    • Symbols in conditional requirement expressions now represent the values
      of parameters instead of whether the value of the parameter is
      sufficient. If a symbol is not present in args as a key, the
      symbol will have a value of False. This allows for value-based
      comparisons, which is useful in models that have overlapping modes of
      operation. #1509
    • Vector fields, CSV rows/columns and the 1st level of directory
      contents may now all be conditionally required based on a python
      expression.
    • Under certain circumstances, validation may return more warnings than
      before. This specifically applies to model inputs that have conditional
      requirement expressions where their expression evaluates to False,
      and the user has provided a value for this parameter. Previous
      versions of InVEST would skip these parameters' type-specific
      validation. Now, these parameters will be validated with their
      type-specific validation checks.

  • Add support for latest GDAL versions; remove test-specific constraint on
    GDAL versions from invest requirements.
    #916

  • Updated to Cython 3 (#556)

• Annual Water Yield
  • Added the results_suffix to a few intermediate files where it was
    missing. #1517
• Coastal Blue Carbon
  • Updated model validation to prevent the case where a user provides only
    one snapshot year and no analysis year
    (#1534 <https://github.com/natcap/invest/issues/1534>_).
    Also enforces that the analysis year, if provided, is greater than the
    latest snapshot year. An analysis year equal to the latest snapshot year
    is no longer allowed.
• Coastal Vulnerability
  • Fixed a bug in handling nan as the nodata value of the bathymetry
    raster. nan pixels will now be propertly ignored before calculating
    mean depths along fetch rays.
    #1528
• HRA
  • Fixed a bug where habitat and stressor vectors were not being rasterized
    with the ALL_TOUCHED=TRUE setting.
• Scenic Quality
  • Fixed an issue with viewshed calculations where some slight numerical
    error was introduced on M1 Macs, but not on x86-based computers. This
    numerical error was leading to slightly different visibility results.
    #1562
• SDR
  • Fixed an issue encountered in the sediment deposition function where
    rasters with more than 2^32 pixels would raise a cryptic error relating
    to negative dimensions. #1431
  • Optimized the creation of the summary vector by minimizing the number of
    times the target vector needs to be rasterized.
• Seasonal Water Yield
  • Fixed an issue with the precip directory units. Units for these input
    rasters are now correctly stated as mm/month.
    #1571
  • Fixed an issue where the monthly quickflow values were being summed over
    a block area and not summed pixelwise. This caused the quickflow
    output QF.tif to have malformed values.
    #1541
• Wind Energy
  • Fixed a bug where some number inputs were not being properly cast to
    float or int types. If the inputs happened to be passed as
    a str this caused unintended side effects such as a concatenation
    error. (#1498)
• Urban Nature Access
  • Fixed a NameError that occurred when running the model using
    search radii defined per population group with an exponential search
    kernel. #1502
  • Fixed an issue where Urban Nature Access would crash if an administrative
    boundary geometry did not overlap any people in the population raster.
    #1503
  • Fixed an issue where validation was failing to catch missing values in
    the uniform search radius args key when using uniform search radii.
    #1509
  • Fixed an issue where the output administrative units vector's
    Pund_adm and Povr_adm fields representing undersupplied and
    oversupplied populations, respectively, had values of 0 when running the
    model with search radii defined per population group. The output
    administrative units vector now has the correct values for these fields,
    consistent with the user's guide chapter.
    #1512
  • Fixed an issue where certain nodata values were not being handled
    correctly, leading to pixel values of +/- infinity in the urban nature
    balance output raster. #1519
  • Fixed an issue where an LULC raster without a nodata value would
    always raise in exception during reclassification.
    #1539

3.14.1

3.14.1 (2023-12-15)

• General
  • In advance of the numpy 2.0 release, function calls to numpy.product
    have been replaced with numpy.prod.
    #1410
  • Add support for python 3.11 #1103
  • Adding a docker container that is built on each commit where a change to
    model code, requirements, or the docker configuration has been made.
    #1115
  • Vector geometry types will now be validated for all models
    #1374
  • Datastack archives will now be correctly extracted
    #1308
  • Validation of tables has been improved and standardized, which should
    result in more readable validation errors.
    #1379
  • Updated to pygeoprocessing 2.4.2. This includes an update to
    pygeoprocessing.zonal_statistics, which is now more correct on certain
    edge cases. Aggregated model results may change slightly.
  • Removed the utils functions array_equals_nodata,
    exponential_decay_kernel_raster, and gaussian_decay_kernel_raster,
    which were obsoleted by new pygeoprocessing features.
  • Version metadata at import time is now fetched with
    importlib.metadata instead of pkg_resources.
    #1442
  • The API docs logo has been updated to use the latest version of the
    InVEST logo. #1463
• Workbench
  • Fixed a broken "Find my logfiles" button on MacOS.
    #1452
• Coastal Vulnerability
  • Fixed a bug where the model would crash when processing a float type
    bathymetry raster with no nodata value.
    #992
• Habitat Quality
  • Updated the threat table column description to clarify that the threat
    table columns: cur_path, fut_path, and base_path are meant
    to be file system path strings.
    #1455
• HRA
  • Fixed an issue preventing the HRA criteria table from loading when the
    table was UTF-8 encoded with a Byte-Order Marker.
    #1460
  • Fixed an issue with the cross-OS loading of InVEST datastack files.
    #1065
  • Fixed an issue where habitats and stressors in the criteria table were
    not being lowercased causing a comparison issue against values from the
    info table that were being lowercased.
    #1467
• NDR
  • Fixing an issue where minor geometric issues in the watersheds input
    (such as a ring self-intersection) would raise an error in the model.
    #1412
  • Fixed a task dependency issue where NDR would crash because of a race
    condition when run with n_workers > 0.
    #1426
  • Fixed an issue in NDR's effective retention where, on rasters with more
    than 2^31 pixels, the model would crash with an error relating to a
    negative (overflowed) index. #1431
• Pollination
  • Fixed a regression where nodata values were not being properly compared.
    This was only an issue in some development builds after 3.14.0.
    #1458
  • Replaced custom kernel implementation with pygeoprocessing.kernels.
    Convolution results may be slightly different (more accurate).
• SDR
  • Fixed an issue with SDR's sediment deposition where large regions would
    become nodata in cases where the DEM has valid data but other inputs
    (LULC, erosivity, erodibility) did not have valid pixels. Now, all
    raster inputs are mutually masked so that only those pixel stacks
    continue through to the model where all pixels in the stack are
    non-nodata. #911
  • RKLS, USLE, avoided erosion, and avoided export rasters will now have
    nodata in streams #1415
  • Fixed an issue in SDR's sediment deposition where, on rasters with more
    than 2^31 pixels, the model would crash with an error relating to a
    negative (overflowed) index. #1431
• Seasonal Water Yield
  • Fixed an issue in Seasonal Water Yield's baseflow routing and local
    recharge functions where, on rasters with more than 2^31 pixels, the
    model would crash with an error relating to a negative (overflowed)
    index. #1431
• Urban Cooling
  • Fixed a bug where model would error out if any feature in the buildings
    vector was missing a geometry; now they will be skipped
    #1401
• Wind Energy
  • Fixed a bug where model would error when the grid points path was empty
    #1417

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:

3.13.0

3.13.0 (2023-03-17)

• General
  • During builds of the InVEST documentation, the packages
    sphinx-rtd-theme and sphinx-reredirects will be pulled from
    conda-forge instead of PyPI. #1151
  • The invest command-line-interface no longer opens a graphical
    interface to InVEST. #755
  • The classic InVEST user-interface has been removed in favor of the Workbench.
  • Replace the ARGS_SPEC with MODEL_SPEC which describes all model
    outputs as well as inputs in a structured format #596
• Workbench
  • Added tooltips to the model tabs so that they can be identified even when
    several tabs are open #1088
  • Options' display names will now be shown in dropdown menus #1217
  • Represent boolean inputs with a toggle switch rather than radio buttons.
  • Includes local versions of the User Guide in English, Spanish, & Chinese.
    #851
• DelineateIt
  • DelineateIt now uses pygeoprocessing.routing.extract_streams_d8 for D8
    stream thresholding. #1143
• Habitat Quality
  • The model now uses an euclidean distance implementation for decaying
    threat rasters both linearly and exponentially. Since InVEST 3.3.0 a
    convolution implementation has been used, which reflected how
    the density of a threat or surrounding threat pixels could have an
    even greater, cumulative impact and degradation over space. However, this
    was never properly documented in the User's Guide and is not the approach
    taken in the publication. The convolution implementation also produced
    degradation and quality outputs that were difficult to interpret.
  • There should be a noticeable runtime improvement from calculating
    euclidean distances vs convolutions.
• HRA
  • Fixed an issue where a cryptic exception was being thrown if the criteria
    table's sections were not spelled exactly as expected. There is now a
    much more readable error if a section is obviously missing. Leading and
    trailing whitespace is also now removed from all string fields in the
    criteria table, which should also help reduce the chance of errors.
    #1191
• GLOBIO
  • Deprecated the GLOBIO model #1131
• RouteDEM
  • RouteDEM now uses pygeoprocessing.routing.extract_streams_d8 for D8
    stream thresholding. #1143
• Scenic Quality
  • Any points over nodata (and therefore excluded from the viewshed
    analysis) will now correctly have their FID reported in the logging.
    #1188
  • Clarifying where the visual quality calculations' disk-based sorting
    cache should be located, which addresses an interesting crash experienced
    by some users on Windows. #1189
• SDR
  • The ws_id field is no longer a required field in the watershed vector.
    #1201
• Seasonal Water Yield
  • If a soil group raster contains any pixels that are not in the set of
    allowed soil groups (anything other than 1, 2, 3 or 4), a human readable
    exception will now be raised. #1193
• Urban Nature Access
  • Added the Urban Nature Access model to InVEST. The model for urban
    nature access provides a measure of both the supply of urban nature
    and the demand for nature by the urban population, ultimately
    calculating the balance between supply and demand. See the corresponding
    User's Guide chapter for documentation.
• Visitation: Recreation and Tourism
  • Fixed a FutureWarning when reading in CSVs. This fix does not
    otherwise affect model behavior. #1202

3.12.1

This bugfix release includes the following fixes and features:

• General

  • Fixed a possible path traversal vulnerability when working with
    datastack archives. This patches CVE-2007-4559, reported to us
    by Trellix. #1113
  • Updating descriptions for LULC about text and biophysical table
    for clarity in model specs.
    #1077

• Workbench

  • Fixed a bug where the Workbench would become unresponsive during
    an InVEST model run if the model emitted a very high volume of
    log messages.
  • Fixed a bug where the Workbench could crash if there was too
    much standard error emitted from an invest model.
  • Added a new "Save as" dialog window to handle different save
    options, and allow the option to use relative paths in a JSON
    datastack
    (#1088)
  • Fixed a bug where uncaught exceptions in the React tree would
    result in a blank browser window.
    (#1119)

• Habitat Quality

  • All spatial inputs including the access vector and threat
    rasters are now reprojected to the lulc_cur_path raster. This
    fixes a bug where rasters with a different SRS would appear to
    not intersect the lulc_cur_path even if they did.
    (#1093)
  • Paths in the threats table may now be either absolute or
    relative to the threats table.

• HRA

  • Fixed a regression relative to InVEST 3.9.0 outputs where
    spatial criteria vectors were being rasterized with the
    ALL_TOUCHED=TRUE flag, leading to a perceived buffering of
    spatial criteria in certain cases. In InVEST 3.9.0, these were
    rasterized with ALL_TOUCHED=FALSE.
    #1120
  • Fixed an issue with the results table, SUMMARY_STATISTICS.csv
    where the percentages of high, medium and low risk
    classifications were not correctly reported.
  • Added a column to the SUMMARY_STATISTICS.csv output table to
    also report the percentage of pixels within each subregion that
    have no risk classification (a risk classification of 0).

• Urban Stormwater Retention

  • Added validation to check that the input soil groups raster has
    an integer data type

• Urban Cooling

  • Updated the text for the building_intensity column in the
    biophysical table to clarify that the values of this column
    should be normalized relative to one another to be between 0
    and 1.

3.12.0

This minor release includes the following fixes and features:

• General

  • Update python packaging settings to exclude a few config files
    and the workbench from source distributions and wheels
  • Updating SDR test values due to an update in GDAL's mode
    resampling algorithm. See
    #905
  • Updated our scipy requirement to fix a bug where invest
    crashed if a Windows user had a non-Latin character in their
    Windows username.

• Workbench

  • Fixed a bug where some model runs would not generate a new item
    in the list of recent runs.
  • Enhanced model input forms so that text boxes always show the
    rightmost end of the filepath when they overflow the box.

• Coastal Blue Carbon

  • Fixed a bug where using unaligned rasters in the preprocessor
    would cause an error. The preprocessor will now correctly align
    input landcover rasters and determine transitions from the
    aligned rasters.

• Habitat Quality

  • Removed a warning about an undefined nodata value in threat
    rasters because it is okay for a threat raster to have an
    undefined nodata value.

• HRA

  • Fixed an issue with risk calculations where risk values would be
    much lower than they should be. Risk values are now correctly
    calculated.
  • Fixed an issue with risk reclassifications where most pixels
    would end up classified as medium risk.
  • Added an input field to the model to indicate the number of
    overlapping stressors to use in risk reclassification
    calculations. This input affects the numerical boundaries
    between high, medium and low risk classifications.
  • Various improvements to the model have resulted in a modest
    (~33%) speedup in runtime.

• Coastal Vulnerability

  • Fixed a bug where redundant vertices in the landmass polygon
    could raise an error during shore point creation.

• NDR

  • Added parameters to the sample data to support nitrogen
    calculations.
  • Effective retention calculations have been reworked so that the
    source code more closely matches the mathematical definition in
    the NDR User's Guide. There should be no difference in outputs.

• SDR

  • We have made a significant update to the SDR model's outputs
    described here:
    https://github.com/natcap/peps/blob/main/pep-0010.md.
  • Specific changes include:
    • Legacy outputs sed_retention_index.tif and sed_retention.tif
      have been removed from the model.
    • Two new output rasters have been added, specifically
      • avoided_export.tif, indicating vegetation's contribution to
        reducing erosion on a pixel, as well as trapping of sediment
        originating upslope of the pixel, so that neither of these proceed
        downslope to enter a stream.
      • avoided_erosion.tif, vegetation’s contribution to reducing
        erosion from a pixel.
    • The summary watersheds vector no longer includes the sed_retent
      field and two fields have been added:
      • avoid_exp representing the sum of avoided export in the watershed.
      • avoid_eros representing the sum of avoided erosion in the watershed.
    • Sediment deposition, sed_deposition.tif, has been clarified to
      indicate the sediment that erodes from a pixel goes into the next
      downstream pixel(s) where it is either trapped or exported. This update
      removes a form of double-counting.

• Urban Flood Risk

  • Validation of the curve number table will now catch missing CN_*
    columns and warn the user about the missing column.

3.11.0

This minor release includes the following fixes and features:

• General

  • InVEST Workbench released! A new desktop interface for InVEST
    models.
  • Add support for python 3.10, and drop support for python 3.7.
  • Fixed a bug where the model window would fail to open when using
    the natcap.invest package with python 3.9.0 - 3.9.3.
  • spec_utils.ETO has been renamed to spec_utils.ET0 (with a
    zero).
  • Updating the pyinstaller requirement to >=4.10 to support
    the new universal2 wheel architecture offered by
    scipy>=1.8.0.
  • Now removing leading / trailing whitespaces from table input
    values as well as columns in most InVEST models.
  • Fixing a small bug where drag-and-drop events in the Qt UI were
    not being handled correctly and were being ignored by the UI.
  • Expose taskgraph logging level for the cli with
    --taskgraph-log-level.
  • Fixed bug in validation of results_suffix so that special
    characters like path separators, etc, are not allowed.
  • Fixed a bug in validation where a warning about non-overlapping
    spatial layers was missing info about the offending bounding
    boxes.

• Annual Water Yield

  • Fixed a bug where the model would error when the
    watersheds/subwatersheds input was in geopackage format.

• Crop Production

  • Fixed a bug in both crop production models where the model would
    error if an observed yield raster had no nodata value.

• DelineateIt

  • Watersheds delineated with this tool will now always have a
    ws_id column containing integer watershed IDs for easier use
    within the routed InVEST models. Existing ws_id field values
    in the outlets vector will be overwritten if they are present.

• RouteDEM

  • Rename the arg calculate_downstream_distance to
    calculate_downslope_distance. This is meant to clarify that it
    applies to pixels that are not part of a stream.

• SDR

  • Fixed an issue with SDR where f.tif might not be recalculated
    if the file is modified or deleted after execution.
  • Fixed an issue in sed_deposition.tif and f.tif where pixel
    values could have very small, negative values for r_i and
    f_i. These values are now clamped to 0.
  • Added basic type-checking for the lucode column of the
    biophysical table. This avoids cryptic numpy errors later in
    runtime.

• Seasonal Water Yield

  • Added an output to the model representing total annual
    precipitation.
  • Fixed an issue with the documentation for ET0 and Precip
    directories, where a module-specific informational string was
    being overridden by a default value.

3.10.2

• General
  • The minimum setuptools_scm version has been increased to 6.4.0 in
    order to bypass calling setup.py for version information. The
    version of this project can now be retrieved by calling python -m setuptools_scm from the project root.
  • Fixed an issue where datastack archives would not include any spatial
    datasets that were linked to in CSV files. This now works for all models
    except HRA. If an HRA datastack archive is requested,
    NotImplementedError will be raised. A fix for HRA is pending.
  • Pinned numpy versions in pyproject.toml to the lowest compatible
    version for each supported python version. This prevents issues when
    natcap.invest is used in an environment with a lower numpy version
    than it was built with (cython/cython#4452).
• DelineateIt
  • When snapping points to streams, if a point is equally near to more than
    one stream pixel, it will now snap to the stream pixel with a higher
    flow accumulation value. Before, it would snap to the stream pixel
    encountered first in the raster (though this was not guaranteed).
• HRA
  • Fixed a bug with how a pandas dataframe was instantiated. This bug did
    not effect outputs though some might notice less trailing zeros in the
    SUMMARY_STATISTICS.csv output.
• NDR
  • Changed some model inputs and outputs to clarify that subsurface
    phosphorus is not modeled.
    • Removed the inputs subsurface_critical_length_p and
      subsurface_eff_p
    • Removed the output sub_ndr_p.tif. The model no longer calculates
      subsurface NDR for phosphorus.
    • Removed the output sub_load_p.tif. All pixels in this raster were
      always 0, because the model assumed no subsurface phosphorus movement.
    • Renamed the output p_export.tif to p_surface_export.tif to
      clarify that it only models the surface export of phosphorus.
    • Renamed the output n_export.tif to n_total_export.tif to
      clarify that it is the total of surface and subsurface nitrogen export.
    • Added the new outputs n_surface_export.tif and
      n_subsurface_export.tif, showing the surface and subsurface
      components of the total nitrogen export.
    • The aggregate vector output watershed_results_ndr.shp was changed to
      a geopackage watershed_results_ndr.gpkg.
    • The aggregate vector fields were given more descriptive names, and
      updated corresponding to the changed raster outputs:
      • surf_p_ld was renamed to p_surface_load
      • surf_n_ld was renamed to n_surface_load
      • p_exp_tot was renamed to p_surface_export
      • sub_n_ld was renamed to n_subsurface_load
      • n_exp_tot was renamed to n_total_export
      • Added a new field n_surface_export, representing the sum of
        n_surface_export.tif
      • Added a new field n_subsurface_export, representing the sum
        of n_subsurface_export.tif
      • Removed the field sub_p_ld, since sub_load_p.tif was removed.
• Wind Energy
  • Fixed a bug where distance was masking by pixel distance instead of
    euclidean distance.
  • Renamed the foundation cost label and help info to reflect it is no
    longer measured in Millions of US dollars.
  • Fixed a bug where running valuation with TaskGraph in asynchronous mode
    would cause the model to error.

3.10.1

This bugfix release includes the following fixes and features:

• Urban Stormwater Retention
  • Fixed a bug where this model's sample data was not available via the Windows installer.

3.10.0

This minor release includes the following fixes and features:

• General

  • Add a --language argument to the command-line interface, which
    will translate model names, specs, and validation messages.
  • Accept a language query parameter at the UI server endpoints,
    which will translate model names, specs, and validation
    messages.
  • Added invest serve entry-point to the CLI. This launches a
    Flask app and server on the localhost, to support the workbench.
  • Major updates to each model's ARGS_SPEC (and some related
    validation) to facilitate re-use & display in the Workbench and
    User's Guide.
  • Standardized and de-duplicated text in ARGS_SPEC about and
    name strings.
  • Update to FontAwesome 5 icons in the QT interface.
  • In response to the deprecation of setup.py-based commands in
    Python 3.10, the recommended way to build python distributions
    of natcap.invest is now with the build package, and
    installation should be done via pip. The README has been
    updated to reflect this change, and this should only be
    noticeable for those installing natcap.invest from source.
  • A bug has been fixed in make install so that now the current
    version of natcap.invest is built and installed. The former
    (buggy) version of make install would install whatever the
    latest version was in your dist folder.
  • Updating the taskgraph requirement to 0.11.0 to resolve an
    issue where modifying a file within a roughly 2-second window
    would fool taskgraph into believing that the file had not been
    modified.
  • Fixed a bug where some input rasters with NaN nodata values
    would go undetected as nodata and yield unexpected behavior.

• Annual Water Yield

  • Renamed the Windows start menu shortcut from "Water Yield" to
    "Annual Water Yield".

• Coastal Vulnerability

  • Fixed bug where shore points were created on interior landmass
    holes (i.e. lakes).
  • Added feature to accept raster (in addition to vector) habitat
    layers.
  • Changed one intermediate output (geomorphology) from SHP to
    GPKG.
  • Fixed bug where output vectors had coordinates with an
    unnecessary z-dimension. Output vectors now have 2D geometry.

• Crop Pollination

  • Renamed the Windows start menu shortcut from "Pollination" to
    "Crop Pollination".

• Fisheries and Fisheries HST

  • The Fisheries models were deprecated due to lack of use, lack of
    scientific support staff, and maintenance costs.

• Finfish

  • The Finfish model was deprecated due to lack of use, lack of
    scientific support staff, and maintenance costs.

• Habitat Quality

  • Changed how Habitat Rarity outputs are calculated to be less
    confusing. Values now represent a 0 to 1 index where before
    there could be negative values. Now values of 0 indicate
    current/future LULC not represented in baseline LULC; values 0
    to 0.5 indicate more abundance in current/future LULC and
    therefore less rarity; values of 0.5 indicate same abundance
    between baseline and current/future LULC; values 0.5 to 1
    indicate less abundance in current/future LULC and therefore
    higher rarity.

• NDR

  • Added a new raster to the model's workspace,
    intermediate_outputs/what_drains_to_stream[suffix].tif. This
    raster has pixel values of 1 where DEM pixels flow to an
    identified stream, and 0 where they do not.

• Scenario Generator

  • Changed an args key from replacment_lucode to
    replacement_lucode.

• Scenic Quality

  • Simplify the valuation_function arg options. The options are
    now: linear, logarithmic, exponential. The names displayed
    in the UI dropdown will stay the same as before. Datastacks or
    scripts will need to be updated to use the new option values.
  • Renamed the model title from "Unobstructed Views: Scenic Quality
    Provision" to "Scenic Quality".

• SDR

  • Added a new raster to the model's workspace,
    intermediate_outputs/what_drains_to_stream[suffix].tif. This
    raster has pixel values of 1 where DEM pixels flow to an
    identified stream, and 0 where they do not.

• Urban Flood Risk:

  • Fixed broken documentation link in the user interface.

• Urban Stormwater Retention:

  • First release of this model.

• Visitation: Recreation and Tourism

  • Renamed the Windows start menu shortcut from "Recreation" to
    "Visitation: Recreation and Tourism".

• Wave Energy

  • Rename the analysis_area_path arg to analysis_area, since it
    is not a path but an option string.
  • Simplify the analysis_area arg options. The options are now:
    westcoast, eastcoast, northsea4, northsea10,
    australia, global. The names displayed in the UI dropdown
    will stay the same as before. Datastacks and scripts will need
    to be updated to use the new option values.

• Wind Energy

  • No model inputs or outputs are measured in "millions of"
    currency units any more. Specifically:
  • The mw_coef_ac and mw_coef_dc values in the Global Wind
    Energy Parameters table were in millions of currency units per
    MW; now they should be provided in currency units per MW.
  • The infield_cable_cost, cable_coef_ac, and cable_coef_dc
    values in the Global Wind Energy Parameters table were in
    millions of currency units per km; now they should be provided
    in currency units per km.
  • The turbine_cost value in the Turbine Parameters table was in
    millions of currency units; now it should be provided in
    currency units.
  • The foundation_cost parameter was in millions of currency
    units; now it should be provided in currency units.
  • The NPV output, formerly npv_US_millions.tif, is now
    npv.tif. It is now in currency units, not millions of currency
    units.