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
Temperature : array
Daily temperature climate forcing.
Data is taken from [input_data/climate_forcing/temperature].
Units: [K]
growth_status : array
Growth status per grid cell shows whether a specific land cover is not growing (value = 0), growing (value = 0), or fully grown (value = 1). Initially, all landcovers are not growing. The growing season starts when the daily temperature is above 8°C for a specific number of days. A comprehensive list for the specific number of days can be found here [Müller Schmied et al 2021, Table C2].
This variable gets updated per time step.
Units: [-]
Days : array
The number of days since the start of the leaf area index profile. The number of days is used to track the growing conditions per time step.
This variable gets updated per time step.
Units: [days]
initial_days : array
The initial days array saves the specific number of days for each land cover type, for which the daily temperature must stay above 8°C to initialize the start of the growing season. A comprehensive list for the specific number of days can be found here [Müller Schmied et al 2021, Table C2].
Units: [days]
cum_precipitation : array
The cumulative precipitation is the sum of all precipitations from day 0 to the current day.
Units: [mm/d]
Precipitation : array
The daily precipitation climate forcing.
Data is taken from [input_data/climate_forcing/precipitation].
Units are converted from [kg m-2 s-1] to [mm/d]
leaf_area_index : array
Depending on the growth status, Temperature, Cumulative precipitation and current number of days, the leaf area index is calculated as a value between and including MIN_LAI and MAX_LAI for each grid cell.
Units: [-]
min_leaf_area_index : array
Minimum Leaf area index over all grid cells.
Units: [-]
max_leaf_area_index : array
Maximum LAI values are based on literature and dependent on the land cover type.
Units: [-]
land_cover : array
WaterGAP uses a static land cover input map as described in [Müller Schmied et all 2021, Table C1].
Data taken from [input_data/static_input/watergap_22d_landcover.nc4]
humid_arid : array
Humid-arid classification array based on [Müller Schmied et all. 2021, Figure C1].
Data taken from [Static Data -> watergap_22e_aridhumid.nc4].
Units: [-]
Returns
leaf_area_index : array
Depending on the growth status, Temperature, Cumulative precipitation and current number of days, the leaf area index is calculated as a value between and including MIN_LAI and MAX_LAI for each grid cell.
Units: [-]
Days : array
Days since start for the current day.
Units: [day]
cum_precipitation : array
The cumulative precipitation is the sum of all precipitations from day 0 to the current day.
Units: [mm/d]
growth_status : array
Growth status per grid cell shows whether a specific land cover is not growing (value = 0), growing (value = 0), or fully grown (value = 1). Initially all landcovers are not growing. The growing season starts when the daily temperature is above 8°C for a specific number of days. A comprehensive list for the specific number of days can be found here [Müller Schmied et al. 2021, Table C2].
This variable gets updated per time step.
Units: [-]
Notes
A day is defined as part of the growing season when daily temperature is above 8◦C(281.15 K) for a land-cover-specific number of initial days (Table C1) and cumulative precipitation from the day where growing season starts reaches at least 40 mm [1].
In the beginning of the growing season, LAI increases linearly for 30 days until it reaches maximum LAI. For (semi)arid cells, at least 0.5 mm of daily precipitation is required to keep the growing season on-going. LAI then stays constant for the stated land-cover-specific number of days and when growing season conditions are not fulfilled anymore, a senescence phase is initiated, and LAI linearly decreases to minimum within the next 30 days.
https://github.com/HydrologyFrankfurt/ReWaterGAP/blob/62a9bd18fcb3d352eedcdb26ea1dc0c1a81dd26f/core/verticalwaterbalance/parallel_leaf_area_index.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
Temperature : array Daily temperature climate forcing. Data is taken from [input_data/climate_forcing/temperature]. Units: [K] growth_status : array Growth status per grid cell shows whether a specific land cover is not growing (value = 0), growing (value = 0), or fully grown (value = 1). Initially, all landcovers are not growing. The growing season starts when the daily temperature is above 8°C for a specific number of days. A comprehensive list for the specific number of days can be found here [Müller Schmied et al 2021, Table C2]. This variable gets updated per time step. Units: [-] Days : array The number of days since the start of the leaf area index profile. The number of days is used to track the growing conditions per time step. This variable gets updated per time step. Units: [days] initial_days : array The initial days array saves the specific number of days for each land cover type, for which the daily temperature must stay above 8°C to initialize the start of the growing season. A comprehensive list for the specific number of days can be found here [Müller Schmied et al 2021, Table C2]. Units: [days] cum_precipitation : array The cumulative precipitation is the sum of all precipitations from day 0 to the current day. Units: [mm/d] Precipitation : array The daily precipitation climate forcing. Data is taken from [input_data/climate_forcing/precipitation]. Units are converted from [kg m-2 s-1] to [mm/d] leaf_area_index : array Depending on the growth status, Temperature, Cumulative precipitation and current number of days, the leaf area index is calculated as a value between and including MIN_LAI and MAX_LAI for each grid cell. Units: [-] min_leaf_area_index : array Minimum Leaf area index over all grid cells. Units: [-] max_leaf_area_index : array Maximum LAI values are based on literature and dependent on the land cover type. Units: [-] land_cover : array WaterGAP uses a static land cover input map as described in [Müller Schmied et all 2021, Table C1]. Data taken from [input_data/static_input/watergap_22d_landcover.nc4] humid_arid : array Humid-arid classification array based on [Müller Schmied et all. 2021, Figure C1]. Data taken from [Static Data -> watergap_22e_aridhumid.nc4]. Units: [-]
Returns
leaf_area_index : array Depending on the growth status, Temperature, Cumulative precipitation and current number of days, the leaf area index is calculated as a value between and including MIN_LAI and MAX_LAI for each grid cell. Units: [-] Days : array Days since start for the current day. Units: [day] cum_precipitation : array The cumulative precipitation is the sum of all precipitations from day 0 to the current day. Units: [mm/d] growth_status : array Growth status per grid cell shows whether a specific land cover is not growing (value = 0), growing (value = 0), or fully grown (value = 1). Initially all landcovers are not growing. The growing season starts when the daily temperature is above 8°C for a specific number of days. A comprehensive list for the specific number of days can be found here [Müller Schmied et al. 2021, Table C2]. This variable gets updated per time step. Units: [-]
Notes
A day is defined as part of the growing season when daily temperature is above 8◦C(281.15 K) for a land-cover-specific number of initial days (Table C1) and cumulative precipitation from the day where growing season starts reaches at least 40 mm [1]. In the beginning of the growing season, LAI increases linearly for 30 days until it reaches maximum LAI. For (semi)arid cells, at least 0.5 mm of daily precipitation is required to keep the growing season on-going. LAI then stays constant for the stated land-cover-specific number of days and when growing season conditions are not fulfilled anymore, a senescence phase is initiated, and LAI linearly decreases to minimum within the next 30 days.