Changes between Version 14 and Version 15 of Documentation/UserGuide/restartability

Timestamp:

2020-02-28T15:52:42+01:00 (4 years ago)

Author:

lathiere

Comment:

--

Documentation/UserGuide/restartability

@@ -4 +4 @@
 Last revision: 2020/02/28, J. Lathière
 
-In some rare cases after bugfixes or implementation of new code, problems with reproducibility or 1+1=2 might be introduced unintentionally. Often these are related to incorrect variable dimensions in different sub-routines, memory issues or the lack of variables in the restart files. Such issues are easier to catch sooner than later. Thus, to minimize the time spent on debugging reproducibility and 1+1=2 issues, '''the following simple test are suggested/required before each commit of substantial code changes''':
+In some rare cases after bugfixes or implementation of new code, problems with reproducibility or 1+1=2 might be introduced unintentionally. Often these are related to incorrect variable dimensions in different sub-routines, memory issues or the lack of variables in the restart files. Such issues are easier to catch sooner than later. Thus, to minimize the time spent on debugging reproducibility and 1+1=2 issues, '''the following simple tests are suggested/required before each commit of substantial code changes''':
  
 === 1+1=2 ===
-'''If you do not run these test globally''', make sure to use impose_veg=y.
-The standard F2 run.def settings have been tested and 1+1=2 from revision r6272. Thus, please '''always make the test for the standard settings'''. In case of other run.def settings during your developments, '''make same tests for your settings also'''. More recent tests have shown that 1+1=2 for LCC with r6279 at the global scale. 
+'''If you do not run these tests globally''', make sure to use impose_veg=y.
+The standard F2 run.def settings have been tested and 1+1=2 from revision r6272. Thus, please '''always make the tests for the standard settings'''. In case of other run.def settings during your developments, '''make same tests for your settings also'''. More recent tests have shown that 1+1=2 for LCC with r6279 at the global scale. 
 
-=== The standard test ===
+=== The standard tests ===
 
 1) 1Y vs. 12*1M, i.e. do two simulations for a full year: one with period length of 1 year; the other with period length of 1 month. Afterwards compare their final restart files both from stomate and sechiba.
@@ -43 +43 @@
 - True - write all occurrences of differences in a variable (specifically gives all the indices) to the file: all_diff.txt. 
 
-- False - only write, if there is differences in a variable, its first occurrence of such differences to the file: first_diff.txt. 
+- False - only write, if there is differences in a variable, the first occurrences of such differences to the file: first_diff.txt. 
 
 For global simulation, the True option can produce a large file and the information might be hard to process, if there are many differences between the compared restart files. In addition, the True option makes the script much slower. However, for small simulation the True option is very useful.