Skip to content

Commit f9c143d

Browse files
emlysemlys
committed
Merge branch 'release/3.15.0' into feature/routing-refactor
2 parents 30df1f3 + 51bc343 commit f9c143d

File tree

13 files changed

+440
-457
lines changed

13 files changed

+440
-457
lines changed

‎.github/workflows/release-part-1.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ jobs:
9797
run: rst2html5 HISTORY.rst workbench/changelog.html
9898

9999
- name: Update package.json version
100-
if: ${{ env.RUN }}
100+
if: env.RUN == 'true'
101101
uses: BellCubeDev/update-package-version-by-release-tag@v2
102102
with:
103103
version: ${{ inputs.version }}

‎HISTORY.rst

+179-95
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Changes should be grouped for readability.
2+
Changes should be grouped under headings for readability.
33
44
InVEST model names:
55
- Annual Water Yield
@@ -33,104 +33,188 @@
3333
Everything else:
3434
- General
3535

36-
.. :changelog:
36+
Updates worth drawing extra attention to (minor/major releases only):
37+
- Highlights
38+
39+
Each release section has a heading underlined with ``---``.
40+
Within a release section, underline group headings with ``===``.
41+
42+
For example:
43+
44+
Unreleased Changes
45+
------------------
46+
General
47+
=======
48+
* Updated something.
49+
50+
Wind Energy
51+
===========
52+
* Fixed something.
53+
54+
The order of groups should be as follows:
55+
1. Highlights
56+
2. General
57+
3. Workbench
58+
4. InVEST model A
59+
5. ...
60+
6. InVEST model Z (model names should be sorted A-Z)
61+
3762

3863

