This text is the same for all the issues that follow this formatting so if you read it once, you can skip this paragraph.
Building on the module descriptions that make up the documentation I have attempted to add some information to individual parameters and returns that explain the things I didn't understand at first. Most sources are just Müller Schmied et al. and a link is given in the rare cases where I consulted another source. The formatting for those is not final and done in the current way for readability here.
The list goes beyond rephrasing and attempts to explain things, so I have added the complete list for someone to vet. If everything looks good, or there are changes I should make I will make them and commit the changes afterwards.
Parameters
max_soil_water_content : array
The maximum amount of water able to be stored in soil is the variable max_soil_water_content.
Units: [mm]
builtup_area : array
The fraction of the total land area which is considered Urban based on the MODIS data set, section C [source]. In such areas 50% of all precipitation is directly converted into runoff.
Data is taken from [Static Data -> watergap_22d_builtup_area_frac.nc4]
Units: [-]
Source: https://modis.gsfc.nasa.gov/data/
groundwater_recharge_factor : array
Groundwater recharge factor taken from [source]
Data taken from [Static Data -> watergap_22d_gw_factor_corr.nc4]
Units: [-]
Source: https://hess.copernicus.org/articles/12/863/2008/
effective_precipitation : array
The effective precipitation is the fraction of the total precipitation P that is available to plants and is computed as a simple empirical function of precipitation.
Units: [mm/day]
Returns
effective_precipitation : array
The effective precipitation is the fraction of the total precipitation P that is available to plants and is computed as a simple empirical function of precipitation.
Units: [mm/day]
immediate_runoff : array
The fraction of effective precipitation that immediately becomes runoff.
Units: [mm/day]
https://github.com/HydrologyFrankfurt/ReWaterGAP/blob/62a9bd18fcb3d352eedcdb26ea1dc0c1a81dd26f/core/verticalwaterbalance/soil.py
This text is the same for all the issues that follow this formatting so if you read it once, you can skip this paragraph.
Building on the module descriptions that make up the documentation I have attempted to add some information to individual parameters and returns that explain the things I didn't understand at first. Most sources are just Müller Schmied et al. and a link is given in the rare cases where I consulted another source. The formatting for those is not final and done in the current way for readability here.
The list goes beyond rephrasing and attempts to explain things, so I have added the complete list for someone to vet. If everything looks good, or there are changes I should make I will make them and commit the changes afterwards.
Parameters
max_soil_water_content : array The maximum amount of water able to be stored in soil is the variable max_soil_water_content. Units: [mm]
builtup_area : array The fraction of the total land area which is considered Urban based on the MODIS data set, section C [source]. In such areas 50% of all precipitation is directly converted into runoff. Data is taken from [Static Data -> watergap_22d_builtup_area_frac.nc4] Units: [-] Source: https://modis.gsfc.nasa.gov/data/
drainage_direction : array The drainage direction for any given grid cell is based on the drainage direction map DDM30 [source]. This data is taken from [Static Data -> drainage_direction.nc] Units: [-] Source: https://www.sciencedirect.com/science/article/abs/pii/S0022169401005650?via%3Dihub
max_groundwater_recharge : array Maximum groundwater recharge data taken from [source]. Data taken from [Static Data -> watergap_22d_max_recharge.nc4 Units: [mm/day] Source: https://agupubs.onlinelibrary.wiley.com/doi/full/10.1002/2014WR015595
soil_texture : array Soil texture class based on [source]. Data taken from [Static Data -> texture.nc] Units: [-] Source: https://hess.copernicus.org/articles/12/863/2008/hess-12-863-2008.pdf
groundwater_recharge_factor : array Groundwater recharge factor taken from [source] Data taken from [Static Data -> watergap_22d_gw_factor_corr.nc4] Units: [-] Source: https://hess.copernicus.org/articles/12/863/2008/
arid_gw_cell : array Humid-arid classification array based on [1]. Data taken from [Static Data -> watergap_22e_aridhumid.nc4] Units: [-] Source: https://gmd.copernicus.org/articles/14/1037/2021/#App1.Ch1.S2.F16 Figure B1
effective_precipitation : array The effective precipitation is the fraction of the total precipitation P that is available to plants and is computed as a simple empirical function of precipitation. Units: [mm/day]
Returns
effective_precipitation : array The effective precipitation is the fraction of the total precipitation P that is available to plants and is computed as a simple empirical function of precipitation. Units: [mm/day]
immediate_runoff : array The fraction of effective precipitation that immediately becomes runoff. Units: [mm/day]