SWY Report

HISTORY.rst

@@ -61,10 +61,28 @@
   7. InVEST model Z (model names should be sorted A-Z)
 
 
+Unreleased Changes
+------------------
+
+Seasonal Water Yield
+====================
+* 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. (`#2321 <https://github.com/natcap/invest/issues/2321>`_)
+* The model now generates an additional output, a CSV containing average monthly
+  quickflow, baseflow, and precipitation values, in cubic meters per month, for
+  each feature in the AOI. This output is used by the report to generate some
+  plots. Note that this CSV is only created when the model is run without
+  inputting a Local Recharge raster.
+  (`#2321 <https://github.com/natcap/invest/issues/2321>`_)
+* Various updates to model output data metadata, including correcting the
+  units of some outputs.
+  (`#2450 <https://github.com/natcap/invest/issues/2450>`_)
+* Updated the naming convention of several monthly intermediate outputs to be
+  1-indexed rather than 0-indexed. This makes filenames consistent throughout
+  the model, where 1=January and 12=December.
+  (`#2451 <https://github.com/natcap/invest/issues/2451>`_)
 
-..
-  Unreleased Changes
-  ------------------
 
 3.18.0 (2026-02-25)
 -------------------

Makefile

@@ -6,7 +6,7 @@ GIT_SAMPLE_DATA_REPO_REV    := cfd1f07673e66823fd22989a2b87afb017aac447
 
 GIT_TEST_DATA_REPO          := https://bitbucket.org/natcap/invest-test-data.git
 GIT_TEST_DATA_REPO_PATH     := $(DATA_DIR)/invest-test-data
-GIT_TEST_DATA_REPO_REV      := c791f2b50e67680832054536899efacbc72e9e0b
+GIT_TEST_DATA_REPO_REV      := 94c4bc9f0f22082d2251b6b14063eb0ff4094451
 
 GIT_UG_REPO                 := https://github.com/natcap/invest.users-guide
 GIT_UG_REPO_PATH            := doc/users-guide

src/natcap/invest/carbon/reporter.py

@@ -201,7 +201,7 @@ def report(file_registry: dict, args_dict: dict, model_spec: ModelSpec,
     ]
 
     input_raster_stats_table = raster_utils.raster_inputs_summary(
-        args_dict).to_html(na_rep='')
+        args_dict, model_spec).to_html(na_rep='')
 
     output_raster_stats_table = raster_utils.raster_workspace_summary(
         file_registry).to_html(na_rep='')

src/natcap/invest/coastal_vulnerability/reporter.py

@@ -9,7 +9,7 @@
 from natcap.invest import __version__
 from natcap.invest import gettext
 import natcap.invest.spec
-from natcap.invest.reports import jinja_env
+from natcap.invest.reports import jinja_env, vector_utils
 
 
 LOGGER = logging.getLogger(__name__)
@@ -28,49 +28,6 @@
 POINT_SIZE = 20
 MAP_WIDTH = 450  # pixels
 
-LEGEND_CONFIG = {
-    'labelFontSize': 14,
-    'titleFontSize': 14,
-    'orient': 'left',
-    'gradientLength': 120
-}
-AXIS_CONFIG = {
-    'labelFontSize': 12,
-    'titleFontSize': 12,
-}
-
-
-def _get_geojson_bbox(geodataframe):
-    """Get the bounding box of a GeoDataFrame as a GeoJSON feature.
-
-    Also calculate its aspect ratio. These are useful for cropping
-    other layers in altair plots.
-
-    Args:
-        geodataframe (geopandas.GeoDataFrame):
-    Returns:
-        tuple: A 2-tuple containing:
-            - extent_feature (dict): A GeoJSON feature representing the bounding
-            box of the input GeoDataFrame.
-            - xy_ratio (float): The aspect ratio of the bounding box
-            (width/height).
-
-    """
-    xmin, ymin, xmax, ymax = geodataframe.total_bounds
-    xy_ratio = (xmax - xmin) / (ymax - ymin)
-    extent_feature = {
-        "type": "Feature",
-        "geometry": {"type": "Polygon",
-                     "coordinates": [[
-                         [xmax, ymax],
-                         [xmax, ymin],
-                         [xmin, ymin],
-                         [xmin, ymax],
-                         [xmax, ymax]]]},
-        "properties": {}
-    }
-    return extent_feature, xy_ratio
-
 
 def _chart_landmass(geodataframe, clip=False, extent_feature=None):
     landmass = altair.Chart(geodataframe).mark_geoshape(
@@ -134,13 +91,15 @@ def concat_habitats(row):
         ]
     )
 