3964
Unreleased Changes
4065
------------------
41-
* General
42-
* Fixed an issue where a user's PROJ_DATA environment variable could
43-
trigger a RuntimeError about a missing proj.db file.
44-
https://github.com/natcap/invest/issues/1742
45-
* Now testing and building against Python 3.13.
46-
No longer testing and building with Python 3.8, which reached EOL.
47-
https://github.com/natcap/invest/issues/1755
48-
* All InVEST model output data now include metadata sidecar files.
49-
These are '.yml' files with the same basename as the dataset they
50-
describe. https://github.com/natcap/invest/issues/1662
51-
* InVEST's windows binaries are now distributed once again with a valid
52-
signature, signed by Stanford University.
53-
https://github.com/natcap/invest/issues/1580
54-
* The natcap.invest python package now officially supports linux.
55-
manylinux wheels will be available on PyPI.
56-
(`#1730 <https://github.com/natcap/invest/issues/1730>`_).
57-
* Workbench
58-
* Auto-scrolling of log output is halted on user-initiated scrolling,
59-
enabling easier inspection of log output while a model is running
60-
(`InVEST #1533 <https://github.com/natcap/invest/issues/1533>`_).
61-
* InVEST's mac disk image is now distributed once again with a valid
62-
signature, signed by Stanford University.
63-
https://github.com/natcap/invest/issues/1784
64-
* Annual Water Yield
65-
* Fixed an issue where the model would crash if the valuation table was
66-
provided, but the demand table was not. Validation will now warn about
67-
this, and the ``MODEL_SPEC`` has been improved to reflect that this table
68-
is now required when doing valuation.
69-
https://github.com/natcap/invest/issues/1769
70-
* Carbon
71-
* Updated styling of the HTML report generated by the carbon model, for
72-
visual consistency with the Workbench (`InVEST #1732
73-
<https://github.com/natcap/invest/issues/1732>`_).
74-
* Raster outputs that previously contained per-pixel values (e.g., t/pixel)
75-
now contain per-hectare values (e.g., t/ha). (`InVEST #1270
76-
<https://github.com/natcap/invest/issues/1270>`_).
77-
* Coastal Blue Carbon
78-
* The ``code`` column in the model's biophysical table input, as well as
79-
the ``code`` column in the preprocessor's LULC lookup table input and
80-
``carbon_pool_transient_template`` output, have been renamed ``lucode``,
81-
for consistency with other InVEST models (`InVEST #1249
82-
<https://github.com/natcap/invest/issues/1249>`_).
83-
* Crop Production
84-
* Raster outputs that previously contained per-pixel values (e.g., t/pixel)
85-
now contain per-hectare values (e.g., t/ha). This change affects both
86-
the Percentile and Regression models (`InVEST #1270
87-
<https://github.com/natcap/invest/issues/1270>`_).
88-
* Forest Carbon Edge Effect
89-
* Raster outputs that previously contained per-pixel values (e.g., t/pixel)
90-
now contain per-hectare values (e.g., t/ha). (`InVEST #1270
91-
<https://github.com/natcap/invest/issues/1270>`_).
92-
* Habitat Quality
93-
* The ``lulc`` column in the sensitivity table input, and the ``lulc_code``
94-
column in the rarity table outputs, have been renamed ``lucode``, for
95-
consistency with other InVEST models (`InVEST #1249
96-
<https://github.com/natcap/invest/issues/1249>`_).
97-
* The model now expects the maximum threat distance (``max_dist`` in the
98-
threats table) to be specified in ``m`` instead of ``km`` (`InVEST #1252
99-
<https://github.com/natcap/invest/issues/1252>`_).
100-
* NDR
101-
* Align rasters to the grid of the DEM raster
102-
(`#1488 <https://github.com/natcap/invest/issues/1488>`_).
103-
* Raster outputs that previously contained per-pixel values (e.g., kg/pixel)
104-
now contain per-hectare values (e.g., kg/ha). (`InVEST #1270
105-
<https://github.com/natcap/invest/issues/1270>`_).
106-
* D8 routing is now supported in addition to MFD
107-
(`#1440 <https://github.com/natcap/invest/issues/1440>`_).
108-
* Made the runoff proxy index calculation more robust by allowing users to
109-
specify the average runoff proxy, preventing normalization issues across
110-
different climate scenarios and watershed selections.
111-
https://github.com/natcap/invest/issues/1741
112-
* SDR
113-
* Raster outputs that previously contained per-pixel values (e.g., t/pixel)
114-
now contain per-hectare values (e.g., t/ha). (`InVEST #1270
115-
<https://github.com/natcap/invest/issues/1270>`_).
116-
* D8 routing is now supported in addition to MFD
117-
(`#1440 <https://github.com/natcap/invest/issues/1440>`_).
118-
* Seasonal Water Yield
119-
* D8 routing is now supported in addition to MFD
120-
(`#1440 <https://github.com/natcap/invest/issues/1440>`_).
121-
* Urban Cooling
122-
* Align rasters to the grid of the LULC raster, rather than the ET0 raster
123-
(`#1488 <https://github.com/natcap/invest/issues/1488>`_).
124-
* Updated the documentation for the ``mean_t_air`` attribute of the
125-
``buildings_with_stats.shp`` output to clarify how the value is
126-
calculated. https://github.com/natcap/invest/issues/1746
127-
* Fixed bug in the calculation of Cooling Capacity (CC) provided by parks,
128-
where the CC Index was not being properly incorporated.
129-
https://github.com/natcap/invest/issues/1726
130-
* Wind Energy
131-
* Fixed a bug that could cause the Workbench to crash when running the Wind
132-
Energy model with ``Taskgraph`` logging set to ``DEBUG`` (`InVEST #1497
133-
<https://github.com/natcap/invest/issues/1497>`_).
66+
Highlights
67+
==========
68+
* Multiple models now use **per-hectare** units in their raster outputs. Prior
69+
to this update, these rasters reported **per-pixel** values. This change
70+
affects the following models:
71+
72+
* Carbon
73+
* Crop Production
74+
* Forest Carbon Edge Effect
75+
* NDR
76+
* SDR
77+
* NDR, SDR, and Seasonal Water Yield now support the D8 routing algorithm
78+
in addition to MFD.
79+
80+
General
81+
=======
82+
* Fixed an issue where a user's PROJ_DATA environment variable could
83+
trigger a RuntimeError about a missing proj.db file.
84+
https://github.com/natcap/invest/issues/1742
85+
* Now testing and building against Python 3.13.
86+
No longer testing and building with Python 3.8, which reached EOL.
87+
https://github.com/natcap/invest/issues/1755
88+
* All InVEST model output data now include metadata sidecar files.
89+
These are '.yml' files with the same basename as the dataset they
90+
describe. https://github.com/natcap/invest/issues/1662
91+
* InVEST's Windows binaries are now distributed once again with a valid
92+
signature, signed by Stanford University.
93+
https://github.com/natcap/invest/issues/1580
94+
* InVEST's macOS disk image is now distributed once again with a valid
95+
signature, signed by Stanford University.
96+
https://github.com/natcap/invest/issues/1784
97+
* The natcap.invest python package now officially supports linux.
98+
manylinux wheels will be available on PyPI.
99+
(`#1730 <https://github.com/natcap/invest/issues/1730>`_)
100+
* Removed the warning about ``gdal.UseExceptions()``.
101+
Python API users should still call ``gdal.UseExceptions()``, but no
102+
longer need to do so before importing ``natcap.invest``.
103+
https://github.com/natcap/invest/issues/1702
104+
105+
Workbench
106+
=========
107+
* Auto-scrolling of log output is halted on user-initiated scrolling,
108+
enabling easier inspection of log output while a model is running
109+
(`InVEST #1533 <https://github.com/natcap/invest/issues/1533>`_).
110+
111+
Annual Water Yield
112+
==================
113+
* Fixed an issue where the model would crash if the valuation table was
114+
provided, but the demand table was not. Validation will now warn about
115+
this, and the ``MODEL_SPEC`` has been improved to reflect that this table
116+
is now required when doing valuation.
117+
https://github.com/natcap/invest/issues/1769
118+
119+
Carbon
120+
======
121+
* Updated styling of the HTML report generated by the carbon model, for
122+
visual consistency with the Workbench (`InVEST #1732
123+
<https://github.com/natcap/invest/issues/1732>`_).
124+
* Raster outputs that previously contained per-pixel values (e.g., t/pixel)
125+
now contain per-hectare values (e.g., t/ha). (`InVEST #1270
126+
<https://github.com/natcap/invest/issues/1270>`_).
127+
* Removed the REDD scenario and updated the naming of the Current and
128+
Future scenarios to Baseline and Alternate, respectively, to better
129+
indicate that users are not limited to comparing present and future.
130+
(`InVEST #1758 <https://github.com/natcap/invest/issues/1758>`_).
131+
* Changed output filename prefixes from ``tot_c`` to ``c_storage`` and
132+
``delta`` to ``c_change``. (`InVEST #1825
133+
<https://github.com/natcap/invest/issues/1825>`_).
134+
* Fixed bug where discount rate and annual price change were incorrectly
135+
treated as ratios instead of percentages. (`InVEST #1827
136+
<https://github.com/natcap/invest/issues/1827>`_).
137+
138+
Coastal Blue Carbon
139+
===================
140+
* The ``code`` column in the model's biophysical table input, as well as
141+
the ``code`` column in the preprocessor's LULC lookup table input and
142+
``carbon_pool_transient_template`` output, have been renamed ``lucode``,
143+
for consistency with other InVEST models (`InVEST #1249
144+
<https://github.com/natcap/invest/issues/1249>`_).
145+
146+
Crop Production
147+
===============
148+
* Raster outputs that previously contained per-pixel values (e.g., t/pixel)
149+
now contain per-hectare values (e.g., t/ha). This change affects both
150+
the Percentile and Regression models (`InVEST #1270
151+
<https://github.com/natcap/invest/issues/1270>`_).
152+
153+
Forest Carbon Edge Effect
154+
=========================
155+
* Raster outputs that previously contained per-pixel values (e.g., t/pixel)
156+
now contain per-hectare values (e.g., t/ha). (`InVEST #1270
157+
<https://github.com/natcap/invest/issues/1270>`_).
158+
159+
Habitat Quality
160+
===============
161+
* The ``lulc`` column in the sensitivity table input, and the ``lulc_code``
162+
column in the rarity table outputs, have been renamed ``lucode``, for
163+
consistency with other InVEST models (`InVEST #1249
164+
<https://github.com/natcap/invest/issues/1249>`_).
165+
* The model now expects the maximum threat distance (``max_dist`` in the
166+
threats table) to be specified in ``m`` instead of ``km`` (`InVEST #1252
167+
<https://github.com/natcap/invest/issues/1252>`_).
168+
* Adjusted total habitat degradation calculation to calculate degradation
169+
for each threat and create intermediate degradation rasters. Total
170+
degradation is now calculated using these individual threat degradation
171+
rasters.
172+
https://github.com/natcap/invest/issues/1100
173+
174+
NDR
175+
===
176+
* Align rasters to the grid of the DEM raster
177+
(`#1488 <https://github.com/natcap/invest/issues/1488>`_).
178+
* Raster outputs that previously contained per-pixel values (e.g., kg/pixel)
179+
now contain per-hectare values (e.g., kg/ha). (`InVEST #1270
180+
<https://github.com/natcap/invest/issues/1270>`_).
181+
* Made the runoff proxy index calculation more robust by allowing users to
182+
specify the average runoff proxy, preventing normalization issues across
183+
different climate scenarios and watershed selections.
184+
https://github.com/natcap/invest/issues/1741
185+
* D8 routing is now supported in addition to MFD
186+
(`#1440 <https://github.com/natcap/invest/issues/1440>`_).
187+
188+
SDR
189+
===
190+
* Raster outputs that previously contained per-pixel values (e.g., t/pixel)
191+
now contain per-hectare values (e.g., t/ha). (`InVEST #1270
192+
<https://github.com/natcap/invest/issues/1270>`_).
193+
* D8 routing is now supported in addition to MFD
194+
(`#1440 <https://github.com/natcap/invest/issues/1440>`_).
195+
196+
Seasonal Water Yield
197+
====================
198+
* D8 routing is now supported in addition to MFD
199+
(`#1440 <https://github.com/natcap/invest/issues/1440>`_).
200+
201+
Urban Cooling
202+
=============
203+
* Align rasters to the grid of the LULC raster, rather than the ET0 raster
204+
(`#1488 <https://github.com/natcap/invest/issues/1488>`_).
205+
* Updated the documentation for the ``mean_t_air`` attribute of the
206+
``buildings_with_stats.shp`` output to clarify how the value is
207+
calculated. https://github.com/natcap/invest/issues/1746
208+
* Fixed bug in the calculation of Cooling Capacity (CC) provided by parks,
209+
where the CC Index was not being properly incorporated.
210+
https://github.com/natcap/invest/issues/1726
211+
212+
Wind Energy
213+
===========
214+
* Fixed a bug that could cause the Workbench to crash when running the Wind
215+
Energy model with ``Taskgraph`` logging set to ``DEBUG`` (`InVEST #1497
216+
<https://github.com/natcap/invest/issues/1497>`_).
217+
134218

135219
3.14.3 (2024-12-19)
136220
-------------------

‎Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
DATA_DIR := data
33
GIT_SAMPLE_DATA_REPO := https://bitbucket.org/natcap/invest-sample-data.git
44
GIT_SAMPLE_DATA_REPO_PATH := $(DATA_DIR)/invest-sample-data
5-
GIT_SAMPLE_DATA_REPO_REV := c0fc8a2966e43275ff6095ba3419d2f2ddf08686
5+
GIT_SAMPLE_DATA_REPO_REV := dc0146c31c7cdc4c252572586437b525ef6c9154
66

77
GIT_TEST_DATA_REPO := https://bitbucket.org/natcap/invest-test-data.git
88
GIT_TEST_DATA_REPO_PATH := $(DATA_DIR)/invest-test-data
99
GIT_TEST_DATA_REPO_REV := 4eb5a2fac4818a37663780c4cbdff1b41e7019be
1010

1111
GIT_UG_REPO := https://github.com/natcap/invest.users-guide
1212
GIT_UG_REPO_PATH := doc/users-guide
13-
GIT_UG_REPO_REV := 79cc80687052c870bbba67e9ee2e68e67dcec145
13+
GIT_UG_REPO_REV := 4c2ab01589d991cc4c5aab88ab5b40333879da84
1414

1515
ENV = "./env"
1616
ifeq ($(OS),Windows_NT)

‎src/natcap/invest/__init__.py

-10
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,8 @@
44
import os
55
import sys
66
from gettext import translation
7-
import warnings
87

98
import babel
10-
from osgeo import gdal
119

1210
LOGGER = logging.getLogger('natcap.invest')
1311
LOGGER.addHandler(logging.NullHandler())
@@ -34,14 +32,6 @@
3432
locale: babel.Locale(locale).display_name for locale in LOCALES
3533
}
3634

37-
if not gdal.GetUseExceptions():
38-
warnings.warn(('''
39-
natcap.invest requires GDAL exceptions to be enabled. You must
40-
call gdal.UseExceptions() to avoid unexpected behavior from
41-
natcap.invest. A future version will enable exceptions on import.
42-
gdal.UseExceptions() affects global state, so this may affect the
43-
behavior of other packages.'''), FutureWarning)
44-
4535

4636
def set_locale(locale_code):
4737
"""Set the `gettext` attribute of natcap.invest.

0 commit comments

Comments
 (0)