Skip to content

Commit

Permalink
Typos and docstring update
Browse files Browse the repository at this point in the history
  • Loading branch information
rbarillot committed May 24, 2024
1 parent 596657d commit 13b8cc9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
4 changes: 2 additions & 2 deletions senescwheat/converter.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ def from_dataframes(roots_inputs, axes_inputs, elements_inputs):
:return: The inputs/outputs in a dictionary.
:rtype: dict [str, dict]
.. seealso:: see :attr:`simulation.Simulation.inputs` and :attr:`simulation.Simulation.outputs`
seealso:: see :attr:`simulation.Simulation.inputs` and :attr:`simulation.Simulation.outputs`
for the structure of Senesc-Wheat inputs/outputs.
"""
Expand Down Expand Up @@ -93,7 +93,7 @@ def to_dataframes(data_dict):
:return: One dataframe for roots inputs/outputs, one dataframe for axes inputs/outputs, one dataframe for elements inputs/outputs.
:rtype: (pandas.DataFrame, pandas.DataFrame, pandas.DataFrame)
.. seealso:: see :attr:`simulation.Simulation.inputs` and :attr:`simulation.Simulation.outputs`
seealso:: see :attr:`simulation.Simulation.inputs` and :attr:`simulation.Simulation.outputs`
for the structure of Senesc-Wheat inputs/outputs.
"""
Expand Down
4 changes: 3 additions & 1 deletion senescwheat/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ def calculate_if_element_is_over(cls, green_area, is_growing, mstruct):

@classmethod
def calculate_remobilisation_proteins(cls, organ, element_index, proteins, relative_delta_green_area, ratio_N_mstruct_max, full_remob):
"""Protein remobilisation due to senescence over DELTA_T. Part is remobilized as amino_acids (µmol N), the rest is increasing Nresidual (g).
"""Protein remobilisation due to senescence over DELTA_T. Part is remobilised as amino_acids (µmol N), the rest is increasing Nresidual (g).
:param str organ: name of the organ
:param int element_index: phytomer rank
Expand Down Expand Up @@ -206,6 +206,8 @@ def calculate_roots_senescence(cls, mstruct, Nstruct, postflowering_stages):
"""Root senescence
:param float mstruct: structural mass (g)
:param float Nstruct: structural N (g)
:param bool postflowering_stages: if True the model will calculate root growth with the parameters calibrated for post flowering stages
:return: Rate of mstruct loss by root senescence (g mstruct s-1), rate of Nstruct loss by root senescence (g Nstruct s-1)
:rtype: tuple [float, float]
"""
Expand Down

0 comments on commit 13b8cc9

Please sign in to comment.