Skip to content
Snippets Groups Projects
Commit 617dc7d8 authored by Lemaire Louis's avatar Lemaire Louis
Browse files

[docs] Add Args type

Add "arg type:" lines
parent f6a9fa9c
No related branches found
No related tags found
1 merge request!38[feature] Gras-Sim model doctrings
......@@ -102,10 +102,14 @@ class Plants():
If the first day of the year, reset ST to zero and initialize the output dictionary for the year.
Args:
day: datetime object
WD: dictionary with the weather data (Rain [mm], Avg_temp [°C])
day: today's date
day type: datetime object
WD: weather data (Rain [mm], Avg_temp [°C])
WD type: dictionary
ET0: potential evapotranspiration [mm]
ET0 type: float
day_irr: today's irradiance [MJ/m²]
day_irr type: numpy array of shape grid
"""
self.day = day
self.year = str(day.year)
......
......@@ -9,9 +9,12 @@ class Soil():
Initialize the output dictionary and initialize the spatialized soil.
Args:
grid: tuple of (x, y), shape of the grid
inits: dictionary of initial variables
variables_to_save: list of strings of variables to save
grid: shape of the grid
grid type: tuple (x, y)
inits: initial values of variables
inity type: dictionary
variables_to_save: names of variables to save in the output dictionary
variables_to_save type: list
"""
self.grid = grid
self.inits = inits
......@@ -48,7 +51,8 @@ class Soil():
If the first day of the year initialize the output dictionary for the year.
Args:
day: datetime object
day: today's date
day type: datetime object
"""
self.day = day
self.year = str(day.year)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment