Output Data

When GHG emission model input calculations are run in GeoCARET, GeoCARET creates a number of outputs which are saved to several locations locally and on remote servers - see Output Locations. This document is a guide to the output datasets generated and their location.

Run Folder

Key Points

When the GeoCARET is run for the first time, a folder XHEET/tmp is created in the top level of your Google Drive assets folder. This folder is written into by the currently running GeoCARET job.
Initially, all output files are written to the XHEET/tmp folder.
Once the analysis is complete, all output files are copied to the permanent Earth Engine assets folder and to Google Drive [optionally].
All files are finally deleted from XHEET/tmp.

Output Locations

The results are saved into three locations:

Google Earth Engine Cloud Project Assets folder
Google Drive (optional)
Local results folder on the user’s personal machine

1. Google Earth Engine Cloud Project Assets folder

All output files generated by GeoCARET are saved inside your Google Earth Engine Cloud Project Assets folder. They are saved in a folder called XHEET, which will be created inside the top-level folder of your cloud project.

Attention

If your cloud project contains multiple top-level folders, GeoCARET will use the first folder it finds, taking the folder names in alphabetical order.

Each time you run the analysis, a new sub-folder will be created to hold the outputs, with the name generated constructed from the jobname argument and the timestamp of the analysis: XHEET/<<JOBNAME>>-<<TIMESTAMP>>

For exmaple, if your cloud project is called my-ee-project and it has a top-level folder called home, and you started the analysis at 3pm on 2024-01-01 using the following command-line command:

> python heet_cli.py data/dams.csv my-ee-project job01 standard

the outputs would be stored in my-ee-peoject/home/XHEET/JOB01-20240101-1300.

All outputs are native Earth Engine data structures: feature collections, images and image collections.

2. Google Drive (Optional)

All output files can also be saved to a Google Drive folder under condition that the config option export_to_drive = True in delineator/heet_config.py - see Configuration Options for more information about configuration settings. For more information, please read: Exporting to Google Drive.

Exported data

Catchment, Reservoir and River delineations (vectors, feature collections) are exported as shape files.
Catchment areas and inundated areas (pixels, rasters, images) are exported GeoTiff images.
Catchment, reservoir and other parameters (feature collections) are exported as csv files.

For more information, please refer to Export Settings and Outputs.

3. Local Results Folder

Important

This destination is only for the calculated parameters, i.e. other outputs such as delineation shape files, are not saved to the local results folder. Instead they can be exported to Google Drive - see 2. Google Drive (Optional).

When the analysis is complete, the calculated reservoir and catchment properties, i.e. the output_parameters are downloaded to a local results folder in the form of a CSV file called output_parameters.csv. The file will be stored in the folder

outputs/<<JOBNAME>>-<<TIMESTAMP>>

e.g.

outputs/JOB01-20220130-1450/output_parameters.csv

The values in output_parameters.csv are additionally validated against a set of constraints, e.g. minimum and maximum allowed value, defined in configuration file outputs.resource.yaml. The validation functions are defined in heet_validate.py. Any impossible or improbable calculated parameters are flagged in a CSV file heet_output_report.csv, also saved to the local results folder. A subset of data in output_parameters.csv is additionally saved as a specially formatted json file output_parameters.json that is designed to comply with the input file specifications of RE-Emission. Alike the csv files, the json file will be stored in the folder

outputs/<<JOBNAME>>-<<TIMESTAMP>>

e.g.

outputs/JOB01-20220130-1450/output_parameters.json

Guide to Output Files

The produced outputs come in two forms: geospatial data and tabular data. The geospatial data is saved either in .shp or .GeoTiff format, depending whether it is in the form of vector(s) or raster(s), respectively. The tabular data representing the user inputs and the output parameters is saved in the .csv format.

Output File Inventory

The output data comes in different native Earth Engine formats (see ee_type) which later determines the type of the output file (see drive_type). The file names (file_prefix), their titles and descriptions and types are provided in the table below.