-    _, xy_ratio = _get_geojson_bbox(exposure_geodf)
+    _, xy_ratio = vector_utils.get_geojson_bbox(exposure_geodf)
     habitat_map = landmass_chart + habitat_points
     habitat_map = habitat_map.properties(
         width=MAP_WIDTH,
         height=MAP_WIDTH / xy_ratio,
         title=gettext('The role of habitat in reducing coastal exposure')
-    ).configure_legend(**LEGEND_CONFIG).configure_axis(**AXIS_CONFIG)
+    ).configure_legend(
+        **vector_utils.LEGEND_CONFIG
+    ).configure_axis(**vector_utils.AXIS_CONFIG)
     return habitat_map
 
 
@@ -172,7 +131,7 @@ def report(file_registry, args_dict, model_spec, target_html_filepath):
 
     landmass_geo = geopandas.read_file(
         file_registry['clipped_projected_landmass'])
-    extent_feature, xy_ratio = _get_geojson_bbox(exposure_geo)
+    extent_feature, xy_ratio = vector_utils.get_geojson_bbox(exposure_geo)
     landmass_chart = _chart_landmass(
         landmass_geo, clip=True, extent_feature=extent_feature)
     base_points = _chart_base_points(exposure_geo)
@@ -247,7 +206,7 @@ def report(file_registry, args_dict, model_spec, target_html_filepath):
         width=MAP_WIDTH,
         height=MAP_WIDTH / xy_ratio,
         title='coastal exposure'
-    ).configure_legend(**LEGEND_CONFIG)
+    ).configure_legend(**vector_utils.LEGEND_CONFIG)
     exposure_map_json = exposure_map.to_json()
     exposure_map_caption = [model_spec.get_output(
         'coastal_exposure').get_field('exposure').about]
@@ -284,7 +243,7 @@ def report(file_registry, args_dict, model_spec, target_html_filepath):
     ).properties(
         width=MAP_WIDTH,
         height=200
-    ).configure_axis(**AXIS_CONFIG)
+    ).configure_axis(**vector_utils.AXIS_CONFIG)
     exposure_histogram_json = exposure_histogram.to_json()
 
     base_rank_vars_chart = base_points.mark_circle(
@@ -308,7 +267,7 @@ def report(file_registry, args_dict, model_spec, target_html_filepath):
     rank_vars_figure = altair.vconcat(
         altair.hconcat(*rank_vars_chart_list[:n_cols]),
         altair.hconcat(*rank_vars_chart_list[n_cols:])
-    ).configure_axis(**AXIS_CONFIG)
+    ).configure_axis(**vector_utils.AXIS_CONFIG)
     rank_vars_figure_json = rank_vars_figure.to_json()
     rank_vars_figure_caption = gettext(
         """
@@ -345,7 +304,7 @@ def report(file_registry, args_dict, model_spec, target_html_filepath):
         )
         histograms.append(hist)
     facetted_histograms = altair.hconcat(
-        *histograms).configure_axis(**AXIS_CONFIG)
+        *histograms).configure_axis(**vector_utils.AXIS_CONFIG)
     facetted_histograms_json = facetted_histograms.to_json()
     facetted_histograms_caption = model_spec.get_output(
         'intermediate_exposure').about
@@ -380,7 +339,7 @@ def report(file_registry, args_dict, model_spec, target_html_filepath):
         width=MAP_WIDTH + 30,  # extra space for legend
         height=MAP_WIDTH / xy_ratio,
         title=gettext('local wind-driven waves vs. open ocean waves')
-    ).configure_legend(**LEGEND_CONFIG)
+    ).configure_legend(**vector_utils.LEGEND_CONFIG)
     wave_energy_map_json = wave_energy_map.to_json()
 
     wave_energy_map_caption = [model_spec.get_output(