NEWS.md 34.3 KB
Newer Older
1
## Release History of the airGR Package
2
3
4



5

6

7
### 1.4.3.85 Release Notes (2020-04-15)
8
9

#### CRAN-compatibility updates
10

11
12
13
- The 'hydroPSO' package is back on CRAN and it is again suggested (cf. the 'param_optim' vignette).


14
15
16
17
18
#### Deprecated and defunct

- The deprecated <code>RunSnowModule</code> argument has been removed from the <code>CreateRunOptions()</code> function.


19
20
21
22
23
#### Major user-visible changes

- Added output to <code>RunModel_GR2M()</code> function (Ps).


24
25
26
27
#### Minor user-visible changes

- Character argument verification now use partial matching in <code>PE_Oudin()</code> and <code>SeriesAggreg()</code>  functions.

28
29
30
____________________________________________________________________________________


31
32
33
34
35
36
37
### 1.4.3.65 Release Notes (2020-02-28)

#### CRAN-compatibility updates

- The run period is reduced in the example of the <code>Imax()<code> function in order to run faster.

- The 'hydroPSO' package is no longer suggested (but the code linked to its use and is always present in the 'param_optim' vignette).
38
39
40
41
42
43
44

____________________________________________________________________________________


### 1.4.3.60 Release Notes (2020-01-29)

#### New features
45

46
- A digital object identifier (DOI) now allows to identify the manual of the 'airGR' package. When you use airGR in your work, please always cite both the article and the manual. The last one allows to know the version of the package that is used in order to enhance reproducible research. The references can be displayed with the <code>citation("airGR")</code> command.
47
48
49

#### Bug fixes

50
- Fixed bug in <code>Imax()</code>. The default value of the <code>TestedValues</code> argument was wrong due to a mistyped argument name in the <code>seq()</code> function.
51

52
53
54
55
____________________________________________________________________________________


### 1.4.3.52 Release Notes (2020-01-21)
56
57
58
59


#### New features

60
- <code>plot.Outputsmodel()</code> now allows to draw actual evapotranspiration when <code>which = "ActuEvap"</code> or <code>which = "All"</code> (overlaid to potential evapotranspiration if already drawn).
61
- Added <code>RunModel_GR5H()</code> and <code>RunModel_CemaNeigeGR5H()</code> functions to run the hourly model GR5H (with or without the CemaNeige module). These models present an optional additionnal interception store.
62
- Added <code>Imax()</code> which allows to estimate the maximum capacity of the GR5H interception store.
63
64
65
66


#### Bug fixes

67
- Fixed bug in <code>TransfoParam_GR1A()</code>. The number of model parameters was wrong (2 instead of 1) which caused an error during the GR1A model calibration.
68
- Fixed bug in <code>plot.OutputsModel()</code>. The function does not return any error message when <code>log_scale = TRUE</code>, <code>Qobs = NULL</code> and user want to draw flows time series.
69
70
- Fixed bug in <code>RunModel_&#42;GR&#42;()</code>. The functions do not return any error message anymore due to slightly negative values returned by GR4H, GR4J, GR5J or GR6J Fortran codes (the message was returned by <code>CreateIniStates()</code> when the final states were created). The <code>RunModel_&#42;GR&#42;()</code> functions now return zero instead of these slightly negative values, except for the ExpStore where negatives values are allowed.
- Fixed bug in the <code>.ErrorCrit()</code> function. The Box-Cox transformation formula is now corrected when the <code>ErrorCrit&#42;()</code> functions are used.
71

72

73
74
75
76
77
#### Major user-visible changes

- Added outputs to <code>RunModel_GR4H()</code> function (Pn, Ps, AExch1, AExch2).


78
79
#### Minor user-visible changes

80
- Added the diagram of GR2M in the <code>RunModel_GR2M()</code> documentation.
81
- Fortran codes cleant and translated from F77 to F90.
82

83
84
85

#### CRAN-compatibility updates

86
- Cleaning of the Fortran codes (comment formatting).
87
88
89
90

____________________________________________________________________________________


91
### 1.3.2.42 Release Notes (2019-09-20)
92

93

94
#### Version control and issue tracking
95

96
- Users can now track changes (<code>https://gitlab.irstea.fr/HYCAR-Hydro/airgr</code>) and issues (<code>https://gitlab.irstea.fr/HYCAR-Hydro/airgr/issues</code>).
97

98

99
100
#### Bug fixes

101
- Fixed bug in <code>RunModel_CemaNeige()</code>. The function now runs correctly when <code>IndPeriod_WarmUp = 0L</code> in <code>CreateRunOptions()</code> in order to completely disable the warm-up period (e.g. to perform a forecast form a given initial state).
102
- Fixed bug in <code>CreateIniStates()</code>. The function now returns the right number of end states when CemaNeige is used whithout hysteresis.
103
- Fixed bug in the <code>RunModel_CemaNeige&#42;()</code> functions. G and Gthr end states are no more inverted in the output values.
104
105
106
107


#### Minor user-visible changes

108
- Spurious flows set to <code>NA</code> into the <code>BasinObs</code> time series of the <code>L0123001</code> dataset.
109

110
111
112
____________________________________________________________________________________


113
### 1.3.2.23 Release Notes (2019-06-20)
114
115
116
117


#### New features

118
- <code>CreateInputsCrit()</code> now allows power (as a numeric or as a character) and the Box-Cox transformations in the <code>transfo</code> argument.
119

120
- Added <code>RunModel_CemaNeigeGR4H()</code> function to run the hourly model GR4H with the CemaNeige module.
121

122
123
- Added <code>PE_Oudin()</code> function to compute Oudin's potential evapotranspiration for hourly or daily time steps.

124
125
- <code>plot.OutputsModel()</code> now presents a <code>LayoutMat</code> argument (and additionnal related argument: <code>LayoutWidths</code>, <code>LayoutHeights</code>) to specify complex plot arrangements.

126
127
128
129

#### Deprecated and defunct

- The <code>PEdaily_Oudin()</code> function is deprecated and his use has been replaced by the use of <code>PE_Oudin()</code>.
130

131

132
133
134
135
#### Bug fixes

- Fixed bug in <code>plot.OutputsModel()</code>. The function now runs correctly when the <code>which</code> argument contains the <code>"CorQQ"</code> value without <code>"CumFreq"</code>.

136

137
138
#### Major user-visible changes

139
- <code>plot.OutputsModel()</code> can now draw PE or error time series if the <code>which</code> argument is set to <code>"all"</code> or <code>"PotEvap"</code> or <code>"Error"</code>.
140

141
- <code>plot.OutputsModel()</code> now allows new values for the which argument: <code>"all"</code> corresponds to all graphs, <code>"synth"</code> corresponds to the main graphs (default value; corresponding to <code>"all"</code> in the previous versions of the package) (i.e. <code>c("Precip", "Temp", "SnowPack", "Flows", "Regime", "CumFreq", "CorQQ")</code>), <code>"ts"</code> corresponds to the time series graphs (i.e. <code>c("Precip", "PotEvap", "Temp", "SnowPack", "Flows")</code>) and "perf" corresponds to the performance graphs (i.e. <code>c("Error", "Regime", "CumFreq", "CorQQ")</code>).
142

143

144
145
#### Minor user-visible changes

146
- <code>.ErrorCrit()</code> private function added to check inputs into <code>ErrorCrit_&#42;()</code> functions. The <code>ErrorCrit_&#42;()</code> functions were simplified accordingly.
147

148
149
- <code>CreateInputsCrit()</code> now returns <code>FUN_CRIT</code> as a character string.

150
151
- An example is addeed to illustred the use of the <code>plot.OutputsModel()</code> function.

152
____________________________________________________________________________________
153
154


155
### 1.2.13.16 Release Notes (2019-04-03)
Delaigue Olivier's avatar
Delaigue Olivier committed
156
157


158
#### New features
159

160
- <code>CreateInputsCrit()</code> now presents a <code>VarObs</code> argument in order to allow to prepare an <code>InputsCrit</code> object in order to run a criterion on other variables than observed discharges with the <code>ErrorCrit()</code> function (at the moment SCA and SWE).
Delaigue Olivier's avatar
Delaigue Olivier committed
161

162
- <code>CreateInputsCrit()</code> can now prepare an <code>InputsCrit</code> object in order to compute a single criterion (<code>Single</code> class), multiple criteria (<code>Multi</code> class) or a composite criterion (<code>Compo</code> class) with the <code>ErrorCrit()</code> function.
Delaigue Olivier's avatar
Delaigue Olivier committed
163

164
- <code>CreateInputsCrit()</code> now presents a <code>Weights</code> argument in order to allow to prepare an <code>InputsCrit</code> object in order to compute a composite criterion (<code>Compo</code> class) with <code>ErrorCrit()</code> or <code>Calibration_Michel()</code>.
Delaigue Olivier's avatar
Delaigue Olivier committed
165

166
167
- <code>CreateInputsCrit()</code> now returns a <code>idLayer</code> element to indicate which layer(s) to use for SCA or SWE aggregation.

168
- <code>CreateInputsCrit()</code> now presents a <code>warnings</code> argument to replace the verbose action (the <code>verbose</code> argument is kept to print messages).
Delaigue Olivier's avatar
Delaigue Olivier committed
169

170
- In <code>CreateInputsCrit()</code>, it is now possible to set the following arguments as atomic (as before) or as list: <code>FUN_CRIT</code>, <code>VarObs</code>, <code>Obs</code>, <code>BoolCrit</code>, <code>transfo</code>, <code>Weights</code>. If the list format is chosen, all the lists must have the same length.
171

172
- <code>CreateRunOptions()</code>, <code>CreateIniStates()</code> and <code>CreateCalibOptions()</code> now present a <code>IsHyst</code> argument to give the possibility to use the Linear Hysteresis with CemaNeige. The objects returned present an <code>hysteresis</code> class.
173

174
- <code>CreateRunOptions()</code> now presents a <code>warnings</code> argument to replace the verbose action (the <code>verbose</code> argument is kept to print messages).
175

176
- Added <code>TransfoParam_CemaNeigeHyst()</code> function in order to take into account transformation of the parameters of the CemaNeige module when the Linear Hysteresis is used.
177

178
- Added the <code>X0310010</code> dataset to run the examples using the Linear Hysteresis with CemaNeige (it contains necessary SCA data).
179

180
- Added the 'cemaneige_hysteresis' vignette to explain how to manage the use of the Linear Hysteresis with CemaNeige.
181

Delaigue Olivier's avatar
Delaigue Olivier committed
182

183
184
185
186
187
188
189
190
191
192
193
#### Deprecated and defunct

- The <code>Qobs</code> argument is now deprecated in <code>CreateInputsCrit()</code> and has been renamed <code>Obs</code>.

- The <code>FUN_CRIT</code> argument is now deprecated in <code>ErrorCrit()</code>. This function now gets this information from the <code>InputsCrit</code> argument.

- The <code>FUN_CRIT</code> argument is now deprecated in <code>Calibration_Michel()</code>. This function now gets this information from the <code>InputsCrit</code> argument.

- The <code>plot_OutputsModel()</code> had been deprecated in airGR 1.0.4 (it had been replaced by the use of <code>plot.OutputsModel()</code> or <code>plot()</code>) and is defunct now. 


Delaigue Olivier's avatar
Delaigue Olivier committed
194
195
#### Major user-visible changes

196
197
- <code>CreateInputsCrit()</code> now return a list of <code>InputsCrit</code> (each element is of the <code>Single</code> class) in the cases of multiple or a composite criteria.

198
- <code>ErrorCrit_&#42;()</code> functions now return an error message if the <code>InputsCrit</code> object is of class <code>Multi</code> or <code>Compo</code>.
Delaigue Olivier's avatar
Delaigue Olivier committed
199

200
- <code>ErrorCrit()</code> function can now run on a multiple or a composite <code>InputsCrit</code>. In these cases, it returns a list of <code>ErrorCrit</code>.
201

202
- <code>ErrorCrit()</code> and <code>ErrorCrit_&#42;()</code> functions can now assess Q, SCA or SWE simulations.
Delaigue Olivier's avatar
Delaigue Olivier committed
203

204
- <code>Calibration_Michel()</code> function can now run on a composite <code>InputsCrit</code>. It returns a composite value of error and the formula used to calculate it.
Delaigue Olivier's avatar
Delaigue Olivier committed
205

206
207
- Model diagrams added in documentations of <code>RunModel_GR4J()</code>, <code>RunModel_GR5J()</code> and <code>RunModel_GR6J()</code> functions.

208
- It is now possible to be redirected to the <code>plot.OutputsModel()</code> documentation with <code>?plot</code>.
209

210
- It is now possible to use a character vector for all <code>FUN_&#42;</code> arguments (in addition to function objects) in the following functions: <code>Calibration()</code>, <code>Calibration_Michel()</code>, <code>CreateCalibOptions()</code>, <code>CreateIniStates()</code>, <code>CreateIniStates()</code>, <code>CreateInputsCrit()</code>, <code>CreateInputsModel()</code>, <code>CreateRunOptions()</code>, <code>ErrorCrit()</code>, <code>RunModel()</code> and <code>TransfoParam()</code>.
211

Delaigue Olivier's avatar
Delaigue Olivier committed
212
213
214
215

#### Minor user-visible changes

- <code>ErrorCrit_&#42;()</code> functions now return objects of class <code>ErrorCrit</code> and <code>NSE</code>, <code>KGE</code>, <code>KGE2</code> or <code>RMSE</code>.
216
217
218

- <code>.FortranOutputs()</code> private function added to manage Fortran outputs.

219
- Outputs of <code>frun_GR2M</code> Fortran subroutine were reordered.
Delaigue Olivier's avatar
Delaigue Olivier committed
220

221
222
- <code>DataAltiExtrapolation_Valery()</code> now returns named elements of lists relative to elevation layer.

223
- <code>Calibration()</code> function now returns an error message if <code>FUN_CALIB</code> is not a function.
224

225
- Inputs of <code>PEdaily_Oudin()</code> are now checked.
226

227
228
229
- <code>PEdaily_Oudin()</code> example corrected (the Julian day was one day too early).

- <code>plot.OutputsModel()</code> does not return a warning message anymore when <code>Qobs = NULL</code>.
230

231
232
- Inputs of <code>TransfoParam&#42;()</code> functions are now checked.

233
234
- The order of authors has been updated in the DESCRIPTION and the CITATION files.

235
236
237

#### CRAN-compatibility updates

238
- Tabulations removed, unused variables removed and variable statements fixed in Fortran files.
239

240
241
242
____________________________________________________________________________________


243
### 1.0.15.2 Release Notes (2018-10-10)
244
245
246
247
248
249


#### Bug fixes

- Fixed bug in <code>CreateRunOptions()</code>. The function now accounts correctly for leap years when no warm-up period is defined.

250

251
252
253
254
#### Minor user-visible changes

- <code>CreateRunOptions()</code> was cleant, with no effect on its outputs.

Delaigue Olivier's avatar
Delaigue Olivier committed
255
256
257

#### CRAN-compatibility updates

258
- The <code>vignetteParam&#42;.rda</code> datasets moved to the inst directory. It contains different objects needed for 'param_optim' and 'param_mcmc' vignettes.
Delaigue Olivier's avatar
Delaigue Olivier committed
259

260
261
____________________________________________________________________________________

262

263
### 1.0.14.1 Release Notes (2018-09-28)
264
265


266
267
268
269
270
271
#### New features

- <code>PEdaily_Oudin()</code> now presents a <code>LatUnit</code> argument which allows to choose the unit of the latitude (radians and degrees).



272
#### Deprecated and defunct
273
274
275

- The <code>LatRad</code> argument is now deprecated in <code>PEdaily_Oudin()</code> and replaced by the <code>Lat</code> argument.

276
277
- The unused <code>Ind_zeroes</code> argument of the <code>CreateInputsCrit()</code> function is now deprecated.

278

279
280
281

#### Major user-visible changes

282
283
- <code>Calibration_Michel()</code> is now faster during the grid-screening step when a parameter is set using <code>FixedParam</code> in <code>CreateCalibOptions()</code>.

284
- <code>CreateCalibOptions()</code> now returns an error when all the parameters are set in the <code>FixedParam</code> argument and a warning message when all the parameters are free (NA) in the <code>FixedParam</code> argument.
285

286
- <code>CreateInputsCrit()</code> now returns an error when <code>epsilon</code> is not positive.
287

288
- <code>CreateInputsCrit()</code> now returns a warning message in the following case: there are zeroes values in <code>Qobs</code>, <code>epsilon = NULL</code> and <code>transfo = log</code> or <code>inv</code>.
289

Delaigue Olivier's avatar
Delaigue Olivier committed
290
- <code>ErrorCrit_&#42;()</code> functions now return a warning message in the following case: there are zeroes values in <code>Qobs</code> or <code>Qsim</code>, <code>epsilon = NULL</code> and <code>transfo = log</code> or <code>inv</code>.
291

292
293
294

#### Minor user-visible changes

295
296
- Several functions of the package were cleant or slightly modified, with no effect on their outputs.

297
- Dubious Qls and Qmm values set to NA values between 1997-01-05 and 1997-01-21 in the L0123001 dataset.
298

299
- ORCID numbers are now joined to the names of the authors of the package.
300
301
302
303
304
305


#### CRAN-compatibility updates

- Function name changed in a vignettes to avoid error during the check on Debian distribution

306
307
- As recomanded by CRAN managers, the NEWS file is now at the text format and is no more just a link to the airGR Website

308
309
- Added the <code>Vignette_Param.</code> datasets in order to reduce runtime during the re-building of vignettes. It contains different objects needed for param_optim and param_mcmc vignettes.

310
311
312
____________________________________________________________________________________


313
### 1.0.10.11 Release Notes (2018-06-29)
314
315


316
317
#### Bug fixes

318
- Fixed bug in <code>RunModel_GR2M()</code>. The function now returns the total precipitation (P) instead of the net rainfall (P1).
319
320
321
322


#### Major user-visible changes

323
- <code>RunModel_GR2M()</code> now returns more explicit precipitation outputs names.
324

325
- <code>CreateInputsCrit()</code> now returns a warning message when the KGE (or KGE') is used with a log transformation on flows.
326
327
328
329
330
331
332
333

- The article reference is corrected.


#### Minor user-visible changes

- The documentation and help of several functions were improved.

334
335
336
____________________________________________________________________________________


337
### 1.0.9.64 Release Notes (2017-11-10)
338

339

340
341
#### New features

342
- An article describing the 'airGR' package has been published. Its reference has been added and will be displayed with <code>citation("airGR")</code>. 
343

344
- Added <code>CreateIniStates()</code> function in order to help user to format the <code>IniStates</code> argument for <code>CreateRunOptions()</code>.
345

346
- Added the <code>Param_Sets_GR4J</code> dataset. It contains generalist parameter sets for the GR4J model.
347

348
- Three vignettes have been added. They are relative to different calibration methods (including the generalist parameters sets of the GR4J model).
349

350

351
352
353
354
355
#### Deprecated and defunct

- The <code>RunSnowModule</code> argument is now deprecated in <code>CreateRunOptions()</code>.


356
357
#### Bug fixes

358
- Fixed bug in <code>RunModel_GR4H()</code>: in <code>frun_GR4H</code> Fortran subroutine, <code>St(2)</code> is now set to 0 (instead of <code>St(1)</code>) when <code>St(2) < 0</code>. 
359
360
361
362
363

- Fixed bug in <code>plot.OutputsModel()</code> for the regime plot when the period is less than 1 year.

- Fixed bug in <code>plot.OutputsModel()</code> when there is no common data to plot the cumulative frequency or the correlation QQ.

364
- Fixed bug in <code>plot.OutputsModel()</code> for the y-axis labelling of flows time series when <code>log_scale = TRUE</code> and <code>BasinArea</code> is used.
365
366
367
368


#### Major user-visible changes

unknown's avatar
unknown committed
369
- <code>RunModel_GR4J()</code>, <code>RunModel_GR5J()</code> and <code>RunModel_GR6J()</code> (and <code>CemaNeige_GR&#42;J()</code>) now return Ps, Pn and actual exchanges. See the model Fortran codes for more details about the calculation of these variables.
370
371
372

- <code>CreateInputsModel()</code> now returns an error when <code>DatesR</code> contains duplicated values.

unknown's avatar
unknown committed
373
- <code>RunModel_GR5J</code> now returns <code>StateEnd</code> in the same order as the other models.
374
375
376
377
378
379


#### Minor user-visible changes

- <code>plot.OutputsModel()</code> now returns a warning message when the length of Qobs is different from the length of Qsim. 

380
- The X1 parameter from GR4H, GR4J, GR2M, GR5J and GR6J, the X3 parameter from GR4H, GR4J, GR5J and GR6J and the X6 parameter from GR6J are now set to 1e-2 when they are fixed to lower values. <code>RunModel_&#42;()</code> functions now return a warning message in this case. <code>RunModel_&#42;()</code> functions now return a warning when X4 < 0.5 and its value is set to 0.5.
381
382
383
384
385
386
387
388

- The commands <code>?L0123001</code>, <code>?L0123002</code> and <code>?L0123003</code> now return the documentation page related to <code>BasinObs</code>.

- Many functions of the package were cleant or slightly modified, with no effect on their outputs. 

- The documentation and help of several functions were improved.


389
#### CRAN-compatibility updates
390
391
392
393
394
395

- "airGR.c" file registers native routines.

____________________________________________________________________________________


396
### 1.0.5.12 Release Notes (2017-01-23)
397
398
399
400


#### New features

401
- <code>DataAltiExtrapolation_Valery()</code> and <code>CreateInputsModel()</code> now present a <code>PrecipScale</code> argument which allows rescaling precipitation when it is interpolated on the elevation layers when CemaNeige is used.
402
403
404
405
406
407
408
409
410
411
412
413
414
415


#### Bug fixes

- Fixed bug in <code>DataAltiExtrapolation_Valery()</code>. The elevation gradients for air temperature returned by <code>CreateInputsModel()</code> are improved.


#### User-visible changes

- <code>DataAltiExtrapolation_Valery()</code> has been improved. <code>DataAltiExtrapolation_Valery()</code> now runs faster (and by consequence <code>CreateInputsModel()</code> too, when CemaNeige is used).

____________________________________________________________________________________


416
### 1.0.4 Release Notes (2017-01-18)
417

418

419
420
421
422
423
#### New features

- <code>RunModel_CemaNeige()</code>, <code>RunModel_CemaNeigeGR4J()</code>, <code>RunModel_CemaNeigeGR5J()</code> and <code>RunModel_CemaNeigeGR6J()</code> now return air temperature for each elevation layer. 


424
#### Deprecated and defunct
425
426
427
428
429
430
431
432
433
434
435
436
437

- S3 plot method defined for <code>OutputsModel</code> objects. It means that the <code>plot_OutputsModel()</code> function is deprecated and his use has been replaced by the use of <code>plot.OutputsModel()</code> or <code>plot()</code>.

- In <code>plot.OutputsModel()</code> the <code>PlotChoice</code> argument is deprecated and has been renamed <code>which</code>.


#### User-visible changes

- <code>plot.OutputsModel()</code> displays air temperature time series for each layer when <code>CemaNeige</code> is used (argument <code>which = "Temp"</code> or <code>"all"</code>).

____________________________________________________________________________________


438
### 1.0.3 Release Notes (2016-12-09)
439

440

441
442
#### New features

Delaigue Olivier's avatar
Delaigue Olivier committed
443
- <code>ErrorCrit_&#42;()</code> functions gain a <code>warnings</code> argument to replace the verbose action and the <code>verbose</code> argument now prints the criterion value(s).
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460


#### Bug fixes

- Fixed bug in <code>CreateCalibOptions()</code> when <code>StartParamList</code> or <code>StartParamDistrib</code> arguments are used.


#### User-visible changes

- <code>CreateInputsModel()</code> now returns an error if <code>NLayers <= 0</code> when <code>CemaNeige</code> is used.

- <code>plot_OutputsModel()</code> now displays raw values on the y-axis when the discharge time series is represented with log scale (formerly, log values of discharges were displayed on the y-axis).


____________________________________________________________________________________


461
### 1.0.2 Release Notes (2016-11-03)
462
463
464
465
466


#### New features

- <code>SeriesAggreg()</code> gains a TimeLag argument that corresponds to a numeric value indicating a time lag (in seconds) for the time series aggregation (useful to aggregate hourly time series to the daily time step for instance).
467
 In addition, the function now accepts input dates in both <code>POSIXt</code> formats (<code>POSIXct</code> and <code>POSIXlt</code>). The output is in <code>POSIXct</code> format.
468
 
469
470
- <code>plot_OutputsModel()</code> gains a <code>log_scale</code> argument in order to plot the flow with a log scale.

471
- A tutorial is available online on the following link: https://hydrogr.github.io/airGR/.
472
 It can also be displayed with the <code>vignette("airGR")</code> command.
473
 
474

475
#### Deprecated and defunct
476
477
478
479
480

- <code>CreateCalibOptions()</code> loses the OptimParam argument that was redundant with the <code>FixedParam</code> argument. The <code>Calibration_Michel()</code> was modified to take into account this change by using directly <code>FixedParam</code>, but this is transparent to the user. 

- <code>CreateCalibOptions()</code> loses the StartParam argument that was not used. 

481
482
483
484
485

#### Bug fixes

- The value <code>sort</code> for the <code>transfo</code> argument of <code>CreateInputsCrit()</code> was not taken into account. It is now fixed. 

486
 
487
488
489
#### Major user-visible changes

- The <code>RunModel_GR6J()</code> and <code>RunModel_CemaNeigeGR6J()</code> models were modified back to versions previous to 1.0.1 to prevent from unwanted efficiency criteria deterioration related to the calibration with <code>Calibration_Michel()</code>. 
490
491
492
 The actual model codes were not modified but the <code>TransfoParam_GR6J()</code> and <code>CreateCalibOptions()</code> functions were modified regarding the X5 parameter. 
 It is strongly advised to use airGR 1.0.2 for the <code>RunModel_GR6J()</code> and <code>RunModel_CemaNeigeGR6J()</code> functions if you are using <code>Calibration_Michel()</code>, as they are much more efficient. 
 In case you were using your own calibration algorithm, you will not notice any difference. 
493
494
495
496


#### Minor user-visible changes

497
- <code>CreateInputsModel()</code> and <code>DataAltiExtrapolation_Valery()</code> functions now allow both <code>POSIXt</code> formats (<code>POSIXct</code> and <code>POSIXlt</code>).
498
499
500
501
502


____________________________________________________________________________________


503
### 1.0.1 Release Notes (2016-04-21)
504

505

506
#### Deprecated and defunct
507
508
509
510
511

- The <code>Calibration_HBAN()</code> and <code>DataAltiExtrapolation_HBAN()</code> functions have respectively been renamed as <code>Calibration_Michel()</code> and <code>DataAltiExtrapolation_Valery()</code> after the names of their creators.

- The <code>Calibration_optim()</code> function has been removed from the package.

512
- The silent mode is now defined by the <code>verbose = TRUE</code> argument (formerly <code>quiet = FALSE</code>) in the following functions:
513
514
515
516
517
<code>Calibration()</code>, <code>Calibration_Michel()</code>, <code>CreateInputsModel()</code>, <code>CreateRunOptions()</code>, <code>DataAltiExtrapolation_Valery()</code>, <code>ErrorCrit()</code>, <code>ErrorCrit_KGE()</code>, <code>ErrorCrit_KGE2()</code>, <code>ErrorCrit_NSE()</code>, <code>ErrorCrit_RMSE()</code>, <code>plot_OutputsModel()</code>, <code>SeriesAggreg()</code>.


#### Major user-visible changes
- The GR5J model has been modified: previously, two unit hydrographs were used, now only one is remaining.
518
 As a consequence, simulations from the GR5J (<code>RunModel_GR5J()</code> function) and CemaNeige (<code>RunModel_CemaNeigeGR5J()</code> function) models will be different.
519

520
- An important proportion of the transformations of the parameters have been modified (<code>TransfoParam_&#42;()</code> functions). Since this modifies the local search, calibration results will be different .
521
522
523
524
525
526

- The quantiles of the parameters have been recalculated with the new transformations (<code>CreateCalibOptions()</code> function). Since these quantiles constitute the starting point of the calibration algorithm, calibration results will be different.


#### Minor user-visible changes

527
- The Fortran model core codes have been modified:
528
529
530
531
532
533
534
535
536
537
	- optimisation of the codes for fastening of computation;
	- simplification of the internal variables for easier reading and understanding.
	
- The list of the contributors and authors is now full.

- The references of the package has been updated; they are returned by the following R-command <code>citation("airGR")</code>.

____________________________________________________________________________________


538
### 0.8.1.2 Release Notes (2015-08-21)
539

540

541
542
#### Bug fixes

543
- Fixed bug in <code>CreateInputsModel()</code> that was related to the handling of missing values.
544

545
- Fixed bug in <code>CreateRunOptions()</code> that prevented the correct use of the <code>IniResLevels</code> argument (to manually set the filling rate of the production and routing stores).
546
547
548
549
550
551
552


#### Minor user-visible changes

- Removal of an unnecessary warning when <code>IndPeriod_WarmUp = 0</code>.


553
#### CRAN-compatibility updates
554
555
556
557
558
559
560

- Modification of namespace file to ensure proper use under linux whithout compilation issues.


____________________________________________________________________________________


561
### 0.8.0.2 Release Notes (2015-04-15)
562
563
564
565


#### New features

566
- Three new hydrological models: <code>RunModel_GR4H() function for </code> GR4H (hourly), <code>RunModel_GR2M()</code> function for GR2M (monthly) and <code>RunModel_GR1A()</code> function for GR1A (yearly).
567
568
569
570
571
572
573
574
575
576
577
578
579

- New function <code>SeriesAggreg()</code> to easily aggreg timesteps.


#### Bug fixes

- Fixed bug in <code>ErrorCrit_RMSE()</code> which led to incorrect calibration (the criterion was maximised instead of minimised).


#### Major user-visible changes

- Update of the functions <code>CreateRunOptions()</code>, <code>CreateCalibOptions()</code> and <code>plot_OutputsModel()</code> to handle the new models.

580
- Modification of CemaNeige Fortran code to add an update of Gratio after the SnowPack update (no impact on snow simulation).
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596


#### Minor user-visible changes

- Improvement of the <code>plot_OutputsModel()</code> function to allow a selection among available plots.

- Minor update in <code>ErrorCrit_KGE()</code> and <code>ErrorCrit_KGE2()</code> to handle case when only one values in not NA.

- Update of the scripts in airGR-advanced-example to match the structures of the <code>BasinData</code> objects.

- Correction of formatting issue in airGR-advanced-example regarding the "List_HypsoData.txt" file.


____________________________________________________________________________________


597
### 0.7.4 Release Notes (2014-11-01)
598
599
600
601
602
603
604


#### New features

- New argument in many functions (<code>quiet = TRUE</code> or <code>FALSE</code>) to choose if the warnings should be suppressed or not.


605
#### Deprecated and defunct
606

607
- The <code>CalibrationAlgo_&#42;()</code> functions were renamed into <code>Calibration_&#42;()</code>.
608
609


610
#### Bug fixes
611

612
- Fixed bug in <code>CreateCalibOptions()</code> to handle models with only one parameter.
613

614
- Fixed bug in <code>Calibration_HBAN()</code>. The function was not working properly with models having only one parameter.
615
616
617
618


#### Major user-visible changes

619
620
621
622
623
- CemaNeige users must now specify one <code>MeanAnSolidPrecip</code> for each elevation layer. The <code>CreateRunOptions()</code> function is impacted.

- CemaNeige users can now specify the mean elevation of the input series (before it was always considered equal to the catchment median elevation). 
 The impacted functions are <code>CreateInputsModel()</code> and <code>DataAltiExtrapolation_HBAN()</code>.
 
624
625
626
- New architecture with better format verification procedure (using classes) and simpler setting of default configuration.

- New architecture where the model, calibration and error functions are in the arguments of the functions
627
 (the exotic use of "generic function" created by the users has been removed).
628

629
- Improved documentation and examples. 
630
631


632
#### Minor user-visible changes
633

634
- Improvements allowing the arrival of new models.
635

636
- Improvements of the argument verifications in <code>CreateInputsModel()</code>, <code>CreateRunOptions()</code>, <code>CreateInputsCrit()</code>, <code>CreateCalibOptions()</code>.
637

638
- Improvements of all the <code>ErrorCrit()</code> functions to better account for the cases with constant flow values or local zeros.
639

640
641
642
- Improvement of the <code>plot_OutputsModel</code> function (to handle 0 in Qobs and Qsim).

- Improved documentation.
643
644
645
646
647


____________________________________________________________________________________


648
### 0.6.2 Release Notes (2014-02-12)
649

650
651
652
653
654

#### New features

- Additional functions for results plotting (the <code>{zoo}</code> package is required for some of them).

655
- Add multi-objective calibration using <code>nsga2()</code> (the 'mco' package is required).
656
657
658
659
660

- The field Multiplier has been added in the ErrorCrit() outputs, to indicate whether the criterion is an error (to minimise) or and efficiency (to maximise).
 This allows to provide real efficiency values in the outputs e.g. NSE[Q] instead of (-1) &times; NSE[Q].


661
662
663
664
665
#### Deprecated and defunct

- <code>EfficiencyCrit()</code> have been replaced by <code>ErrorCrit()</code> to avoid misunderstanding (by default, the algorithms minimise the error criterion).


666
667
668
669
670
671
672
673
#### Bug fixes

- RC11 bug correction: the automatic selection of the warm-up period was not working properly when no data was available from warm-up (i.e. when the user had set the run to start at the very first index).

- RC10 bug correction: the <code>CalibrationAlgo_HBAN()</code> function was not working in the very rare case when the diagonal search was activated and lead to a set outside the authorised range.

- RC9 bug correction: the <code>CalibrationAlgo_HBAN()</code> function was not working properly with models having only one parameter.

674
- RC8 bug correction of the <code>ModelDefaultIniOptions()</code> function (this bug was introduced in the RC7 and caused an error when <code>IndPeriod_WarmUp = NULL</code>.
675
676
677
678
679
680

- RC7 bug correction of the <code>ModelDefaultIniOptions()</code> function (the automatic selection of one year for warm-up was not handling properly missing data).

- RC6 correction of the help files (the description of CemaNeige parameters were inverted).

- RC5 differs from previous releases in the way the data are read and stored (in a list instead of individual vectors).
681
682
 The package is similar, only the examples of Main and the files in MyScriptBlocks have changed.
 All basin data are now stored inside a list named <code>BasinData</code>. This will greatly ease the future use of Rdata files (instead of txt files) as storage format for the time series of observation. 
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701


#### Major user-visible changes

- The definition of the generic function is now made in a much simpler way (e.g. see <code>DefineFunctions_Model()</code> or <code>DefineFunctions_ErrorCrit()</code>).


#### Minor user-visible changes

- Code improvements to reduce the computation time.

- Clearer instructions for the adding and modification of a model.

- Improvements of the documentation.


____________________________________________________________________________________


702
### 0.5.2 Release Notes (2014-02-05)
703
704


705
#### Deprecated and defunct
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726

- The <code>SelectPer</code> arguments are replaced by <code>IndPeriod</code> to ease understanding.

- The <code>PE</code> arguments are replaced by <code>PotEvap()</code> to ease understanding.

- The <code>Fsol</code> arguments are replaced by <code>FracSolidPrecip</code> to ease understanding.


#### Major user-visible changes

- R 2.15 in not supported by default.

- The check that <code>SelectPer_Run()</code> is continuous is now made in the <code>CheckArg()</code> functions.

- Check of the model functioning time step.

- Name of the calibration criterion provided in <code>OutputsAlgo()</code>.


#### Minor user-visible changes

727
- Missing values in Fortran are now -999.999 instead of -9.999.
728
729
730
731
732


____________________________________________________________________________________


733
### 0.5.1 Release Notes (2014-01-27)
734
735
736
737


#### New features

738
- New <code>EfficiencyCrit_NSE_sqrtQ()</code> function to compute NSE criterion on sqrt flows.
739
740
741
742
743
744
745
746
747
748
749


#### Bug fixes

- Incorrect arguments in the call to <code>RunModelAndCrit</code> from <code>CalibrationAlgo_optim_stats</code> and <code>CalibrationAlgo_nlminb_stats</code>.

- <code>CalibrationAlgo_nlminb_stats</code> argument was wrongly defined in <code>DefineFunctions_CalibrationAlgo()</code> (<code>optim</code> instead of <code>nlminb</code>).

- Format checking for <code>RunOptions</code> was incorrectly made in <code>CheckArg()</code> function.