NEWS.md 36.2 KB
Newer Older
1
## Release History of the airGR Package
2

3
4


5
6


7
### 1.4.8.5 Release Notes (2020-05-04)
8
9
10

#### New features

11
12
- Added <code>SeriesAggreg2</code> method.
- Added <code>SeriesAggreg2.default()</code> function.
13
- Added <code>SeriesAggreg2.InputsModel()</code> function.
14
- Added <code>SeriesAggreg2.OutputsModel()</code> function.
15
- Added <code>SeriesAggreg2.data.frame()</code> function. This new verson of the <code>SeriesAggreg()</code> function allows to compute regimes.
16
- Added<code>.AggregConvertFun()</code> private function in order to choose automatically the <code>ConvertFun</code> to apply on each element of <code>InputsModel</code> and <code>OutputsModel</code> ojects.
17

18

19
20
21
22
23
#### Deprecated and defunct

- The deprecated <code>RunSnowModule</code> argument has been removed from the <code>CreateRunOptions()</code> function. ([#23](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/23))


24
25
26
27
28
#### Bug fixes

- Fixed bug in <code>RunModel_GR1A()</code>. Reversed PotEvap and Precip outputs are now reordered (in the previous versions PotEvap contained the precipitation values and Precip contained the evapotranspiration values, the Qsim values were already correct).


29
#### Major user-visible changes
30

31
- Added output to <code>RunModel_GR2M()</code> function (Ps). ([#51](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/51))
32

33
- <code>PE_Oudin()</code> can now run for several locations (i.e. several latitudes) in the Fortran mode (<code>RunFortran = TRUE</code>). In this case <code>Lat</code> must be of the same length as <code>Temp</code>. ([#62](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/62))
34

35
- <code>RunModel()</code> now allows to run semi-distributed GR models. ([#34](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/34))
36

37

38
#### Bug fixes
39

40
- <code>TimeLag</code> of the <code>SeriesAggreg2()</code> function now runs when <code>TimeLag >= 3600</code>.
41

Dorchies David's avatar
Fix #53    
Dorchies David committed
42

43
#### Minor user-visible changes
Dorchies David's avatar
Fix #53    
Dorchies David committed
44

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

47
48

#### CRAN-compatibility updates
49

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

52
53
54
____________________________________________________________________________________


55
56
57
58
### 1.4.3.65 Release Notes (2020-02-28)

#### CRAN-compatibility updates

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

- The 'hydroPSO' package is no longer suggested (but the code linked to its use and is always present in the 'param_optim' vignette).
62
63
64
65
66
67
68

____________________________________________________________________________________


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

#### New features
69

70
- 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.
71
72
73

#### Bug fixes

74
- 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.
75

76
77
78
79
____________________________________________________________________________________


### 1.4.3.52 Release Notes (2020-01-21)
80
81
82
83


#### New features

84
- <code>plot.Outputsmodel()</code> now allows to draw actual evapotranspiration when <code>which = "ActEvap"</code> or <code>which = "All"</code> (overlaid to potential evapotranspiration if already drawn). ([#2](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/2))
85

86
- 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. ([#13](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/13))
87

88
- Added <code>Imax()</code> which allows to estimate the maximum capacity of the GR5H interception store. ([#13](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/13))
89
90
91
92


#### Bug fixes

93
- 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. ([#1](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/1))
94

95
- 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.
96

97
- 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.
98

99
- 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.
100

101

102
103
104
105
106
#### Major user-visible changes

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


107
108
#### Minor user-visible changes

109
- Added the diagram of GR2M in the <code>RunModel_GR2M()</code> documentation.
110
111

- Fortran codes cleant and translated from F77 to F90. ([#18](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/18))
112

113
114
115

#### CRAN-compatibility updates

116
- Cleaning of the Fortran codes (comment formatting).
117
118
119
120

____________________________________________________________________________________


121
### 1.3.2.42 Release Notes (2019-09-20)
122

123

124
#### Version control and issue tracking
125

126
- 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>).
127

128

129
130
#### Bug fixes

131
- 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).
132

133
- Fixed bug in <code>CreateIniStates()</code>. The function now returns the right number of end states when CemaNeige is used whithout hysteresis.
134

135
- Fixed bug in the <code>RunModel_CemaNeige&#42;()</code> functions. G and Gthr end states are no more inverted in the output values.
136
137
138
139


#### Minor user-visible changes

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

142
143
144
____________________________________________________________________________________


145
### 1.3.2.23 Release Notes (2019-06-20)
146
147
148
149


#### New features

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

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

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

156
157
- <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.

158
159
160
161

#### 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>.
162

163

164
165
166
167
#### 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>.

168

169
170
#### Major user-visible changes

171
- <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>.
172

173
- <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>).
174

175

176
177
#### Minor user-visible changes

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

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

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

184
____________________________________________________________________________________
185
186


187
### 1.2.13.16 Release Notes (2019-04-03)
Delaigue Olivier's avatar
Delaigue Olivier committed
188
189


190
#### New features
191

192
- <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
193

194
- <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
195

196
- <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
197

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

200
- <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
201

202
- 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.
203

204
- <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.
205

206
- <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).
207

208
- 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.
209

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

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

Delaigue Olivier's avatar
Delaigue Olivier committed
214

215
216
217
218
219
220
221
222
#### 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.

Dorchies David's avatar
Fix #53    
Dorchies David committed
223
- 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.
224
225


Delaigue Olivier's avatar
Delaigue Olivier committed
226
227
#### Major user-visible changes

228
229
- <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.

230
- <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
231

232
- <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>.
233

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

236
- <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
237

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

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

242
- 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>.
243

Delaigue Olivier's avatar
Delaigue Olivier committed
244
245
246
247

#### 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>.
248
249
250

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

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

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

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

257
- Inputs of <code>PEdaily_Oudin()</code> are now checked.
258

259
260
261
- <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>.
262

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

265
266
- The order of authors has been updated in the DESCRIPTION and the CITATION files.

267
268
269

#### CRAN-compatibility updates

270
- Tabulations removed, unused variables removed and variable statements fixed in Fortran files.
271

272
273
274
____________________________________________________________________________________


275
### 1.0.15.2 Release Notes (2018-10-10)
276
277
278
279
280
281


#### Bug fixes

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

282

283
284
285
286
#### Minor user-visible changes

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

Delaigue Olivier's avatar
Delaigue Olivier committed
287
288
289

#### CRAN-compatibility updates

290
- 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
291

292
293
____________________________________________________________________________________

294

295
### 1.0.14.1 Release Notes (2018-09-28)
296
297


298
299
300
301
302
#### 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).


303
#### Deprecated and defunct
304
305
306

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

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

309

310
311
#### Major user-visible changes

312
313
- <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>.

314
- <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.
315

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

318
- <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>.
319

Delaigue Olivier's avatar
Delaigue Olivier committed
320
- <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>.
321

322
323
324

#### Minor user-visible changes

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

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

329
- ORCID numbers are now joined to the names of the authors of the package.
330
331
332
333
334
335


#### CRAN-compatibility updates

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

336
337
- 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

338
339
- 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.

340
341
342
____________________________________________________________________________________


343
### 1.0.10.11 Release Notes (2018-06-29)
344
345


346
347
#### Bug fixes

348
- Fixed bug in <code>RunModel_GR2M()</code>. The function now returns the total precipitation (P) instead of the net rainfall (P1).
349
350
351
352


#### Major user-visible changes

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

355
- <code>CreateInputsCrit()</code> now returns a warning message when the KGE (or KGE') is used with a log transformation on flows.
356
357
358
359
360
361
362
363

- The article reference is corrected.


#### Minor user-visible changes

- The documentation and help of several functions were improved.

364
365
366
____________________________________________________________________________________


367
### 1.0.9.64 Release Notes (2017-11-10)
368

369

370
371
#### New features

Dorchies David's avatar
Fix #53    
Dorchies David committed
372
- An article describing the 'airGR' package has been published. Its reference has been added and will be displayed with <code>citation("airGR")</code>.
373

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

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

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

380

381
382
383
384
385
#### Deprecated and defunct

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


386
387
#### Bug fixes

Dorchies David's avatar
Fix #53    
Dorchies David committed
388
- 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>.
389
390
391
392
393

- 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.

394
- 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.
395
396
397
398


#### Major user-visible changes

unknown's avatar
unknown committed
399
- <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.
400
401
402

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

unknown's avatar
unknown committed
403
- <code>RunModel_GR5J</code> now returns <code>StateEnd</code> in the same order as the other models.
404
405
406
407


#### Minor user-visible changes

Dorchies David's avatar
Fix #53    
Dorchies David committed
408
- <code>plot.OutputsModel()</code> now returns a warning message when the length of Qobs is different from the length of Qsim.
409

410
- 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.
411
412
413

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

Dorchies David's avatar
Fix #53    
Dorchies David committed
414
- Many functions of the package were cleant or slightly modified, with no effect on their outputs.
415
416
417
418

- The documentation and help of several functions were improved.


419
#### CRAN-compatibility updates
420
421
422
423
424
425

- "airGR.c" file registers native routines.

____________________________________________________________________________________


426
### 1.0.5.12 Release Notes (2017-01-23)
427
428
429
430


#### New features

431
- <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.
432
433
434
435
436
437
438
439
440
441
442
443
444
445


#### 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).

____________________________________________________________________________________


446
### 1.0.4 Release Notes (2017-01-18)
447

448

449
450
#### New features

Dorchies David's avatar
Fix #53    
Dorchies David committed
451
- <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.
452
453


454
#### Deprecated and defunct
455
456
457
458
459
460
461
462
463
464
465
466
467

- 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>).

____________________________________________________________________________________


468
### 1.0.3 Release Notes (2016-12-09)
469

470

471
472
#### New features

Delaigue Olivier's avatar
Delaigue Olivier committed
473
- <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).
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490


#### 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).


____________________________________________________________________________________


491
### 1.0.2 Release Notes (2016-11-03)
492
493
494
495
496


#### 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).
497
 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.
Dorchies David's avatar
Fix #53    
Dorchies David committed
498

499
500
- <code>plot_OutputsModel()</code> gains a <code>log_scale</code> argument in order to plot the flow with a log scale.

501
- A tutorial is available online on the following link: https://hydrogr.github.io/airGR/.
502
 It can also be displayed with the <code>vignette("airGR")</code> command.
Dorchies David's avatar
Fix #53    
Dorchies David committed
503

504

505
#### Deprecated and defunct
506

Dorchies David's avatar
Fix #53    
Dorchies David committed
507
- <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.
508

Dorchies David's avatar
Fix #53    
Dorchies David committed
509
- <code>CreateCalibOptions()</code> loses the StartParam argument that was not used.
510

511
512
513

#### Bug fixes

Dorchies David's avatar
Fix #53    
Dorchies David committed
514
515
- The value <code>sort</code> for the <code>transfo</code> argument of <code>CreateInputsCrit()</code> was not taken into account. It is now fixed.

516

517
518
#### Major user-visible changes

Dorchies David's avatar
Fix #53    
Dorchies David committed
519
520
521
522
- 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>.
 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.
523
524
525
526


#### Minor user-visible changes

527
- <code>CreateInputsModel()</code> and <code>DataAltiExtrapolation_Valery()</code> functions now allow both <code>POSIXt</code> formats (<code>POSIXct</code> and <code>POSIXlt</code>).
528
529
530
531
532


____________________________________________________________________________________


533
### 1.0.1 Release Notes (2016-04-21)
534

535

536
#### Deprecated and defunct
537
538
539
540
541

- 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.

542
- The silent mode is now defined by the <code>verbose = TRUE</code> argument (formerly <code>quiet = FALSE</code>) in the following functions:
543
544
545
546
547
<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.
548
 As a consequence, simulations from the GR5J (<code>RunModel_GR5J()</code> function) and CemaNeige (<code>RunModel_CemaNeigeGR5J()</code> function) models will be different.
549

550
- 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 .
551
552
553
554
555
556

- 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

557
- The Fortran model core codes have been modified:
558
559
	- optimisation of the codes for fastening of computation;
	- simplification of the internal variables for easier reading and understanding.
Dorchies David's avatar
Fix #53    
Dorchies David committed
560

561
562
563
564
565
566
567
- 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>.

____________________________________________________________________________________


568
### 0.8.1.2 Release Notes (2015-08-21)
569

570

571
572
#### Bug fixes

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

575
- 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).
576
577
578
579
580
581
582


#### Minor user-visible changes

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


583
#### CRAN-compatibility updates
584
585
586
587
588
589
590

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


____________________________________________________________________________________


591
### 0.8.0.2 Release Notes (2015-04-15)
592
593
594
595


#### New features

596
- 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).
597
598
599
600
601
602
603
604
605
606
607
608
609

- 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.

610
- Modification of CemaNeige Fortran code to add an update of Gratio after the SnowPack update (no impact on snow simulation).
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626


#### 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.


____________________________________________________________________________________


627
### 0.7.4 Release Notes (2014-11-01)
628
629
630
631
632
633
634


#### 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.


635
#### Deprecated and defunct
636

637
- The <code>CalibrationAlgo_&#42;()</code> functions were renamed into <code>Calibration_&#42;()</code>.
638
639


640
#### Bug fixes
641

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

644
- Fixed bug in <code>Calibration_HBAN()</code>. The function was not working properly with models having only one parameter.
645
646
647
648


#### Major user-visible changes

649
650
- CemaNeige users must now specify one <code>MeanAnSolidPrecip</code> for each elevation layer. The <code>CreateRunOptions()</code> function is impacted.

Dorchies David's avatar
Fix #53    
Dorchies David committed
651
- CemaNeige users can now specify the mean elevation of the input series (before it was always considered equal to the catchment median elevation).
652
 The impacted functions are <code>CreateInputsModel()</code> and <code>DataAltiExtrapolation_HBAN()</code>.
Dorchies David's avatar
Fix #53    
Dorchies David committed
653

654
655
656
- 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
657
 (the exotic use of "generic function" created by the users has been removed).
658

Dorchies David's avatar
Fix #53    
Dorchies David committed
659
- Improved documentation and examples.
660
661


662
#### Minor user-visible changes
663

664
- Improvements allowing the arrival of new models.
665

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

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

670
671
672
- Improvement of the <code>plot_OutputsModel</code> function (to handle 0 in Qobs and Qsim).

- Improved documentation.
673
674
675
676
677


____________________________________________________________________________________


678
### 0.6.2 Release Notes (2014-02-12)
679

680
681
682
683
684

#### New features

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

685
- Add multi-objective calibration using <code>nsga2()</code> (the 'mco' package is required).
686
687
688
689
690

- 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].


691
692
693
694
695
#### Deprecated and defunct

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


696
697
698
699
700
701
702
703
#### 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.

704
- 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>.
705
706
707
708
709
710

- 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).
711
 The package is similar, only the examples of Main and the files in MyScriptBlocks have changed.
Dorchies David's avatar
Fix #53    
Dorchies David committed
712
 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.
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731


#### 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.


____________________________________________________________________________________


732
### 0.5.2 Release Notes (2014-02-05)
733
734


735
#### Deprecated and defunct
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756

- 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

757
- Missing values in Fortran are now -999.999 instead of -9.999.
758
759
760
761
762


____________________________________________________________________________________


763
### 0.5.1 Release Notes (2014-01-27)
764
765
766
767


#### New features

768
- New <code>EfficiencyCrit_NSE_sqrtQ()</code> function to compute NSE criterion on sqrt flows.
769
770
771
772
773
774
775
776
777
778
779


#### 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.