diff --git a/.github/workflows/build-sphinx.yml b/.github/workflows/build-sphinx.yml index 3a7e9f9b..defa6960 100644 --- a/.github/workflows/build-sphinx.yml +++ b/.github/workflows/build-sphinx.yml @@ -15,23 +15,22 @@ jobs: SLACK_API_TOKEN: ${{ secrets.SLACK_SW_INVEST_UG_WEBHOOK }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 with: fetch-depth: 0 # so that setuptools_scm can get the right version string. - - name: Set up python - uses: actions/setup-python@v5 - with: - python-version: "3.10" - - - name: Setup with Micromamba - uses: mamba-org/setup-micromamba@v1 + - name: Setup build environment with Micromamba + uses: mamba-org/setup-micromamba@v3 with: environment-file: environment.yml environment-name: env condarc: | channels: - conda-forge + init-shell: bash + + - name: install python requirements + run: pip install -r requirements.txt --no-build-isolation - name: Build sphinx docs run: make html @@ -47,34 +46,34 @@ jobs: - name: Authenticate GCP if: github.event_name != 'pull_request' - uses: google-github-actions/auth@v2 + uses: google-github-actions/auth@v3 with: credentials_json: ${{ secrets.GCP_SERVICE_ACC_KEY }} - name: Set up GCP if: github.event_name != 'pull_request' - uses: google-github-actions/setup-gcloud@v2 + uses: google-github-actions/setup-gcloud@v3 - name: Upload to release bucket if: ${{ github.event_name != 'pull_request' && github.ref == 'refs/heads/main' }} run: | BUCKET=gs://releases.naturalcapitalproject.org/invest-userguide/latest - gsutil -m rsync -dr build/html $BUCKET + gcloud storage rsync -r --delete-unmatched-destination-objects build/html $BUCKET # Cache appears to be reset each time we upload a new blob. # Re-set the cache here to allow UG editors to immediately view # changes to the rendered HTML. - gsutil -m setmeta -r -h "Cache-control:no-store" $BUCKET + gcloud storage objects update $BUCKET/** --cache-control="no-store" --recursive - name: Upload to dev builds bucket if: ${{ github.event_name != 'pull_request' && github.ref != 'refs/heads/main' }} run: | FORKUSER=$(basename $(dirname $(git remote get-url origin))) BUCKET=natcap-dev-build-artifacts/invest-userguide/$FORKUSER/latest - gsutil -m rsync -dr build/html gs://$BUCKET + gcloud storage rsync -r --delete-unmatched-destination-objects build/html gs://$BUCKET # Cache appears to be reset each time we upload a new blob. # Re-set the cache here to allow UG editors to immediately view # changes to the rendered HTML. - gsutil -m setmeta -r -h "Cache-control:no-store" gs://$BUCKET + gcloud storage objects update $BUCKET/** --cache-control="no-store" --recursive python .github/workflows/post_url_to_slack.py https://storage.googleapis.com/$BUCKET/en/index.html - name: Save UG artifacts diff --git a/environment.yml b/environment.yml index c57f6079..4438c94f 100644 --- a/environment.yml +++ b/environment.yml @@ -1,3 +1,7 @@ +# These are the natcap.invest build dependencies. +# It is common for the UG build to need to build +# natcap.invest from source. Other dependencies +# for the UG are in requirements.txt channels: - conda-forge # set nodefaults to remove the default channels @@ -5,9 +9,14 @@ channels: # https://github.com/conda/conda/issues/5003 - nodefaults dependencies: -- python=3.10 +- python=3.13 - pip -- gdal>=3.4.2,<3.6.0 +- gdal>=3.4.2 +- pygeoprocessing - pip: - - -r requirements.txt - + - setuptools>=64 + - wheel + - setuptools_scm>=8.0 + - cython>=3.0.0 + - babel + - numpy>=2 diff --git a/requirements.txt b/requirements.txt index f3b85200..92c57512 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,9 +1,8 @@ git-lfs -natcap.invest pint -setuptools_scm sphinx sphinx-reredirects sphinx-intl pyyaml pygeoprocessing +natcap.invest diff --git a/source/en/annual_water_yield.rst b/source/en/annual_water_yield.rst index be0280af..98a736ee 100644 --- a/source/en/annual_water_yield.rst +++ b/source/en/annual_water_yield.rst @@ -241,6 +241,8 @@ The resolution of the output rasters will be the same as the resolution of the L * **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. +* **annual_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 Annual Water Yield Report `_, generated by running the AWY model with the AWY sample data. + * Outputs in the *per_pixel* folder can be useful for intermediate calculations but should **NOT** be interpreted at the pixel level, as model assumptions are based on processes understood at the subwatershed scale. * **output\\per_pixel\\fractp_[Suffix].tif** (fraction): Estimated actual evapotranspiration fraction of precipitation per pixel (Actual Evapotranspiration / Precipitation). It is the mean fraction of precipitation that actually evapotranspires at the pixel level. diff --git a/source/en/carbonstorage.rst b/source/en/carbonstorage.rst index 78d1c1f5..96d7291f 100644 --- a/source/en/carbonstorage.rst +++ b/source/en/carbonstorage.rst @@ -148,7 +148,9 @@ Interpreting Results * **c_change_bas_alt_[Suffix].tif**: Raster showing the difference in carbon stored between the alternate landscape and the baseline landscape. The values are in metric tons per hectare. In this map some values may be negative and some positive. Positive values indicate sequestered carbon, negative values indicate carbon that was lost. - * **npv_alt_[Suffix].tif**/:** Raster showing the economic value of carbon sequestered between the baseline and the alternate landscape dates. The units are in currency per hectare. + * **npv_alt_[Suffix].tif**: Raster showing the economic value of carbon sequestered between the baseline and the alternate landscape dates. The units are in currency per hectare. + + * **raster_values_summary_[Suffix].csv**: CSV summarizing the total values, units, and filenames of the output rasters. * **[Workspace]\\intermediate_outputs** folder: diff --git a/source/en/urban_cooling_model.rst b/source/en/urban_cooling_model.rst index 0df48a48..eea06ef3 100644 --- a/source/en/urban_cooling_model.rst +++ b/source/en/urban_cooling_model.rst @@ -1,7 +1,7 @@ .. _ucm: ************* -Urban Cooling +Urban Cooling ************* Summary @@ -253,38 +253,48 @@ Data Needs Interpreting Results ==================== -* hm_[Suffix].tif: The calculated HMI. -* uhi_results_[Suffix].shp: A copy of the input vector "Area of Interest" with the following additional fields: - * "avg_cc" - Average CC value (-). - * "avg_tmp_v" - Average temperature value (degC). - * "avg_tmp_an" - Average temperature anomaly (degC). - * "avd_eng_cn" - (optional) Avoided energy consumption (kWh or $ if optional energy ``cost`` input column was provided in the Energy Consumption Table). - * "avg_wbgt_v" - (optional) Average WBGT (degC). - * "avg_ltls_v" - (optional) Light work productivity loss (%). - * "avg_hvls_v" - (optional) Heavy work productivity loss (%). -* buildings_with_stats_[Suffix].shp: A copy of the input vector "Building Footprints" with the following additional fields: - * "energy_sav" - Energy savings value (kWh or currency if optional energy ``cost`` input column was provided in the Energy Consumption Table). Savings are relative to a theoretical scenario where the city contains NO natural areas nor green spaces; where CC = 0 for all LULC classes. - * "mean_t_air" - Average temperature value in building (degC). - -The intermediate folder contains additional model outputs: - -* albedo_[Suffix].tif: Raster of albedo. -* area_kernel_[Suffix].tif: Area kernel for green area convolution. -* cc_[Suffix].tif: Raster of CC values. -* cc_masked_green_areas_[Suffix].tif: Raster of CC values masked by non-green areas. -* cc_ref_aoi_stats.pickle: Pickled zonal statistics for CC raster within the AOI. -* eti_[Suffix].tif: Raster of actual evapotranspiration (reference evapotranspiration times crop coefficient "Kc"). -* green_area_sum_[Suffix].tif: Raster of total area of green space within a search distance around each pixel. -* kc_[Suffix].tif: Raster of crop coefficients. -* lulc_[Suffix].tif: Raster of land use/land cover aligned to the intersection of the AOI, ET0, and LULC. -* ref_eto_[Suffix].tif: Raster of reference evapotranspiration, reprojected and aligned to the intersection of the AOI, ET0, and LULC. -* reprojected_aoi_[Suffix].shp: The user-defined Area of Interest, reprojected to the Spatial Reference of the LULC. -* reprojected_buildings_[Suffix].shp: The user-defined buildings vector, reprojected to the Spatial Reference of the LULC. -* shade_[Suffix].tif: Raster of shade. -* T_air_[Suffix].tif: Raster of estimated air temperature values. -* t_air_aoi_stats.pickle: Pickled zonal statistics for air temperature within the AOI. -* T_air_nomix_[Suffix].tif: Raster of estimated air temperature values prior to air mixing (i.e. before applying the moving average algorithm). -* wbgt_[Suffix].tif: Raster of the calculated WBGT. +* **InVEST-urban_cooling_model-log-....txt**: This is the logfile produced during every run of InVEST. It details the input parameters that were used for the run, and it logs all errors that may have occurred. If posting a question about a model run to community.naturalcapitalalliance.org, be sure to attach this logfile to your post! +* **urban_cooling_model_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 Urban Cooling Report `_, generated by running the Urban Cooling Model with the Urban Cooling Model sample data. +* **T_air_[Suffix].tif**: Raster of estimated air temperature values. +* **hm_[Suffix].tif**: The calculated HMI. +* **cc_[Suffix].tif**: Raster of CC values. +* **uhi_results_[Suffix].shp**: A copy of the input vector "Area of Interest" with the following additional fields: + * **avg_cc**: Average CC value (unitless). + * **avg_tmp_v**: Average temperature value (degC). + * **avg_tmp_an**: Average temperature anomaly (degC). + * **avd_eng_cn** (optional): Avoided energy consumption (kWh or currency if optional energy ``cost`` input column was provided in the Energy Consumption Table). + * **avg_wbgt_v** (optional): Average WBGT (degC). + * **avg_ltls_v** (optional): Light work productivity loss (%). + * **avg_hvls_v** (optional): Heavy work productivity loss (%). +* **buildings_with_stats_[Suffix].shp**: A copy of the input vector "Building Footprints" with the following additional fields: + * **energy_sav**: Energy savings value (kWh or currency if optional energy ``cost`` input column was provided in the Energy Consumption Table). Savings are relative to a theoretical scenario where the city contains NO natural areas nor green spaces; where CC = 0 for all LULC classes. + * **mean_t_air**: Average temperature value in building (degC). + +The ``intermediate`` folder contains additional model outputs: + +* **albedo_[Suffix].tif**: Raster of albedo. +* **area_kernel_[Suffix].tif**: Area kernel for green area convolution. +* **building_intensity_[Suffix].tif**: Map of building intensity. +* **cc_masked_green_areas_[Suffix].tif**: Raster of CC values masked by non-green areas. +* **cc_park_[Suffix].tif**: Map of cooling capacity decayed by proximity to greenspace. +* **cc_ref_aoi_stats.pickle**: Pickled zonal statistics for CC raster within the AOI. +* **eti_[Suffix].tif**: Raster of evapotranspiration index (reference evapotranspiration (ETo) times crop coefficient (Kc) divided by ETmax). +* **green_area_sum_[Suffix].tif**: Raster of total area of green space within a search distance around each pixel. +* **green_area_[Suffix].tif**: Map of green area. +* **heavy_loss_stats.pickle**: Pickled zonal statistics for heavy work loss. +* **heavy_work_loss_percent_[Suffix].tif**: Map of percent work productivity loss for heavy work. +* **kc_[Suffix].tif**: Raster of crop coefficients. +* **light_loss_stats.pickle**: Pickled zonal statistics for light work loss. +* **light_work_loss_percent_[Suffix].tif**: Map of percent work productivity loss for light work. +* **lulc_[Suffix].tif**: Raster of land use/land cover aligned to the intersection of the AOI, ET0, and LULC. +* **ref_eto_[Suffix].tif**: Raster of reference evapotranspiration, reprojected and aligned to the intersection of the AOI, ET0, and LULC. +* **reprojected_aoi_[Suffix].shp**: The user-defined Area of Interest, reprojected to the Spatial Reference of the LULC. +* **reprojected_buildings_[Suffix].shp**: The user-defined buildings vector, reprojected to the Spatial Reference of the LULC. +* **shade_[Suffix].tif**: Raster of shade. +* **t_air_aoi_stats.pickle**: Pickled zonal statistics for air temperature within the AOI. +* **T_air_nomix_[Suffix].tif**: Raster of estimated air temperature values prior to air mixing (i.e. before applying the moving average algorithm). +* **wbgt_stats.pickle**: Pickled zonal statistics for WBGT. +* **wbgt_[Suffix].tif**: Raster of the calculated WBGT. Appendix: Data Sources and Guidance for Parameter Selection =========================================================== diff --git a/source/en/urban_nature_access.rst b/source/en/urban_nature_access.rst index 0b88fc0e..104ba389 100644 --- a/source/en/urban_nature_access.rst +++ b/source/en/urban_nature_access.rst @@ -768,6 +768,19 @@ Data Needs Interpreting Results ==================== +- **InVEST-urban-nature_access-log-….txt:**: 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. + +- **urban_nature_access_report.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 Urban Nature Access Report `_, + generated by running the UNA model with the UNA sample data. + Output Folder ------------- diff --git a/source/es/annual_water_yield.rst b/source/es/annual_water_yield.rst index 793f3b21..4fd111df 100644 --- a/source/es/annual_water_yield.rst +++ b/source/es/annual_water_yield.rst @@ -235,6 +235,8 @@ La resolución de los rásters resultantes será la misma que la del ráster de * **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 resultantes para esa ejecución y se nombrará según el servicio, la fecha y la hora. Cuando se ponga en contacto con NatCap sobre los errores de una ejecución del modelo, incluya el registro de parámetros. +* **annual_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 Annual Water Yield Report `_, generated by running the AWY model with the AWY sample data. + * Los resultados de la carpeta *per_pixel* pueden ser útiles para cálculos intermedios pero no deben ser interpretados a nivel de píxel, ya que las suposiciones del modelo se basan en procesos entendidos a escala de subcuenca. * **output\\per_pixel\\fractp_[Suffix].tif** (fracción): Fracción estimada de evapotranspiración real de la precipitación por píxel (Evapotranspiración real / Precipitación). Es la fracción media de precipitación que realmente evapotranspira a nivel de píxel. diff --git a/source/es/carbonstorage.rst b/source/es/carbonstorage.rst index dafcd361..83ce3a5b 100644 --- a/source/es/carbonstorage.rst +++ b/source/es/carbonstorage.rst @@ -154,7 +154,9 @@ Interpretación de los resultados * **c_change_bas_alt_[Suffix].tif**: rásters que muestran la diferencia de carbono almacenado entre el paisaje futuro/REDD y el paisaje actual. Los valores se expresan en toneladas métricas por píxel. En este mapa algunos valores pueden ser negativos y otros positivos. Los valores positivos indican el carbono secuestrado, los negativos indican el carbono que se ha perdido. - * **npv_alt_[Suffix].tif**:** rásters que muestran el valor económico del carbono secuestrado entre las fechas del paisaje actual y el futuro/REDD. Las unidades son en moneda por píxel. + * **npv_alt_[Suffix].tif**: rásters que muestran el valor económico del carbono secuestrado entre las fechas del paisaje actual y el futuro/REDD. Las unidades son en moneda por píxel. + + * **raster_values_summary_[Suffix].csv**: CSV summarizing the total values, units, and filenames of the output rasters. * **[Workspace]\\intermediate_outputs** carpeta: diff --git a/source/es/urban_cooling_model.rst b/source/es/urban_cooling_model.rst index e0895816..3b2aeb6d 100644 --- a/source/es/urban_cooling_model.rst +++ b/source/es/urban_cooling_model.rst @@ -256,28 +256,48 @@ Necesidades de datos Interpretación de los resultados ================================ -* hm_[Suffix].tif: The calculated HMI. -* uhi_results_[Suffix].shp: Una copia del vector de input "Área de interés" con los siguientes campos adicionales: - * "avg_cc" - Valor medio de CE (-). - * "avg_tmp_v" - Valor medio de la temperatura (gradC). - * "avg_tmp_an" - Anomalía de la temperatura media (gradC). - * "avd_eng_cn" - (opcional) Consumo de energía evitado (kWh o $ si la columna opcional de input de energía ``costo`` se proporcionó en la tabla de consumo de energía). - * "avg_wbgt_v" - (opcional) TGH media (gradC). - * "avg_ltls_v" - (opcional) Pérdida de productividad en trabajos ligeros (%). - * "avg_hvls_v" - (opcional) Pérdida de productividad en el trabajo pesado (%). -* buildings_with_stats_[Sufijo].shp: Una copia del vector de input "Huellas de construcciones" con los siguientes campos adicionales: - * "energy_sav" - Valor de ahorro de energía (kWh o moneda si se proporcionó la columna opcional de input de energía ``costo`` en la Tabla de Consumo de Energía). El ahorro es relativo a un escenario teórico en el que la ciudad NO contiene áreas naturales ni espacios verdes; donde CE = 0 para todas las clases LULC. - * "mean_t_air" - Valor medio de la temperatura en la construcción (gradC). - -La carpeta intermedia contiene resultados adicionales del modelo: - -* cc_[Sufijo].tif: Ráster de valores CE. -* T_air_[Sufijo].tif: Ráster de valores estimados de temperatura del aire. -* T_air_nomix_[Suffijo].tif: Ráster de los valores de temperatura del aire estimados antes de la mezcla del aire (es decir, antes de aplicar el algoritmo de media móvil). -* eti_[Sufijo].tif: Ráster de valores de evapotranspiración real (evapotranspiración de referencia por coeficiente de cultivo "Kc"). -* wbgt_[Sufijo].tif: Ráster del TGH calculado. -* reprojected_aoi_[Sufijo].shp: El área de interés definida por usted, reproyectada a la referencia espacial del LULC. -* reprojected_buildings_[Sufijo].shp: El vector de construcciones definido por usted, reproyectado a la referencia espacial de la LULC. +* **InVEST-urban_cooling_model-log-....txt**: This is the logfile produced during every run of InVEST. It details the input parameters that were used for the run, and it logs all errors that may have occurred. If posting a question about a model run to community.naturalcapitalalliance.org, be sure to attach this logfile to your post! +* **urban_cooling_model_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 Urban Cooling Report `_, generated by running the Urban Cooling Model with the Urban Cooling Model sample data. +* **T_air_[Sufijo].tif**: Ráster de valores estimados de temperatura del aire. +* **hm_[Sufijo].tif**: The calculated HMI. +* **cc_[Sufijo].tif**: Ráster de valores CE. +* **uhi_results_[Sufijo].shp**: Una copia del vector de input "Área de interés" con los siguientes campos adicionales: + * **avg_cc**: Valor medio de CE (unitless). + * **avg_tmp_v**: Valor medio de la temperatura (gradC). + * **avg_tmp_an**: Anomalía de la temperatura media (gradC). + * **avd_eng_cn** (opcional): Consumo de energía evitado (kWh o $ si la columna opcional de input de energía ``costo`` se proporcionó en la tabla de consumo de energía). + * **avg_wbgt_v** (opcional): TGH media (gradC). + * **avg_ltls_v** (opcional): Pérdida de productividad en trabajos ligeros (%). + * **avg_hvls_v** (opcional): Pérdida de productividad en el trabajo pesado (%). +* **buildings_with_stats_[Sufijo].shp**: Una copia del vector de input "Huellas de construcciones" con los siguientes campos adicionales: + * **energy_sav**: Valor de ahorro de energía (kWh o moneda si se proporcionó la columna opcional de input de energía ``costo`` en la Tabla de Consumo de Energía). El ahorro es relativo a un escenario teórico en el que la ciudad NO contiene áreas naturales ni espacios verdes; donde CE = 0 para todas las clases LULC. + * **mean_t_air**: Valor medio de la temperatura en la construcción (gradC). + +La carpeta ``intermediate`` contiene resultados adicionales del modelo: + +* **albedo_[Suffix].tif**: Raster of albedo. +* **area_kernel_[Suffix].tif**: Area kernel for green area convolution. +* **building_intensity_[Suffix].tif**: Map of building intensity. +* **cc_masked_green_areas_[Suffix].tif**: Raster of CC values masked by non-green areas. +* **cc_park_[Suffix].tif**: Map of cooling capacity decayed by proximity to greenspace. +* **cc_ref_aoi_stats.pickle**: Pickled zonal statistics for CC raster within the AOI. +* **eti_[Sufijo].tif**: Raster of evapotranspiration index (reference evapotranspiration (ETo) times crop coefficient (Kc) divided by ETmax). +* **green_area_sum_[Suffix].tif**: Raster of total area of green space within a search distance around each pixel. +* **green_area_[Suffix].tif**: Map of green area. +* **heavy_loss_stats.pickle**: Pickled zonal statistics for heavy work loss. +* **heavy_work_loss_percent_[Suffix].tif**: Map of percent work productivity loss for heavy work. +* **kc_[Suffix].tif**: Raster of crop coefficients. +* **light_loss_stats.pickle**: Pickled zonal statistics for light work loss. +* **light_work_loss_percent_[Suffix].tif**: Map of percent work productivity loss for light work. +* **lulc_[Suffix].tif**: Raster of land use/land cover aligned to the intersection of the AOI, ET0, and LULC. +* **ref_eto_[Suffix].tif**: Raster of reference evapotranspiration, reprojected and aligned to the intersection of the AOI, ET0, and LULC. +* **reprojected_aoi_[Sufijo].shp**: El área de interés definida por usted, reproyectada a la referencia espacial del LULC. +* **reprojected_buildings_[Sufijo].shp**: El vector de construcciones definido por usted, reproyectado a la referencia espacial de la LULC. +* **shade_[Suffix].tif**: Raster of shade. +* **t_air_aoi_stats.pickle**: Pickled zonal statistics for air temperature within the AOI. +* **T_air_nomix_[Sufijo].tif**: Ráster de los valores de temperatura del aire estimados antes de la mezcla del aire (es decir, antes de aplicar el algoritmo de media móvil). +* **wbgt_stats.pickle**: Pickled zonal statistics for WBGT. +* **wbgt_[Sufijo].tif**: Ráster del TGH calculado. Apéndice: Fuentes de datos y orientación para la selección de parámetros ======================================================================== diff --git a/source/es/urban_nature_access.rst b/source/es/urban_nature_access.rst index a617ccf4..8068ebe0 100644 --- a/source/es/urban_nature_access.rst +++ b/source/es/urban_nature_access.rst @@ -517,6 +517,10 @@ Todos los inputs espaciales deben estar en el mismo sistema de coordenadas proye Interpretación de los resultados ================================ +- **InVEST-urban-nature_access-log-….txt:**: 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. + +- **urban_nature_access_report.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 Urban Nature Access Report `_, generated by running the UNA model with the UNA sample data. + Carpeta de resultados --------------------- diff --git a/source/zh/annual_water_yield.rst b/source/zh/annual_water_yield.rst index 7932ae4b..ba54e43b 100644 --- a/source/zh/annual_water_yield.rst +++ b/source/zh/annual_water_yield.rst @@ -238,6 +238,8 @@ InVEST产水量模型估计了景观不同部分的水的相对贡献，提出 输出栅格的分辨率将与作为输入提供的土地利用/土地覆被栅格的分辨率相同。 * **参数日志**: 每次运行模型时，都会在工作区中创建一个文本 （.txt） 文件。该文件将列出该运行的参数值和输出消息，并根据服务、日期和时间进行命名。联系 NatCap 了解模型运行中的错误时，请提供参数日志。 +* **annual_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 Annual Water Yield Report `_, generated by running the AWY model with the AWY sample data. + * *per_pixel* 文件夹中的输出可用于中间计算，但不应在像素级别进行解释，因为模型假设基于在子流域尺度上理解的过程。 * **output\\per_pixel\\fractp_[Suffix].tif** (fraction): 每像素估计的实际蒸散降水量分数（实际蒸散量/降水量）。它是在像素水平上实际蒸发的降水的平均比例。 * **output\\per_pixel\\aet_[Suffix].tif** (mm): 每像素估计的实际蒸散量。 diff --git a/source/zh/carbonstorage.rst b/source/zh/carbonstorage.rst index da0602c3..3723dc39 100644 --- a/source/zh/carbonstorage.rst +++ b/source/zh/carbonstorage.rst @@ -153,7 +153,10 @@ REDD 场景分析 * **c_change_bas_alt_[Suffix].tif**: 栅格显示未来/REDD景观与当前景观之间的碳储存差异。数值以公吨/像素为单位。在这个映射中，有些值可能是负数，有些可能是正数。正值表示封存的碳，负值表示流失的碳。 - * **npv_alt_[Suffix].tif**:** 栅格显示当前和未来/REDD景观日期之间封存的碳的经济价值。单位是每像素的货币。 + * **npv_alt_[Suffix].tif**: 栅格显示当前和未来/REDD景观日期之间封存的碳的经济价值。单位是每像素的货币。 + + * **raster_values_summary_[Suffix].csv**: CSV summarizing the total values, units, and filenames of the output rasters. + * **[Workspace]\\intermediate_outputs** folder: * **c_above_[Suffix].tif**:地上碳值的栅格，从碳库表映射到LULC。单位是公吨每像素。 diff --git a/source/zh/urban_cooling_model.rst b/source/zh/urban_cooling_model.rst index a9a80d39..aa6f0e65 100644 --- a/source/zh/urban_cooling_model.rst +++ b/source/zh/urban_cooling_model.rst @@ -93,7 +93,7 @@ 由于空气混合，这些温度在空间上是平均的。实际空气温度(含混合) :math:`T_{air}`由:math:`T_{air_{nomix}}`推导而来，使用的是一个高斯函数，其核半径为:math:`r`，由用户定义。 对于每个感兴趣的区域(这是用户提供的矢量GIS层)，我们计算平均温度和温度异常:math:`(T_{air,i} - T_{air,ref})`。 - + 减热服务的价值 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -253,29 +253,48 @@ Gasparrini等人2014年分析了13个国家384个城市因高温导致的死亡 解释结果 ==================== -* hm_[Suffix].tif: 计算的HMI。 -* uhi_results_[Suffix].shp:输入向量“Area of Interest”的副本，包含以下附加字段: - * "avg_cc" - 平均CC值 (-). - * "avg_tmp_v" - 平均温度值 (degC). - * "avg_tmp_an" - 平均温度异常 (degC). - * "avd_eng_cn" - (可选)避免能源消耗(如在能源消耗表中提供可选能源“成本”输入栏，则为千瓦时或$)。 - * "avg_wbgt_v" - (可选)平均体重(degC). - * "avg_ltls_v" - (可选)轻工作效率损失(%)。 - * "avg_hvls_v" -.(可选)工作效率损失严重(%)。 - -* buildings_with_stats_[Suffix].shp: 输入向量"Building Footprints"的副本，包含以下附加字段: - * "energy_sav" -能源节约价值(如能源消耗表中提供可选的能源“成本”输入栏，则以千瓦时或货币计算)。节省是相对于一个理论场景，即城市不包含自然区域和绿地;其中CC = 0适用于所有的LULC类。 - * "mean_t_air" -建筑物平均温度值（degC). +* **InVEST-urban_cooling_model-log-....txt**: This is the logfile produced during every run of InVEST. It details the input parameters that were used for the run, and it logs all errors that may have occurred. If posting a question about a model run to community.naturalcapitalalliance.org, be sure to attach this logfile to your post! +* **urban_cooling_model_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 Urban Cooling Report `_, generated by running the Urban Cooling Model with the Urban Cooling Model sample data. +* **T_air_[Suffix].tif**: 估计空气温度值的栅格。 +* **hm_[Suffix].tif**: 计算的HMI。 +* **cc_[Suffix].tif**: CC值的栅格。 +* **uhi_results_[Suffix].shp**: 输入向量“Area of Interest”的副本，包含以下附加字段: + * **avg_cc**: 平均CC值 (unitless). + * **avg_tmp_v**: 平均温度值 (degC). + * **avg_tmp_an**: 平均温度异常 (degC). + * **avd_eng_cn**: (可选)避免能源消耗(如在能源消耗表中提供可选能源“成本”输入栏，则为千瓦时或$)。 + * **avg_wbgt_v**: (可选)平均体重(degC). + * **avg_ltls_v**: (可选)轻工作效率损失(%)。 + * **avg_hvls_v**:.(可选)工作效率损失严重(%)。 +* **buildings_with_stats_[Suffix].shp**: 输入向量"Building Footprints"的副本，包含以下附加字段: + * **energy_sav**: 能源节约价值(如能源消耗表中提供可选的能源“成本”输入栏，则以千瓦时或货币计算)。节省是相对于一个理论场景，即城市不包含自然区域和绿地;其中CC = 0适用于所有的LULC类。 + * **mean_t_air**: 建筑物平均温度值（degC). 中间文件夹包含额外的模型输出: -* cc_[Suffix].tif: CC值的栅格。 -* T_air_[Suffix].tif: 估计空气温度值的栅格。 -* T_air_nomix_[Suffix].tif: 在空气混合之前(即在应用移动平均算法之前)估计空气温度值的栅格。 -* eti_[Suffix].tif:实际蒸散发值的栅格(参考蒸散发乘以作物系数"Kc")。 -* wbgt_[Suffix].tif: 计算WBGT的栅格。 -* reprojected_aoi_[Suffix].shp: 用户定义的兴趣区域，重新投影到LULC的空间参考。 -* reprojected_buildings_[Suffix].shp: 用户定义的建筑矢量，重新投影到LULC的空间参考。 +* **albedo_[Suffix].tif**: Raster of albedo. +* **area_kernel_[Suffix].tif**: Area kernel for green area convolution. +* **building_intensity_[Suffix].tif**: Map of building intensity. +* **cc_masked_green_areas_[Suffix].tif**: Raster of CC values masked by non-green areas. +* **cc_park_[Suffix].tif**: Map of cooling capacity decayed by proximity to greenspace. +* **cc_ref_aoi_stats.pickle**: Pickled zonal statistics for CC raster within the AOI. +* **eti_[Suffix].tif**: Raster of evapotranspiration index (reference evapotranspiration (ETo) times crop coefficient (Kc) divided by ETmax). +* **green_area_sum_[Suffix].tif**: Raster of total area of green space within a search distance around each pixel. +* **green_area_[Suffix].tif**: Map of green area. +* **heavy_loss_stats.pickle**: Pickled zonal statistics for heavy work loss. +* **heavy_work_loss_percent_[Suffix].tif**: Map of percent work productivity loss for heavy work. +* **kc_[Suffix].tif**: Raster of crop coefficients. +* **light_loss_stats.pickle**: Pickled zonal statistics for light work loss. +* **light_work_loss_percent_[Suffix].tif**: Map of percent work productivity loss for light work. +* **lulc_[Suffix].tif**: Raster of land use/land cover aligned to the intersection of the AOI, ET0, and LULC. +* **ref_eto_[Suffix].tif**: Raster of reference evapotranspiration, reprojected and aligned to the intersection of the AOI, ET0, and LULC. +* **reprojected_aoi_[Suffix].shp**: 用户定义的兴趣区域，重新投影到LULC的空间参考。 +* **reprojected_buildings_[Suffix].shp**: 用户定义的建筑矢量，重新投影到LULC的空间参考。 +* **shade_[Suffix].tif**: Raster of shade. +* **t_air_aoi_stats.pickle**: Pickled zonal statistics for air temperature within the AOI. +* **T_air_nomix_[Suffix].tif**: 在空气混合之前(即在应用移动平均算法之前)估计空气温度值的栅格。 +* **wbgt_stats.pickle**: Pickled zonal statistics for WBGT. +* **wbgt_[Suffix].tif**: 计算WBGT的栅格。 附录:数据来源和参数选择指南 =========================================================== diff --git a/source/zh/urban_nature_access.rst b/source/zh/urban_nature_access.rst index 4a63136a..76f788a4 100644 --- a/source/zh/urban_nature_access.rst +++ b/source/zh/urban_nature_access.rst @@ -659,6 +659,10 @@ group :math:`gn` 在 pixel :math:`i` 处，然后对所有像素进行求和 解释结果 ==================== +- **InVEST-urban-nature_access-log-….txt:**: 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. + +- **urban_nature_access_report.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 Urban Nature Access Report `_, generated by running the UNA model with the UNA sample data. + 输出文件夹 ----------------