Merge the 3.13.0 release branch into main

.github/workflows/build-and-test.yml

@@ -75,7 +75,7 @@ jobs:
         uses: ./.github/actions/setup_env
         with:
           python-version: ${{ matrix.python-version }}
-          requirements-files: requirements.txt requirements-dev.txt requirements-gui.txt
+          requirements-files: requirements.txt requirements-dev.txt
           requirements: ${{ env.CONDA_DEFAULT_DEPENDENCIES }}
 
       - name: Download previous conda environment.yml
@@ -218,39 +218,6 @@ jobs:
       - name: Validate user guide links
         run: make validate_userguide_filenames
 
-  run-ui-tests:
-    name: Run UI Tests
-    runs-on: windows-latest
-    needs: check-syntax-errors
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: [3.8, 3.9, "3.10"]
-
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0 # Fetch complete history for accurate versioning
-
-      - name: Restore git-LFS test data cache
-        uses: actions/cache@v3
-        with:
-          path: data/invest-test-data
-          key: git-lfs-testdata-${{ hashfiles('Makefile') }}
-
-      - uses: ./.github/actions/setup_env
-        with:
-          python-version: ${{ matrix.python-version }}
-          requirements-files: requirements.txt requirements-dev.txt requirements-gui.txt
-          requirements: ${{ env.CONDA_DEFAULT_DEPENDENCIES }}
-
-      - name: Make install
-        run: make install
-
-      - name: Run UI tests
-        timeout-minutes: 10  # tests usually take < 2 minutes, so 10 is generous.
-        run: make test_ui
-
   run-workbench-tests:
     name: Run Workbench Tests
     runs-on: ${{ matrix.os }}
@@ -271,7 +238,7 @@ jobs:
         uses: ./.github/actions/setup_env
         with:
           python-version: ${{ env.LATEST_SUPPORTED_PYTHON_VERSION }}
-          requirements-files: requirements.txt requirements-dev.txt requirements-gui.txt
+          requirements-files: requirements.txt requirements-dev.txt
           requirements: ${{ env.CONDA_DEFAULT_DEPENDENCIES }}
 
       - name: Make install
@@ -312,12 +279,10 @@ jobs:
         os: [macos-latest, windows-latest]
         include:
           - os: macos-latest
-            binary-make-command: mac_dmg
             puppeteer-log: ~/Library/Logs/invest-workbench/
             workspace-path: InVEST-failed-mac-workspace.tar
             binary-extension: dmg
           - os: windows-latest
-            binary-make-command: windows_installer
             puppeteer-log: ~/AppData/Roaming/invest-workbench/logs/
             workspace-path: ${{ github.workspace }}
             binary-extension: exe
@@ -326,9 +291,15 @@ jobs:
         with:
           fetch-depth: 0 # Fetch complete history for accurate versioning
 
-      - name: Install build dependencies (macOS)
-        if: matrix.os == 'macos-latest'
-        run: brew install create-dmg
+      - name: Set up conda environment
+        uses: ./.github/actions/setup_env
+        with:
+          python-version: ${{ env.LATEST_SUPPORTED_PYTHON_VERSION }}
+          requirements-files: requirements.txt requirements-dev.txt requirements-docs.txt
+          requirements: ${{ env.CONDA_DEFAULT_DEPENDENCIES }} pandoc
+
+      - name: Make install
+        run: make install
 
         # Not caching chocolatey packages because the cache may not be reliable
         # https://github.com/chocolatey/choco/issues/2134
@@ -341,43 +312,17 @@ jobs:
           $env:PATH += ";C:\ProgramData\chocolatey\bin"
           refreshenv  # Choco-provided command to reload environment variables
 
-      - name: Restore cached NSIS plugins (Windows)
-        id: restore-nsis-cache
-        if: matrix.os == 'windows-latest'
-        uses: actions/cache@v3
-        with:
-          path: | # update this list of paths if windows-ci-binary-install.ps1 changes
-            C:\Program Files (x86)\NSIS\Plugins\x86-ansi\nsProcess.dll
-            C:\Program Files (x86)\NSIS\Include\nsProcess.nsh
-            C:\Program Files (x86)\NSIS\Plugins\x86-ansi\INetC.dll
-            C:\Program Files (x86)\NSIS\Plugins\x86-ansi\nsisunz.dll
-            C:\Program Files (x86)\NSIS\Plugins\x86-ansi\StdUtils.dll
-            C:\Program Files (x86)\NSIS\Plugins\x86-ansi\UAC.dll
-            C:\Program Files (x86)\NSIS\Include\NsisMultiUser.nsh
-            C:\Program Files (x86)\NSIS\Include\NsisMultiUserLang.nsh
-            C:\Program Files (x86)\NSIS\Include\StdUtils.nsh
-            C:\Program Files (x86)\NSIS\Include\UAC.nsh
-            C:\Program Files (x86)\NSIS\Include\Utils.nsh
-            C:\Program Files (x86)\NSIS\Include\un.Utils.nsh
-          key: NSIS-plugins--${{ hashFiles('ci/windows-ci-binary-install.ps1') }}
-
-      - name: Download NSIS plugins (Windows)  # only if they couldn't be restored from the cache
-        if: matrix.os == 'windows-latest' && steps.restore-nsis-cache.outputs.cache-hit != 'true'
-        shell: powershell
-        run: ./ci/windows-ci-binary-install.ps1
-
-      - name: Set up conda environment
-        uses: ./.github/actions/setup_env
-        with:
-          python-version: ${{ env.LATEST_SUPPORTED_PYTHON_VERSION }}
-          requirements-files: requirements.txt requirements-dev.txt requirements-docs.txt requirements-gui.txt
-          requirements: ${{ env.CONDA_DEFAULT_DEPENDENCIES }} pandoc
-
-      - name: Make install
-        run: make install
+      - name: Build userguide
+        run: make userguide
 
       - name: Build binaries
-        run: make CONDA=micromamba ${{ matrix.binary-make-command }}
+        run: make CONDA=micromamba binaries
+
+      - name: Run invest-autotest with binaries
+        if : |
+          github.event_name == 'push' &&
+          (contains(github.ref, 'release') || github.ref == 'refs/heads/main')
+        run: make invest_autotest
 
       - name: Install Node.js
         uses: actions/setup-node@v3
@@ -428,9 +373,8 @@ jobs:
           CERT_FILE: 2025-01-16-Expiry-AppStore-App.p12
           CERT_PASS: ${{ secrets.MACOS_CODESIGN_CERT_PASS }}
         run: |
-          INSTALLER_BINARY=$(find "$(pwd)/dist" -type f -name 'InVEST_*.dmg' | head -n 1)
           WORKBENCH_BINARY=$(find "$(pwd)/workbench/dist" -type f -name 'invest_*.dmg' | head -n 1)
-          make BIN_TO_SIGN="$INSTALLER_BINARY" WORKBENCH_BIN_TO_SIGN="$WORKBENCH_BINARY" codesign_mac
+          make WORKBENCH_BIN_TO_SIGN="$WORKBENCH_BINARY" codesign_mac
 
       - name: Sign binaries (Windows)
         if: github.event_name != 'pull_request' && matrix.os == 'windows-latest' # secrets not available in PR
@@ -440,21 +384,13 @@ jobs:
         run: |
           # figure out the path to signtool.exe (it keeps changing with SDK updates)
           SIGNTOOL_PATH=$(find 'C:\\Program Files (x86)\\Windows Kits\\10' -type f -name 'signtool.exe*' | head -n 1)
-          INSTALLER_BINARY=$(find "$(pwd)/dist" -type f -name 'InVEST_*.exe' | head -n 1)
           WORKBENCH_BINARY=$(find "$(pwd)/workbench/dist" -type f -name 'invest_*.exe' | head -n 1)
-          make BIN_TO_SIGN="$INSTALLER_BINARY" WORKBENCH_BIN_TO_SIGN="$WORKBENCH_BINARY" SIGNTOOL="$SIGNTOOL_PATH" codesign_windows
+          make WORKBENCH_BIN_TO_SIGN="$WORKBENCH_BINARY" SIGNTOOL="$SIGNTOOL_PATH" codesign_windows
 
       - name: Deploy artifacts to GCS
         if: github.event_name != 'pull_request'
         run: make deploy
 
-      - name: Upload binary artifact
-        if: always()
-        uses: actions/upload-artifact@v3
-        with:
-          name: InVEST-${{ runner.os }}-binary
-          path: dist/*.${{ matrix.binary-extension }}
-
       - name: Upload workbench binary artifact
         if: always()
         uses: actions/upload-artifact@v3

.readthedocs_environment.yml

@@ -17,4 +17,3 @@ dependencies:
   - -r requirements.txt
   - -r requirements-dev.txt
   - -r requirements-docs.txt
-  - -r requirements-gui.txt

HISTORY.rst

@@ -14,17 +14,18 @@
   - Habitat Quality
   - HRA
   - NDR
-  - Visitation: Recreation and Tourism
   - RouteDEM
   - Scenario Generator
   - Scenic Quality
   - SDR
   - Seasonal Water Yield
   - Urban Cooling
   - Urban Flood Risk
+  - Urban Nature Access
   - Urban Stormwater Retention
   - Wave Energy
   - Wind Energy
+  - Visitation: Recreation and Tourism
 
   Workbench fixes/enhancements:
   - Workbench
@@ -34,23 +35,54 @@
 
 .. :changelog:
 
-Unreleased Changes
-------------------
+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 <https://github.com/natcap/invest/issues/1151>`_)
+    * The ``invest`` command-line-interface no longer opens a graphical
+      interface to InVEST. (`#755 <https://github.com/natcap/invest/issues/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 <https://github.com/natcap/invest/issues/596>`_)
 * Workbench
     * Added tooltips to the model tabs so that they can be identified even when
       several tabs are open (`#1071 <https://github.com/natcap/invest/issues/1088>`_)
+    * Options' display names will now be shown in dropdown menus
+      (`#1217 <https://github.com/natcap/invest/issues/1217>`_)
+    * Represent boolean inputs with a toggle switch rather than radio buttons.
+    * Includes local versions of the User Guide in English, Spanish, & Chinese.
+      https://github.com/natcap/invest/issues/851
+* DelineateIt
+    * DelineateIt now uses ``pygeoprocessing.routing.extract_streams_d8`` for D8
+      stream thresholding. https://github.com/natcap/invest/issues/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.
       https://github.com/natcap/invest/issues/1191
+* GLOBIO
+    * Deprecated the GLOBIO model
+      (`#1131 <https://github.com/natcap/invest/issues/1131>`_)
+* RouteDEM
+    * RouteDEM now uses ``pygeoprocessing.routing.extract_streams_d8`` for D8
+      stream thresholding. https://github.com/natcap/invest/issues/1143
 * Scenic Quality
     * Any points over nodata (and therefore excluded from the viewshed
       analysis) will now correctly have their FID reported in the logging.
@@ -65,6 +97,12 @@ Unreleased Changes
     * 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. https://github.com/natcap/invest/issues/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. https://github.com/natcap/invest/issues/1202
@@ -76,6 +114,8 @@ Unreleased Changes
     * Fixed a possible path traversal vulnerability when working with datastack
       archives.  This patches CVE-2007-4559, reported to us by Trellix.
       https://github.com/natcap/invest/issues/1113
+    * Added Spanish and Chinese translations of user-facing text and an interface
+      to switch languages in the workbench UI.
     * Updating descriptions for LULC about text and biophysical table for
       clarity in model specs. https://github.com/natcap/invest/issues/1077
 * Workbench

MANIFEST.in

@@ -5,3 +5,4 @@ prune ci
 prune exe
 prune installer
 prune workbench
+include src/natcap/invest/internationalization/locales/*/LC_MESSAGES/messages.mo