`file_prefix`	title	description	`ee_type`	`drive_type`
`user_inputs`	User inputs	User inputs	Feature Collection	CSV
`P_*`	Raw dam location	The raw dam location input by the user	Feature Collection [Ftc-ft-pt]	SHP
`PS_*`	Snapped dam location	Dam location snapped to nearest hydroriver	Feature Collection [Ftc-ft-pt]	SHP
`WCPTS_`	Watershed candidate points	Watershed search grid. Hydrobasins 12 subbasin of dam converted to a grid of point locations (15’ pixel centres).	Feature Collection [Ftc-fts-pts]	SHP
`WDPTS_`	Watershed detected points	Points on watershed search grid found by algorithm to belong to dam catchment.	Feature Collection [Ftc-fts-pts]	SHP
`CX_`	Catchment pixels	Catchment pixels	Image	GeoTiff
`C_` `c_`	Catchment boundary	Catchment boundary	Feature Collection	SHP
`WBSX_`	Waterbodies pixels	Waterbodies pixels	Image	GeoTiff
`WBS_`	Waterbodies boundaries	Waterbodies boundaries	Feature Collection	SHP
`R_` `r_`	Reservoir boundary	Reservoir boundary; boundary of waterbody which intersects the snapped dam location (or raw location for existing dams).	Feature Collection	SHP
`rbz_`	Reservoir buffer zone	Buffer zone around reservoir (used for landcover analysis of existing dams commissioned <=1992)	Feature Collection	SHP
`sr_`	Simplified implified reservoir boundary	Simplified reservoir boundary (the outer boundary of the reservoir ignoring any islands). Used to determine inundated river.	Feature Collection	SHP
`S_` `s_`	Inundated river reaches (streamline)	Inundated river reaches (stream line)	Feature Collection	SHP
`MS_` `ms_`	Main inundated river channel	Main inundated river channel.	Feature Collection	SHP
`N_` `n_`	Non-inundeted catchment	Non inundated catchment	Feature Collection	SHP
`output_parameters`	Calculated Parameters	Calculated parematers	Tabular	CSV

Output Data Specification

The variables output by GeoCARET in the tabular format are listed and described in the table below.

