Commit 11ded839 authored by Dorchies David's avatar Dorchies David
Browse files

doc: update Severn vignettes with parameter regularisation

Refs #54
parent 2da26982
Pipeline #25820 passed with stage
in 5 minutes and 40 seconds
......@@ -87,19 +87,29 @@ RunOptions <- CreateRunOptions(
## GRiwrmInputsCrit object
The `CreateInputsCrit()` function allows to prepare the input in order to calculate a criterion. It needs the following arguments:
The `CreateInputsCrit()` function allows to prepare the input in order to calculate a criterion. We use composed criterion with a parameter regularisation based on @delavenneRegularizationApproachImprove2019.
It needs the following arguments:
* `InputsModel`: the inputs of the `GRiwrm` network previously prepared by the `CreateInputsModel()` function
* `FUN_CRIT`: the name of the error criterion function (see the available functions description in the **airGR** package)
* `RunOptions`: the options of the `GRiwrm` network previously prepared by the `CreateRunOptions()` function
* `Qobs`: the observed variable time serie (e.g. the discharge expressed in *mm/time step*)
* `AprioriIds`: the list of the sub-catchments IDs where to apply a parameter regularisation based on the parameters of an upstream sub-catchment (e.g. here below the parameters of the sub-catchment "54057" is regulated by the parameters of the sub-catchment "54032")
* `transfo`: a transformation function applied on the flow before criterion calculation (square-root transformation is recommended for the De Lavenne regularisation)
```{r InputsCrit}
InputsCrit <- CreateInputsCrit(
InputsModel = InputsModel,
FUN_CRIT = airGR::ErrorCrit_KGE2,
RunOptions = RunOptions,
Obs = Qobs[IndPeriod_Run,]
Obs = Qobs[IndPeriod_Run,],
AprioriIds = c(
"54057" = "54032",
"54032" = "54001",
"54001" = "54095"
),
transfo = "sqrt"
)
str(InputsCrit)
```
......
......@@ -82,7 +82,9 @@ IM_OL <- CreateInputsModel(griwrmV03, DatesR, Precip, PotEvap, Qobs)
## Calibration of the new model
Calibration options and criteria procedures are detailed in vignette "V02_Calibration_SD_model". The following code chunk resumes this procedure:
Calibration options and criteria procedures are detailed in vignette "V02_Calibration_SD_model". We also apply a parameter regularisation here but only where an upstream simulated catchment is available.
The following code chunk resumes this procedure:
```{r}
IndPeriod_Run <- seq(
......@@ -95,7 +97,10 @@ RunOptions <- CreateRunOptions(IM_OL,
IndPeriod_Run = IndPeriod_Run)
InputsCrit <- CreateInputsCrit(IM_OL,
FUN_CRIT = airGR::ErrorCrit_KGE2,
RunOptions = RunOptions, Obs = Qobs[IndPeriod_Run,])
RunOptions = RunOptions, Obs = Qobs[IndPeriod_Run,],
AprioriIds = c("54057" = "54032", "54032" = "54001"),
transfo = "sqrt"
)
CalibOptions <- CreateCalibOptions(IM_OL)
```
......
This diff is collapsed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment