Changes between Version 17 and Version 18 of Documentation/UserGuide/IDB

Timestamp:

2020-03-19T17:20:18+01:00 (4 years ago)

Author:

luyssaert

Comment:

--

Documentation/UserGuide/IDB

@@ -1 @@
-Contributed by Pierre Brender
-
-[[PageOutline]] 
-
-= IDB =
-
-== For which purpose a debugging tool may be of some use ? ==
-
-In the present page, we will try to present tools which help to identify what are the values taken by some variables at some point, check that a subroutine of interest is actually called during the execution of the code (and how many times it happens),... This might be very useful when one would like to speed up the identification of the variable which is the first to take weird values (particularly after a significant modification of the code) and the snap of code which cause that trouble. 
-
+[[PageOutline]]
+= Debugging with IDB =  
+
+== Objective ==
+Background of this item: when the model does not run as expected, the calculations will need to be checked step by step. Debuggers such as IDB help to identify what are the values taken by some variables at some point, check that a subroutine of interest is actually called during the execution of the code (and how many times it happens),... This might be very useful when one would like to speed up the identification of the variable which is the first to take weird values (particularly after a significant modification of the code) and the snap of code which cause that trouble. An basic alternative to the use of debuggers is added WRITE statements to the code.
+
+== IDB on obelix == 
+Authors: P. Brender [[BR]] 
+Last revision: J. Ghattas (2019/05/02) [[BR]]
+
+=== Boundary conditions for using a debugger ===
 Of course, getting a functional version of the code after a modification of one of the routine of ORCHIDEE continues to require a few steps and the debugger we present only helps to speed up the second one :
    1. Getting a version of the code which can be compiled. The first errors displayed by the compiler before crashing should be of some help to solve that issue.
-   1. Once the code including the modification can be compiled properly, it may often happen that some of the variables take aberrant values, even for runs in offline mode on one point. You are likely to be interested by this tutorial if you are used to proceed to tedious cycles of :
+   2. Once the code including the modification can be compiled properly, it may often happen that some of the variables take aberrant values, even for runs in offline mode on one point. You are likely to be interested by this tutorial if you are used to proceed to tedious cycles of :
       * addition within the subroutine of interest of lines such as "PRINT *, 'MY_VAR='my_var 
       * compilation of the code
       * screening of the standard output of the executed code  
-   1. Check that the introduction of the new feature doesn't lead to weird behaviour for runs at the global scales and/or coupled with the GCM.
-
-
-== Step by step manual ==
+   3. Check that the introduction of the new feature doesn't lead to weird behaviour for runs at the global scales and/or coupled with the GCM.
+
+
+=== Step by step manual ===
 === Activate the debug flags when compiling the orchidee_ol executable ===