Specification of output variables saved in the tabular output form.
name	title	description	type	contraints	required	unique	minimum	maximum	gis_layer
`id`	Dam Identifier	Dam identifier	integer		TRUE	TRUE	1		NA
`country`	Country Name	The name of the country the dam is located in (the ISO 3166 official short name (EN))	string		TRUE	FALSE			NA
`name`	Dam Name	The name of the dam	string		TRUE	FALSE			NA
`river`	River Name	The name of the river the dam will be constructed on	string		TRUE	FALSE			NA
`main_basin`	Main Basin Name	The name of main river basin the dam will be located in	string		TRUE	FALSE			NA
`dam_lat`	Dam Latitude	The latitude of the dam location in decimal degrees (DD)	number		TRUE	FALSE	-60	60	NA
`dam_lon`	Dam Longitude	The longitude of the dam location in decimal degrees (DD)	number		TRUE	FALSE	-180	180	NA
`dam_height`	Dam Height	The dam height in metres (m)	number		TRUE	FALSE	10	300	NA
`year_commissioned`	Year Commissioned	The year the dam was commissioned in	number		TRUE	FALSE	0
`fsl_msl`	Full Supply Level	The full supply level of the reservoir (masl)	number		TRUE	FALSE	-113	9148	NA
`power_capacity`	Power Capacity	The installed power capacity of the dam in megawatts (MW)	number		TRUE	FALSE	0.001	22500	NA
`turbine_efficiency`	Turbine Efficiency	The efficiency of the dam’s turbines, percentage (%)	number		TRUE	FALSE	0	100	NA
`plant_depth`	Power Plant Depth	The depth of the power plant below the base of the dam wall in metres (m)	number		TRUE	FALSE	0	300	NA
`ps_snap_displacement`	Snap Displacement	The distance between the hydroriver-snapped dam location and the raw dam location (m	number		TRUE	FALSE	0		NA
`ps_lat`	Snapped Dam Latitude	The latitude of the snapped dam location in decimal degrees (DD)	number		TRUE	FALSE	-90	90	NA
`ps_lon`	Snapped Dam Longitude	The longitude of the snapped dam location in decimal degrees (DD)	number		TRUE	FALSE	-180	180	NA
`d_dam_elevation_analysis`	Dam Elevation (Analysis)	The elevation at the dam location used in reservoir delination	number		TRUE	FALSE	-413	8848	USGS/SRTMGL1_003 OR WWF/HydroSHEDS/03CONDEM OR WWF/HydroSHEDS/15CONDEM
`d_dam_elevation_snapped`	Dam Elevation (Snapped)	The elevation at the snapped dam location	number		TRUE	FALSE	-413	8848	USGS/SRTMGL1_003 OR WWF/HydroSHEDS/03CONDEM OR WWF/HydroSHEDS/15CONDEM
`d_dam_elevation_raw`	Dam Elevation (Raw)	The elevation at the raw dam location	number		TRUE	FALSE	-413	8848	USGS/SRTMGL1_003 OR WWF/HydroSHEDS/03CONDEM OR WWF/HydroSHEDS/15CONDEM
`c_area_km2`	Area [catchment]	The area of the catchment (\(km^2\))	number		TRUE	FALSE	0		NA
`c_mean_slope_pc`	Mean slope [catchment]	The mean slope of the catchment (%)	number		TRUE	FALSE	0	241.41	USGS/SRTMGL1_003 OR WWF/HydroSHEDS/03CONDEM OR WWF/HydroSHEDS/15CONDEM
`c_biome`	Predominant biome [catchment]	The predominant biome of the catchment	string		TRUE	FALSE			RESOLVE/ECOREGIONS/2017
`c_climate_zone`	Predominant climate [catchment]	The predominant climate zone of the catchment (koppen climate zones - see 99_koppen_codes.md)	number		TRUE	FALSE			XHEET_ASSETS/Beck_KG_V1_present_0p0083
`c_population`	Population [catchment]	The population of the catchment (persons)	number		TRUE	FALSE	0		CIESIN/GPWv411/GPW_Population_Density
`c_population_density`	Population density [catchment]	The population density of the catchment (\(persons/km^2\))	number		TRUE	FALSE	0	78683	CIESIN/GPWv411/GPW_Population_Density
`c_landcover_0`	Landcover category 0 fraction [catchment]	The landcover category 0 (‘No Data’) fraction of the catchment	number		TRUE	FALSE	0	1	XHEET_ASSETS/ESACCI-LC-L4-LCCS-Map-300m-P1Y-2010-v2-0-7cds-lccs_class
`c_landcover_1`	Landcover category 1 fraction [catchment]	The landcover category 1 (‘Croplands’) fraction of the catchment	number		TRUE	FALSE	0	1	XHEET_ASSETS/ESACCI-LC-L4-LCCS-Map-300m-P1Y-2010-v2-0-7cds-lccs_class
`c_landcover_2`	Landcover category 2 fraction [catchment]	The landcover category 2 (‘Grassland/Shrubland’) fraction of the catchment	number		TRUE	FALSE	0	1	XHEET_ASSETS/ESACCI-LC-L4-LCCS-Map-300m-P1Y-2010-v2-0-7cds-lccs_class
`c_landcover_3`	Landcover category 3 fraction [catchment]	The landcover category 3 (‘Forest’) fraction of the catchment	number		TRUE	FALSE	0	1	XHEET_ASSETS/ESACCI-LC-L4-LCCS-Map-300m-P1Y-2010-v2-0-7cds-lccs_class
`c_landcover_4`	Landcover category 4 fraction [catchment]	The landcover category 4 (‘Wetlands’) fraction of the catchment	number		TRUE	FALSE	0	1	XHEET_ASSETS/ESACCI-LC-L4-LCCS-Map-300m-P1Y-2010-v2-0-7cds-lccs_class
`c_landcover_5`	Landcover category 5 fraction [catchment]	The landcover category 5 (‘Settlements’) fraction of the catchment	number		TRUE	FALSE	0	1	XHEET_ASSETS/ESACCI-LC-L4-LCCS-Map-300m-P1Y-2010-v2-0-7cds-lccs_class
`c_landcover_6`	Landcover category 6 fraction [catchment]	The landcover category 6 (‘Bare Areas’) fraction of the catchment	number		TRUE	FALSE	0	1	XHEET_ASSETS/ESACCI-LC-L4-LCCS-Map-300m-P1Y-2010-v2-0-7cds-lccs_class
`c_landcover_7`	Landcover category 7 fraction [catchment]	The landcover category 7 (‘Water Bodies’) fraction of the catchment	number		TRUE	FALSE	0	1	XHEET_ASSETS/ESACCI-LC-L4-LCCS-Map-300m-P1Y-2010-v2-0-7cds-lccs_class
`c_landcover_8`	Landcover category 8 fraction [catchment]	The landcover category 8 (‘Permanent snow and ice’) fraction of the catchment	number		TRUE	FALSE	0	1	XHEET_ASSETS/ESACCI-LC-L4-LCCS-Map-300m-P1Y-2010-v2-0-7cds-lccs_class
`c_mpet_mm`	Mean annual evapotranspiration [catchment]	The mean annual evapotranspiration for the catchment (mm/year)	number		TRUE	FALSE	0	2500	IDAHO_EPSCOR/TERRACLIMATE
`c_mpet_mm_alt1`	Mean annual evapotranspiration [catchment] alt1	The mean annual evapotranspiration for the catchment (mm/year) alt1	number		TRUE	FALSE	0	2500	XHEET_ASSETS/Eo150_clim_xyz_updated
`c_map_mm`	Mean annual precipitation [catchment]	The mean annual precipitation for the catchment (mm/year)	number		TRUE	FALSE	0	6000	XHEET_ASSETS/wc2-1_30s_bio_12
`c_map_mm_alt1`	Mean annual precipitation [catchment]	The mean annual precipitation for the catchment (mm/year)	number		TRUE	FALSE	0	6000	IDAHO_EPSCOR/TERRACLIMATE
`c_mar_mm`	Mean annual runoff [catchment] default	The mean annual runoff for the catchment (mm/year). Default definition using UNH/GRDC Composite Runoff Fields V1.0 - Fekete(2002)	number		TRUE	FALSE	0	6000	XHEET_ASSETS/cmp_ro_grdc
`c_mar_mm_alt2`	Mean annual runoff alt2 [catchment]	The mean annual runoff for the catchment (mm/year). Alternative definition 2: Long term mean (2000-2019) of TerraClimate total runoff (mm) per calendar year	number		TRUE	FALSE	0	6000	IDAHO_EPSCOR/TERRACLIMATE
`c_mmr_mm_alt2`	Mean monthly runoff alt2 [catchment]	The mean monthly runoff for the catchment (mm/year). Alternative definition 2: Long term mean (2000-2019) of TerraClimate total runoff (mm) per calendar month	number		TRUE	FALSE	0	500	IDAHO_EPSCOR/TERRACLIMATE
``c_mad_m3_peryr``	Mean annual discharge [catchment] default	The mean annual discharge for the catchment (m3/year). Default definition using UNH/GRDC Composite Runoff Fields V1.0 - Fekete(2002)	number		TRUE	FALSE	0		XHEET_ASSETS/cmp_ro_grdc
``c_mad_m3_pers``	Mean annual discharge [catchment] default	The mean annual discharge for the catchment (m3/s). Default definition using UNH/GRDC Composite Runoff Fields V1.0 - Fekete(2002)	number		TRUE	FALSE	0		XHEET_ASSETS/cmp_ro_grdc
`c_msocs_kgperm2`	Mean soil organic carbon stocks [catchment]	The mean soil organic carbon stocks of the catchment (0-30cm; \(kg C m^2\))	number		TRUE	FALSE	0		projects/soilgrids-isric/ocs_mean
`c_msocc_perc`	Mean soil organic carbon content [catchment]	The mean soil organic carbon content of the catchment (0-30cm; \(%\))			TRUE	FALSE	0		projects/soilgrids-isric/soc_mean
`c_msocc_gperkg`	Mean soil organic carbon content [catchment]	The mean soil organic carbon content of the catchment (0-30cm; \(g/kg\))			TRUE	FALSE	0		projects/soilgrids-isric/soc_mean
`c_msnc_gperkg`	Mean soil total nitrogen content [catchment]	The mean soil nitrogen content of the catchment (0-30cm; \(g/kg\))			TRUE	FALSE	0		projects/soilgrids-isric/nitrogen_mean
`c_msbdod_kgperdm3`	Mean soil bulk density [catchment]	The mean soil bulk of the catchment (0-30cm; \(kg/dm^3\))			TRUE	FALSE	0		projects/soilgrids-isric/bdod_mean
`c_doc_export`	DOC export [non-inundated catchment]	The dissolved organic carbon (DOC) export [non-inundated catchment] (kg y-1)	number		TRUE	FALSE			projects/soilgrids-isric/soc_mean; projects/soilgrids-isric/nitrogen_mean
`c_mswn_molperkg`	Mean strata_weighted mols N /kg [catchment]	Mean strata_weighted mols N /kg [catchment]	number		TRUE	FALSE	0	71	projects/soilgrids-isric/nitrogen_mean
`c_mswc_molperkg`	Mean strata_weighted mols C/kg [catchment]	Mean strata_weighted mols C /kg [catchment]	number		TRUE	FALSE	0	83	projects/soilgrids-isric/soc_mean
`c_soil_type`	Soil Type [catchment]	The predominant soil type (mineral/organic) of the catchment area	string		TRUE	FALSE			projects/soilgrids-isric/ocs_mean
`c_masm_mm`	Mean soil moisture [catchment]	The nean soil moisture of the catchment (mm/m soil depth)	number		TRUE	FALSE	0		NASA_USDA/HSL/SMAP10KM_soil_moisture
`c_mean_olsen`	Soil Olsen P [catchment]	The soil Olsen P of the catchment (kg ha-1)	number		TRUE	FALSE	0		XHEET_ASSETS/OlsenP_kgha1_World
`n_population`	Population [non-inundated catchment]	The population of non-inundated catchment (persons)	number		TRUE	FALSE	0		CIESIN/GPWv411/GPW_Population_Density
`n_population_density`	Population density [non-inundated catchment]	The population of non-inundated catchment (\(persons/km^2\))	number		TRUE	FALSE	0	78683	CIESIN/GPWv411/GPW_Population_Density
`n_doc_export`	DOC export [non-inundated catchment]	The dissolved organic carbon (DOC) export [non-inundated catchment] (kg y-1)	number		TRUE	FALSE			projects/soilgrids-isric/soc_mean; projects/soilgrids-isric/nitrogen_mean
`n_mswn_molperkg`	Mean strata_weighted mols N /kg [ni catchment]	Mean strata_weighted mols N /kg [ni catchment]	number		TRUE	FALSE	0	71	projects/soilgrids-isric/nitrogen_mean
`n_mswc_molperkg`	Mean strata_weighted mols C/kg [ni catchment]	Mean strata_weighted mols C /kg [ni catchment]	number		TRUE	FALSE	0	83	projects/soilgrids-isric/soc_mean
`r_imputed_water_level`	Imputed water level	The imputed water level (m) relative to the base of the dam	number		TRUE	FALSE	0		NA
`r_imputed_water_level_prov`	Imputed water level provenance	The imputed water level provenance (0 - inputted water level, 1 - inputted dam height , 2- calculated dam height )	number		TRUE	FALSE	0		NA
`r_area_km2`	Area [reservoir]	The area of the reservoir (\(km^2\))	number		TRUE	FALSE	0		NA
`r_volume_m3`	Volume [reservoir]	The volume of the reservoir (\(m^3\))	number		TRUE	FALSE	0		USGS/SRTMGL1_003 OR WWF/HydroSHEDS/03CONDEM OR WWF/HydroSHEDS/15CONDEM
`r_mean_depth_m`	Mean depth [reservoir]	The mean depth of the reservoir (m)	number		TRUE	FALSE	0		USGS/SRTMGL1_003 OR WWF/HydroSHEDS/03CONDEM OR WWF/HydroSHEDS/15CONDEM
`r_maximum_depth_m`	Maximum depth [reservoir]	The maximum depth of the reservoir (m); Default definition 1: max(Water Elevation(res) - Land Elevation(res))	number		TRUE	FALSE	0		USGS/SRTMGL1_003 OR WWF/HydroSHEDS/03CONDEM OR WWF/HydroSHEDS/15CONDEM
`r_maximum_depth_m_alt1`	Maximum depth [reservoir] alt 1	The maximum depth of the reservoir (m); Alternative definition 1: Max Elevation(res) - Min Elevation(dam) NB: this definition assumes that the deepest point of the reservoir is at the dam wall	number		TRUE	FALSE	0		USGS/SRTMGL1_003 OR WWF/HydroSHEDS/03CONDEM OR WWF/HydroSHEDS/15CONDEM
`r_maximum_depth_m_alt2`	Maximum depth [reservoir] alt 2	The maximum depth of the reservoir (m); Alternative 2: Max Elevation(res) - Min Elevation(res)	number		TRUE	FALSE	0		USGS/SRTMGL1_003 OR WWF/HydroSHEDS/03CONDEM OR WWF/HydroSHEDS/15CONDEM
`r_landcover_bysoil_0`	Landcover/soil type category 0 fraction [reservoir]	The landcover/soil type category (‘Mineral - No Data’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_1`	Landcover/soil type category 1 fraction [reservoir]	The landcover/soil type category 1 (‘Mineral - Croplands’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_2`	Landcover/soil type category 2 fraction [reservoir]	The landcover/soil type category 2 (‘Mineral - Grassland/Shrubland’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_3`	Landcover/soil type category 3 fraction [reservoir]	The landcover/soil type category 3 (‘Mineral - Forest’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_4`	Landcover/soil type category 4 fraction [reservoir]	The landcover/soil type category 4 (‘Mineral - Wetlands’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_5`	Landcover/soil type category 5 fraction [reservoir]	The landcover/soil type category 5 (‘Mineral - Settlements’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_6`	Landcover/soil type category 6 fraction [reservoir]	The landcover/soil type category 6 (‘Mineral - Bare Areas’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_7`	Landcover/soil type category 7 fraction [reservoir]	The landcover/soil type category 7 (‘Mineral - Water Bodies’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_8`	Landcover/soil type category 8 fraction [reservoir]	The landcover/soil type category 8 (‘Mineral - Permanent snow and ice’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_9`	Landcover/soil type category 9 fraction [reservoir]	The landcover/soil type category 9 (‘Organic - No Data’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_10`	Landcover/soil type category 10 fraction [reservoir]	The landcover/soil type category 10 (‘Organic - Croplands’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_11`	Landcover/soil type category 11 fraction [reservoir]	The landcover/soil type category 11 (‘Organic - Grassland/Shrubland’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_12`	Landcover/soil type category 12 fraction [reservoir]	The landcover/soil type category 12 (‘Organic - Forest’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_13`	Landcover/soil type category 13 fraction [reservoir]	The landcover/soil type category 13 (‘Organic - Wetlands’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_14`	Landcover/soil type category 14 fraction [reservoir]	The landcover/soil type category 14 (‘Organic - Settlements’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_15`	Landcover/soil type category 15 fraction [reservoir]	The landcover/soil type category 15 (‘Organic - Bare Areas’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_16`	Landcover/soil type category 16 fraction [reservoir]	The landcover/soil type category 16 (‘Organic - Water Bodies’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_17`	Landcover/soil type category 17 fraction [reservoir]	The landcover/soil type category 17 (‘Organic - Permanent snow and ice’) fraction of the reservoir	number		TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_18`	Landcover/soil type category 18 fraction [reservoir]	The landcover/soil type category 18 (‘No Data - No Data’) fraction of the reservoir			TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_19`	Landcover/soil type category 19 fraction [reservoir]	The landcover/soil type category 19 (‘No Data - Croplands’) fraction of the reservoir			TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_20`	Landcover/soil type category 20 fraction [reservoir]	The landcover/soil type category 20 (‘No Data - Grassland/Shrubland’) fraction of the reservoir			TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_21`	Landcover/soil type category 21 fraction [reservoir]	The landcover/soil type category 21 (‘No Data - Forest’) fraction of the reservoir			TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_22`	Landcover/soil type category 22 fraction [reservoir]	The landcover/soil type category 22 (‘No Data - Wetlands’) fraction of the reservoir			TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_23`	Landcover/soil type category 23 fraction [reservoir]	The landcover/soil type category 23 (‘No Data - Settlements’) fraction of the reservoir			TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_24`	Landcover/soil type category 24 fraction [reservoir]	The landcover/soil type category 24 (‘No Data - Bare Areas’) fraction of the reservoir			TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_25`	Landcover/soil type category 25 fraction [reservoir]	The landcover/soil type category 25 (‘No Data - Water Bodies’) fraction of the reservoir			TRUE	FALSE	0	1	Derived
`r_landcover_bysoil_26`	Landcover/soil type category 26 fraction [reservoir]	The landcover/soil type category 26 (‘No Data - Permanent snow and ice’) fraction of the reservoir			TRUE	FALSE	0	1	Derived
`r_mean_temp_1`	Mean monthly temperature (Jan) [reservoir]	Mean monthly temperature (Jan) for reservoir (degrees C)	number		TRUE	FALSE	-90	57	XHEET_ASSETS/wc2-1_30s_tavg
`r_mean_temp_2`	Mean monthly temperature (Feb) [reservoir]	Mean monthly temperature (Feb) for reservoir (degrees C)	number		TRUE	FALSE	-90	57	XHEET_ASSETS/wc2-1_30s_tavg
`r_mean_temp_3`	Mean monthly temperature (Mar) [reservoir]	Mean monthly temperature (Mar) for reservoir (degrees C)	number		TRUE	FALSE	-90	57	XHEET_ASSETS/wc2-1_30s_tavg
`r_mean_temp_4`	Mean monthly temperature (Apr) [reservoir]	Mean monthly temperature (Apr) for reservoir (degrees C)	number		TRUE	FALSE	-90	57	XHEET_ASSETS/wc2-1_30s_tavg
`r_mean_temp_5`	Mean monthly temperature (May) [reservoir]	Mean monthly temperature (May) for reservoir (degrees C)	number		TRUE	FALSE	-90	57	XHEET_ASSETS/wc2-1_30s_tavg
`r_mean_temp_6`	Mean monthly temperature (Jun) [reservoir]	Mean monthly temperature (Jun) for reservoir (degrees C)	number		TRUE	FALSE	-90	57	XHEET_ASSETS/wc2-1_30s_tavg
`r_mean_temp_7`	Mean monthly temperature (Jul) [reservoir]	Mean monthly temperature (Jul) for reservoir (degrees C)	number		TRUE	FALSE	-90	57	XHEET_ASSETS/wc2-1_30s_tavg
`r_mean_temp_8`	Mean monthly temperature (Aug) [reservoir]	Mean monthly temperature (Aug) for reservoir (degrees C)	number		TRUE	FALSE	-90	57	XHEET_ASSETS/wc2-1_30s_tavg
`r_mean_temp_9`	Mean monthly temperature (Sep) [reservoir]	Mean monthly temperature (Sep) for reservoir (degrees C)	number		TRUE	FALSE	-90	57	XHEET_ASSETS/wc2-1_30s_tavg
`r_mean_temp_10`	Mean monthly temperature (Oct) [reservoir]	Mean monthly temperature (Oct) for reservoir (degrees C)	number		TRUE	FALSE	-90	57	XHEET_ASSETS/wc2-1_30s_tavg
`r_mean_temp_11`	Mean monthly temperature (Nov) [reservoir]	Mean monthly temperature (Nov) for reservoir (degrees C)	number		TRUE	FALSE	-90	57	XHEET_ASSETS/wc2-1_30s_tavg
`r_mean_temp_12`	Mean monthly temperature (Dec) [reservoir]	Mean monthly temperature (Dec) for reservoir (degrees C)	number		TRUE	FALSE	-90	57	XHEET_ASSETS/wc2-1_30s_tavg
`r_mghr_all_kwhperm2perday`	Mean global horizonal radiance [reservoir]	Mean global horizontal radiance, reservoir (\(kWh m^2 d^-1\)); Default definition from NASA/SSE Irradiance Data 1983-2005	number		TRUE	FALSE	0		XHEET_ASSETS/GHI_NASA_low
`r_mghr_all_kwhperm2perday_alt1`	Mean global horizonal radiance, alt1 [reservoir]	Mean global horizontal radiance (\(kWh m^2 d^-1\)); Alternative definition 1: Long term annual mean (2000-2019) of downward surface shortwave radiation (srad) from TerraClimate [UNAVAILABLE].	number		TRUE	FALSE	0		XHEET_ASSETS/GHI_NASA_low
`r_mghr_may_sept_kwhperm2perday`	Mean global horizonal radiance May-Sept [reservoir]	Mean global horizontal radiance May-Sept, reservoir (\(kWh m^2 d^-1\)); Default definition from NASA/SSE Irradiance Data 1983-2005	number		TRUE	FALSE	0		XHEET_ASSETS/GHI_NASA_low
`r_mghr_may_sept_kwhperm2perday_alt1`	Mean global horizonal radiance May-Sept [reservoir]	Mean global horizontal radiance May-Sept, reservoir (\(kWh m^2 d^-1\)); Alternative definition 1: Long term annual mean (2000-2019) of downward surface shortwave radiation (srad) from TerraClimate [UNAVAILABLE].	number		TRUE	FALSE	0		XHEET_ASSETS/GHI_NASA_low
`r_mghr_nov_mar_kwhperm2perday`	Mean global horizonal radiance Nov-Mar [reservoir]	Mean global horizontal radiance Nov-Mar, reservoir (\(kWh m^2 d^-1\)); Alternative definition 1: Default definition from NASA/SSE Irradiance Data 1983-2005	number		TRUE	FALSE	0		XHEET_ASSETS/GHI_NASA_low
`r_mghr_nov_mar_kwhperm2perday_alt1`	Mean global horizonal radiance Nov-Mar [reservoir]	Mean global horizontal radiance Nov-Mar, reservoir (\(kWh m^2 d^-1\)); Alternative definition 1: Long term annual mean (2000-2019) of downward surface shortwave radiation (srad) from TerraClimate [UNAVAILABLE].	number		TRUE	FALSE	0		XHEET_ASSETS/GHI_NASA_low
`r_msocs_kgperm2`	Mean soil organic carbon stocks [reservoir]	The mean soil organic carbon stocks of the reservoir (0-30cm; \(kg C m^2\))	number		TRUE	FALSE	0		projects/soilgrids-isric/ocs_mean
`r_msocc_perc`	Mean soil organic carbon content [reservoir]	The mean soil organic carbon content of the reservoir (0-30cm; \(%\))			TRUE	FALSE	0		projects/soilgrids-isric/soc_mean
`r_msocc_gperkg`	Mean soil organic carbon content [reservoir]	The mean soil organic carbon content of the reservoir (0-30cm; \(g/kg\))			TRUE	FALSE	0		projects/soilgrids-isric/soc_mean
`r_msnc_gperkg`	Mean soil total nitrogen content [reservoir]	The mean soil nitrogen content of the reservoir (0-30cm; \(g/kg\))			TRUE	FALSE	0		projects/soilgrids-isric/nitrogen_mean
`r_msbdod_kgperdm3`	Mean soil bulk density [reservoir]	The mean soil bulk of the reservoir (0-30cm; \(kg/dm^3\))			TRUE	FALSE	0		projects/soilgrids-isric/bdod_mean
`r_mean_annual_windspeed_mpers`	Mean annual wind speed [reservoir]	Mean annual wind speed at the reservoir (\(m s^-1\))	number		TRUE	FALSE	0		IDAHO_EPSCOR/TERRACLIMATE
`ms_length`	Length of inundated river [reservoir]	Length of inundated river (km)	number		TRUE	FALSE	0		XHEET_ASSETS/HydroRIVERS_v10
`t_landcover_analysis_yr`	Landcover data year (landcover analysis)	Date of landcover data used in landcover analysis	number		TRUE	FALSE
`t_landcover_delineation_yr`	Landcover data year (reservoir delineation)	Date of landcover data used in delineation of existing reservoirs	number		TRUE	FALSE
`t_landcover_buffer_method`	Buffer method indicator	Buffer method used in landcover analysis?	number		TRUE	FALSE
`error_code`	Error codes	Error code;	number		TRUE	FALSE	0

The specification can be also downloaded in a CSV file format by clicking on the icon below.

Guide to Codes

Error Codes

If the analysis of a dam location fails part way through, all output files and parameters calculated up to the point of failure will be saved and exported. Any parameters that cannot be calculated are assigned a missing value using the codes below. An error code is assigned to each dam to indicate whether the analysis completed successfully or not.

Code	Definition
0	No Error (complete analysis)
1	Analysis failed at snapping dam to hydroriver
2	Analysis failed at catchment delineation or catchment parameter generation
3	Analysis failed at reservoir delineation or reservoir parameter generation
4	Analysis failed at non-inundated catchment delineation or non-inundated catchment parameter generation
5	Analysis failed at river delineation or river parameter generation

Missing Data Codes

Missing data, e.g. data that could not be calculated for some reason or the calculation method is still under development, is handled in several ways depending on the root cause of the data being missing. See below

Missing numerical/string parameters, which are still “under development” are assigned a string value of “UD”.
Missing numerical parameters (which are not under developemnt) are assigned a string value of “NA” (happens when delineation has failed).
Missing parameters are assigned a string value of “NONE” (happens when delineation has failed).
Missing numerical parameters are assigned a string value of “ND” when calculation evaluates to None, e.g. if there is missing data in GIS layer.
Missing string parameters are assigned a string value of “NODATA” when calculation evaluates to None e.g. if there is missing data in GIS layer.

Provenance Codes

Note

Applies to future dams only.

The variable r_imputed_water_elevation_prov is a key variable that is used to indicate how water elevation of the future dam has been derived for delineation.

Code	Definition
0	User input full supply level
1	User input dam height
2	Dam height estimated from power capacity (user inputted turbine efficiency)
3	Dam height estimated from power capacity (assuming turbine efficiency of 85%)

Attention

Plant depth is assumed to be “0” unless the user-specified a different value.

Handling existing dams

When modelling existing dams, the following parameters cannot be generated due to the lack of elevation data that pre-dates commissioning:

r_imputed_water_elevation
r_volume_m3
r_mean_depth_m
r_maximum_depth_m
r_maximum_depth_m_alt1
r_maximum_depth_m_alt2

Attention

This data needs to be provided manually, e.g. obtained from different data sources.

Hint

For the purpose of GHG emission estimation we need: reservoir volume, mean dept h and max depth. Additional knowledge of bathymetry is very helpful for estimating CH4 emissions as it allows a more accurate estimation of the littoral zone, but it is not mandatory. Rather a luxury to have.

GIS Assets

Exporting to Google Drive