From 26df144b92a0362e483cf184c93a128607f2786d Mon Sep 17 00:00:00 2001 From: Megan Nissel Date: Mon, 23 Mar 2026 11:20:50 -0400 Subject: [PATCH] add report and new csv to the swy outputs list; update units to reflect timescale (#223) --- source/en/seasonal_water_yield.rst | 42 +++++++++++++++++++--------- source/es/seasonal_water_yield.rst | 44 ++++++++++++++++++++---------- source/zh/seasonal_water_yield.rst | 24 +++++++++++++--- 3 files changed, 79 insertions(+), 31 deletions(-) diff --git a/source/en/seasonal_water_yield.rst b/source/en/seasonal_water_yield.rst index 556d1e0c..bb84d1db 100644 --- a/source/en/seasonal_water_yield.rst +++ b/source/en/seasonal_water_yield.rst @@ -456,39 +456,55 @@ The resolution of the output rasters will be the same as the resolution of the D * **Parameter log**: Each time the model is run, a text (.txt) file will be created in the Workspace. The file will list the parameter values and output messages for that run and will be named according to the service, the date and time. When contacting NatCap about errors in a model run, please include the parameter log. - * **B_[Suffix].tif** (type: raster; units: mm, but should be interpreted as relative values, not absolute): Map of baseflow :math:`B` values, the contribution of a pixel to slow release flow (which is not evapotranspired before it reaches the stream) + * **seasonal_water_yield_report_[Suffix].html:** A summary of a model run, including visualizations of key outputs, tables of calculated results, and information about model inputs. The report can be accessed in the Workbench or opened with any web browser. For an example, see the `Sample Seasonal Water Yield Report `_, generated by running the SWY model with the SWY sample data. - * **B_sum_[Suffix].tif** (type: raster; units: mm, but should be interpreted as relative values, not absolute): Map of :math:`B_{\text{sum}}`\ values, the flow through a pixel, contributed by all upslope pixels, that is not evapotranspired before it reaches the stream + * **B_[Suffix].tif** (type: raster; units: mm/year, but should be interpreted as relative values, not absolute): Map of baseflow :math:`B` values, the contribution of a pixel to slow release flow (which is not evapotranspired before it reaches the stream) + + * **B_sum_[Suffix].tif** (type: raster; units: mm/year, but should be interpreted as relative values, not absolute): Map of :math:`B_{\text{sum}}`\ values, the flow through a pixel, contributed by all upslope pixels, that is not evapotranspired before it reaches the stream * **CN_[Suffix].tif** (type: raster): Map of curve number values - * **L_avail_[Suffix].tif** (type: raster; units: mm, but should be interpreted as relative values, not absolute): Map of available local recharge :math:`L_{\text{avail}}` + * **L_avail_[Suffix].tif** (type: raster; units: mm/year, but should be interpreted as relative values, not absolute): Map of available local recharge :math:`L_{\text{avail}}` - * **L_[Suffix].tif** (type: raster; units: mm, but should be interpreted as relative values, not absolute): Map of local recharge :math:`L` values + * **L_[Suffix].tif** (type: raster; units: mm/year, but should be interpreted as relative values, not absolute): Map of local recharge :math:`L` values - * **L_sum_avail_[Suffix].tif** (type: raster; units: mm, but should be interpreted as relative values, not absolute): Map of :math:`L_{\text{sum.avail}}` values, the available water to a pixel, contributed by all upslope pixels, that is available for evapotranspiration by this pixel + * **L_sum_avail_[Suffix].tif** (type: raster; units: mm/year, but should be interpreted as relative values, not absolute): Map of :math:`L_{\text{sum.avail}}` values, the available water to a pixel, contributed by all upslope pixels, that is available for evapotranspiration by this pixel - * **L_sum_[Suffix].tif** (type: raster; units: mm, but should be interpreted as relative values, not absolute): Map of :math:`L_{\text{sum}}` values, the flow through a pixel, contributed by all upslope pixels, that is available for evapotranspiration to downslope pixels + * **L_sum_[Suffix].tif** (type: raster; units: mm/year, but should be interpreted as relative values, not absolute): Map of :math:`L_{\text{sum}}` values, the flow through a pixel, contributed by all upslope pixels, that is available for evapotranspiration to downslope pixels * **P_[Suffix].tif** (type: raster; units: mm/year): The total precipitation across all months on this pixel. - * **QF_[Suffix].tif** (type: raster; units: mm): Map of annual quickflow (QF) values + * **QF_[Suffix].tif** (type: raster; units: mm/year): Map of annual quickflow (QF) values * **stream_[Suffix].tif** (type: raster): Stream network generated from the input DEM and Threshold Flow Accumulation. Values of 1 represent streams, values of 0 are non-stream pixels. - * **Vri_[Suffix].tif** (type: raster; units: mm): Map of the values of recharge (contribution, positive or negative), to the total recharge + * **Vri_[Suffix].tif** (type: raster; units: mm/year): Map of the values of recharge (contribution, positive or negative), to the total recharge * **aggregated_results_swy_[Suffix].shp**: Table containing biophysical values for each watershed, with fields as follows: - * **qb** (units: mm, but should be interpreted as relative values, not absolute): Mean local recharge value within the watershed - - * **vri_sum** (units: mm): total recharge contribution, (positive or negative) within the watershed. The sum of ``Vri_[Suffix].tif`` pixel values within the watershed. + * **qb** (units: mm/year, but should be interpreted as relative values, not absolute): Mean local recharge value within the watershed + + * **vri_sum** (units: mm/year): total recharge contribution (positive or negative) within the watershed. The sum of ``Vri_[Suffix].tif`` pixel values within the watershed. + + * **geom_id**: a unique ID for the watershed + + * **monthly_quickflow_baseflow_[Suffix].csv**: Table of average monthly baseflow, quickflow, and precipitation values for each watershed (or feature) within the AOI. This CSV is only created if a local recharge raster was not provided as a model input. Includes the following fields: + + * **geom_id**: A unique ID for the watershed. This will correspond to the ``geom_id`` column in ``aggregated_results_swy_[Suffix].shp``. + + * **month**: Values are the numbers 1-12 corresponding to each month, January (1) through December (12). + + * **quickflow** (units: cubic meters/month): The average quickflow value for the month in the watershed. + + * **baseflow** (units: cubic meters/month): The average baseflow value for the month in the watershed. Since baseflow is calculated on an annual scale, the values for each watershed have been distributed evenly across the year (annual average divided by 12). + + * **precipitation** (units: cubic meters/month): The average precipitation value for the month in the watershed. Values are based on the aligned input monthly precipitation rasters. * **[Workspace]\\intermediate_outputs** folder: - * **aet_[Suffix].tif** (type: raster; units: mm): Map of actual evapotranspiration (AET) + * **aet_[Suffix].tif** (type: raster; units: mm/year): Map of actual evapotranspiration (AET) - * **qf_1_[Suffix].tif...qf_12_[Suffix].tif** (type: raster; units: mm): Maps of monthly quickflow (1 = January... 12 = December) + * **qf_1_[Suffix].tif...qf_12_[Suffix].tif** (type: raster; units: mm/month): Maps of monthly quickflow (1 = January... 12 = December) * **Si_[Suffix].tif** (type: raster; units: inches): Maximum potential retention, used in the calculation of quickflow. (Note that the unit is converted to mm in Eq. :eq:`(swy. 1)`). diff --git a/source/es/seasonal_water_yield.rst b/source/es/seasonal_water_yield.rst index da289fe8..0be2aeaf 100644 --- a/source/es/seasonal_water_yield.rst +++ b/source/es/seasonal_water_yield.rst @@ -325,7 +325,7 @@ Para permitir que la subvención de la pendiente sea temporalmente variable, ust Interpretación de los resultados --------------------------------- +================================ La resolución de los rásteres de resultados será la misma que la del MDE que se proporciona como input. @@ -333,37 +333,53 @@ La resolución de los rásteres de resultados será la misma que la del MDE que * **Registro de parámetros**: Cada vez que se ejecute el modelo, se creará un archivo de texto (.txt) en el Espacio de Trabajo. El archivo enumerará los valores de los parámetros y los mensajes de salida para esa ejecución y se nombrará según el servicio, la fecha y la hora. Cuando se ponga en contacto con NatCap por errores en una ejecución del modelo, incluya el registro de parámetros. - * **B_[Sufijo].tif** (tipo: ráster; unidades: mm, pero deben interpretarse como valores relativos, no absolutos): Mapa de valores de flujo base :math:`B`, la contribución de un píxel al flujo de liberación lenta (que no se evapotranspira antes de llegar a la corriente) + * **seasonal_water_yield_report_[Suffix].html:** A summary of a model run, including visualizations of key outputs, tables of calculated results, and information about model inputs. The report can be accessed in the Workbench or opened with any web browser. For an example, see the `Sample Seasonal Water Yield Report `_, generated by running the SWY model with the SWY sample data. + + * **B_[Sufijo].tif** (tipo: ráster; unidades: mm/año, pero deben interpretarse como valores relativos, no absolutos): Mapa de valores de flujo base :math:`B`, la contribución de un píxel al flujo de liberación lenta (que no se evapotranspira antes de llegar a la corriente) - * **B_sum_[Sufijo].tif** (tipo: ráster; unidades: mm, pero deben interpretarse como valores relativos, no absolutos): Mapa de valores :math:`B_{text{sum}`, el flujo que atraviesa un píxel, aportado por todos los píxeles de la ladera, que no es evapotranspirado antes de llegar a la corriente + * **B_sum_[Sufijo].tif** (tipo: ráster; unidades: mm/año, pero deben interpretarse como valores relativos, no absolutos): Mapa de valores :math:`B_{text{sum}`, el flujo que atraviesa un píxel, aportado por todos los píxeles de la ladera, que no es evapotranspirado antes de llegar a la corriente * **CN_[Sufijo].tif** (tipo: ráster): Mapa de los valores del número de la curva - * **L_avail_[Sufijo].tif** (tipo: ráster; unidades: mm, pero deben interpretarse como valores relativos, no absolutos): Mapa de la recarga local disponible :math:`L_{\text{avail}}` + * **L_avail_[Sufijo].tif** (tipo: ráster; unidades: mm/año, pero deben interpretarse como valores relativos, no absolutos): Mapa de la recarga local disponible :math:`L_{\text{avail}}` - * **L_[Sufijo].tif** (tipo: ráster; unidades: mm, pero deben interpretarse como valores relativos, no absolutos): Mapa de valores de recarga local :math:`L`. + * **L_[Sufijo].tif** (tipo: ráster; unidades: mm/año, pero deben interpretarse como valores relativos, no absolutos): Mapa de valores de recarga local :math:`L`. - * **L_sum_avail_[Sufijo].tif** (tipo: ráster; unidades: mm, pero deben interpretarse como valores relativos, no absolutos): Mapa de los valores de :math:`L_{text{sum.avail}`, el agua disponible para un píxel, aportada por todos los píxeles de ladera, que está disponible para la evapotranspiración de este píxel + * **L_sum_avail_[Sufijo].tif** (tipo: ráster; unidades: mm/año, pero deben interpretarse como valores relativos, no absolutos): Mapa de los valores de :math:`L_{text{sum.avail}`, el agua disponible para un píxel, aportada por todos los píxeles de ladera, que está disponible para la evapotranspiración de este píxel - * **L_sum_[Sufijo].tif** (tipo: ráster; unidades: mm, pero deben interpretarse como valores relativos, no absolutos): Mapa de los valores de :math:`L_{text{sum}`, el flujo a través de un píxel, aportado por todos los píxeles pendiente arriba, que está disponible para la evapotranspiración a los píxeles pendiente abajo + * **L_sum_[Sufijo].tif** (tipo: ráster; unidades: mm/año, pero deben interpretarse como valores relativos, no absolutos): Mapa de los valores de :math:`L_{text{sum}`, el flujo a través de un píxel, aportado por todos los píxeles pendiente arriba, que está disponible para la evapotranspiración a los píxeles pendiente abajo - * **QF_[Sufijo].tif** (tipo: ráster; unidades: mm): Mapa de valores de flujo rápido (FR) anual + * **QF_[Sufijo].tif** (tipo: ráster; unidades: mm/año): Mapa de valores de flujo rápido (FR) anual * **P_[Sufijo].tif** (tipo: ráster; unidades: mm/año): La precipitación total en todos los meses de este píxel - * **Vri_[Sufijo].tif** (tipo: ráster; unidades: mm): Mapa de los valores de recarga (contribución, positiva o negativa), a la recarga total + * **Vri_[Sufijo].tif** (tipo: ráster; unidades: mm/año): Mapa de los valores de recarga (contribución, positiva o negativa), a la recarga total * **aggregated_results_swy_[Sufijo].shp**: Tabla con los valores biofísicos de cada cuenca hidrográfica, con los campos siguientes: - * **qb** (unidades: mm, pero deben interpretarse como valores relativos, no absolutos): Valor medio de la recarga local en la cuenca - - * **vri_sum** (units: mm): contribución total de recarga, (positiva o negativa) dentro de la cuenca. La suma de los valores de los píxeles de ``Vri_[Sufijo].tif`` dentro de la cuenca. + * **qb** (unidades: mm/año, pero deben interpretarse como valores relativos, no absolutos): Valor medio de la recarga local en la cuenca + + * **vri_sum** (units: mm/año): contribución total de recarga (positiva o negativa) dentro de la cuenca. La suma de los valores de los píxeles de ``Vri_[Sufijo].tif`` dentro de la cuenca. + + * **geom_id**: a unique ID for the watershed + + * **monthly_quickflow_baseflow_[Suffix].csv**: Table of average monthly baseflow, quickflow, and precipitation values for each watershed (or feature) within the AOI. This CSV is only created if a local recharge raster was not provided as a model input. Includes the following fields: + + * **geom_id**: A unique ID for the watershed. This will correspond to the ``geom_id`` column in ``aggregated_results_swy_[Suffix].shp``. + + * **month**: Values are the numbers 1-12 corresponding to each month, January (1) through December (12). + + * **quickflow** (units: cubic meters/month): The average quickflow value for the month in the watershed. + + * **baseflow** (units: cubic meters/month): The average baseflow value for the month in the watershed. Since baseflow is calculated on an annual scale, the values for each watershed have been distributed evenly across the year (annual average divided by 12). + + * **precipitation** (units: cubic meters/month): The average precipitation value for the month in the watershed. Values are based on the aligned input monthly precipitation rasters. * **[Workspace]\\intermediate_outputs** folder: - * **aet_[Sufijo].tif** (type: raster; units: mm): Mapa de evapotranspiración real (ETR) + * **aet_[Sufijo].tif** (type: raster; units: mm/año): Mapa de evapotranspiración real (ETR) - * **qf_1_[Sufijo].tif...qf_12_[Suffix].tif** (tipo: ráster; unidades: mm): Mapas de flujo rápido mensual (1 = enero... 12 = diciembre) + * **qf_1_[Sufijo].tif...qf_12_[Suffix].tif** (tipo: ráster; unidades: mm/mes): Mapas de flujo rápido mensual (1 = enero... 12 = diciembre) * **stream_[Sufijo.tif** (tipo: ráster): Red de corrientes generada a partir del MDE de input y del Umbral de Acumulación de Flujo. Los valores de 1 representan corrientes, los valores de 0 son píxeles que no son corrientes. diff --git a/source/zh/seasonal_water_yield.rst b/source/zh/seasonal_water_yield.rst index cbb7cf92..c4befdd1 100644 --- a/source/zh/seasonal_water_yield.rst +++ b/source/zh/seasonal_water_yield.rst @@ -312,7 +312,7 @@ 解释输出 --------------------- +==================== 输出栅格的分辨率将与作为输入提供的DEM的分辨率相同。 @@ -320,6 +320,8 @@ * **参数日志**:每当模型运行时，将在工作区中创建一个文本(.txt)文件。该文件将列出该运行的参数值和输出消息，并将根据服务、日期和时间命名。当与NatCap联系关于模型运行中的错误时，请包括参数日志。 + * **seasonal_water_yield_report_[Suffix].html:** A summary of a model run, including visualizations of key outputs, tables of calculated results, and information about model inputs. The report can be accessed in the Workbench or opened with any web browser. For an example, see the `Sample Seasonal Water Yield Report `_, generated by running the SWY model with the SWY sample data. + * **B_[ Suffix].tif** (类型:栅格;单位:mm，但应该被解释为相对值，而不是绝对值):基流的映射:math:`B` 值，一个像素对缓慢释放流的贡献(在到达溪流之前没有蒸发) * **B_sum_[ Suffix].tif** (类型:栅格;单位:mm，但应该解释为相对值，而不是绝对值): 映射值:math:`B_{\text{sum}}` \，通过像素的流量，由所有上坡像素贡献，在到达溪流之前没有蒸发 @@ -342,9 +344,23 @@ * **aggregated_results_swy_[Suffix].shp**:各流域生物物理值表，字段如下: - * **qb** (单位:mm，但应该解释为相对值，而不是绝对值):流域内的平均本地补给值 - - * **vri_sum** (单位:mm):流域内总补给贡献(正或负)。流域内``Vri_[Suffix].tif``的像素值之和。 + * **qb** (单位:mm，但应该解释为相对值，而不是绝对值):流域内的平均本地补给值 + + * **vri_sum** (单位:mm):流域内总补给贡献(正或负)。流域内``Vri_[Suffix].tif``的像素值之和。 + + * **geom_id**: a unique ID for the watershed + + * **monthly_quickflow_baseflow_[Suffix].csv**: Table of average monthly baseflow, quickflow, and precipitation values for each watershed (or feature) within the AOI. This CSV is only created if a local recharge raster was not provided as a model input. Includes the following fields: + + * **geom_id**: A unique ID for the watershed. This will correspond to the ``geom_id`` column in ``aggregated_results_swy_[Suffix].shp``. + + * **month**: Values are the numbers 1-12 corresponding to each month, January (1) through December (12). + + * **quickflow** (units: cubic meters/month): The average quickflow value for the month in the watershed. + + * **baseflow** (units: cubic meters/month): The average baseflow value for the month in the watershed. Since baseflow is calculated on an annual scale, the values for each watershed have been distributed evenly across the year (annual average divided by 12). + + * **precipitation** (units: cubic meters/month): The average precipitation value for the month in the watershed. Values are based on the aligned input monthly precipitation rasters. * **[Workspace]\\intermediate_outputs** folder: