Doc hydro signatures #373
Doc hydro signatures #373
Conversation
| This section aims to go into detail on how to compute and vizualize some hydrological signatures | ||
| (a list of studied signatures and their formula is given in :ref:`Math / Num Documentation <math_num_documentation.hydrological_signature>`). |
There was a problem hiding this comment.
| (a list of studied signatures and their formula is given in :ref:`Math / Num Documentation <math_num_documentation.hydrological_signature>`). | |
| For more details see :ref:Math / Num Documentation <math_num_documentation.hydrological_signature>. |
| This section aims to go into detail on how to compute and vizualize some hydrological signatures |
There was a problem hiding this comment.
| This section aims to go into detail on how to compute and vizualize some hydrological signatures | |
| This section aims to go into detail on how to compute and vizualize some hydrological signatures. | |
| The signatures provide to describe the properties of discharge and can use to improve the calibration of the hydrological models. |
| ********************* | ||
|
|
||
| Now, we need to create a :class:`smash.Model` object. |
There was a problem hiding this comment.
| Now, we need to create a :class:`smash.Model` object. |
|
|
||
| Now, we need to create a :class:`smash.Model` object. | ||
| For this case, we will use the :ref:`user_guide.demo_data.cance` dataset as an example. |
There was a problem hiding this comment.
| For this case, we will use the :ref:`user_guide.demo_data.cance` dataset as an example. | |
| For this case, we use the :ref:`user_guide.demo_data.cance` dataset. |
| ********************** | ||
|
|
||
| To start we need to do a forward_run (or optimization) simulation. Then the sinatures computation is available using the `smash.signatures` function which has three argument (model, domain and event_seg). |
There was a problem hiding this comment.
The smash.signatures function provide to compute signatures.
By default, the signatures are computed on the observed informations of hydrograph segmentation of flood events of the model, but they could be based on the simulated data, by changing the argument domain of the function. About the default definition of hydrograph segmentation, see :ref:user_guide.classical_uses.hydrograph_segmentation.
| The signatures coputation result object contains 2 attributes which are 2 different dictionaries: | ||
|
|
||
| - ``cont`` : Continuous signatures computation result, |
There was a problem hiding this comment.
| - ``cont`` : Continuous signatures computation result, | |
| - ``cont`` : Continuous signatures computation result, on all the discharge time series, |
| - ``cont`` : Continuous signatures computation result, | ||
|
|
||
| - ``event``: Flood event signatures computation result. |
There was a problem hiding this comment.
| - ``event``: Flood event signatures computation result. | |
| - ``event``: Flood events signatures computation result. |
| - ``event``: Flood event signatures computation result. | ||
|
|
||
| For example, we can display the simulated continuous and flood event signatures as follow. |
There was a problem hiding this comment.
| For example, we can display the simulated continuous and flood event signatures as follow. | |
| We can display the simulated continuous and flood events signatures as follow. |
| sig_sim.event | ||
|
|
||
| Now, we visualize, for instance, the simulated and observed flood event runoff coefficients in the boxplots below. |
There was a problem hiding this comment.
| Now, we visualize, for instance, the simulated and observed flood event runoff coefficients in the boxplots below. | |
| Now, we visualize the boxplots of simulated and observed flood event runoff coefficients as below. |
| @savefig user_guide.classical_uses.hydrological_signatures_boxplot.png | ||
| boxplot = df.boxplot(column=["Erc", "Erchf", "Erclf", "Erch2r"], by="domain") | ||
|
|
There was a problem hiding this comment.
Can u add a qualitative explanation about each signature u show ?
There was a problem hiding this comment.
Thank you both, @ahmad-3100 for your work and @asjeb for your comments. I just committed an enhancement/readability improvement for this tutorial. I approve this PR and will merge it into the main branch.
No description provided.