Changes between Version 26 and Version 27 of Documentation/UserGuide/CheckList


Ignore:
Timestamp:
2020-06-01T14:28:28+02:00 (4 years ago)
Author:
aducharne
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Documentation/UserGuide/CheckList

    v26 v27  
    5252 
    5353NOTE:  not all of these components can be activated at the same time and still give reliable results. Besides, somes options depend on some others. It's important to test the configuration you select. 
     54 
     55''' 2c) If you changed the code ''' 
     56 
     57Your developments must comply to [wiki:Documentation/UserGuide/CodingGuidelines ORCHIDEE's coding guidelines]. 
     58 
     59Your are advised to test your code as much as possible before running large simulations: 
     60- compile and run over a couple days in [wiki:Documentation/UserGuide/flags debug mode] (for long simulations over large domains, debug mode in not advised as it make the execution much slower) 
     61- if your model crashes, turn to the [wiki:Documentation/UserGuide#Debuggingandprofiling Debug section] of the documentation 
     62If your model runs, check it runs correctly: 
     63- conservation, restartability (1+1=2) 
     64- verify that your results make sense compared to the revision you based your developments on 
    5465 
    5566== 3) Installation and compilation 
    … …  
    118129ORCHIDEE output is controlled by separate modules, referred to as XIOS ([[https://forge.ipsl.jussieu.fr/orchidee/wiki/DevelopmentActivities/ORCHIDEE-CNP here] PDF] and [https://forge.ipsl.jussieu.fr/orchidee/wiki/Documentation/UserGuide/XIOSinConfig webpage]) and IOIPSL.  These modules greatly improve reading and writing data for large simulations, although the benefits may not be seen for single pixel, single CPU runs. 
    119130 
    120 If you want to change the variables that are output by your simulation, read the dedicated section "History/output files". 
     131If you want to change the variables that are output by your simulation, read the dedicated section [wiki:Documentation/UserGuide#Historyoutputfiles History/output files]. 
    121132 
    122133== 5) Run your simulation 
    123 libIGCM is the environment that makes it easier to run simulations: gathering the required input files, copying them to the run directory, running the simulation, and then storing the output, in particular for multiple year simulations where you would otherwise have to manually copy restart files and name them appropriately.  The libIGCM section on the [https://forge.ipsl.jussieu.fr/orchidee/wiki/Documentation/UserGuide HowTo] has additional information about manipulating libIGCM in special cases. 
     134libIGCM is the environment that makes it easier to run simulations: gathering the required input files, copying them to the run directory, running the simulation, and then storing the output, in particular for multiple year simulations where you would otherwise have to manually copy restart files and name them appropriately.  The [wiki:Documentation/UserGuide#DifferentwaystoconfiguresimulationswithlibIGCM libIGCM section] of the HowTo has additional information about manipulating libIGCM in special cases. 
    124135 
    125136It is possible to run [https://forge.ipsl.jussieu.fr/orchidee/wiki/Documentation/UserGuide/TestCase1 simple offline test cases] and [https://forge.ipsl.jussieu.fr/orchidee/wiki/Documentation/UserGuide/TestCaseBatch larger parallel jobs] without libIGCM.  This can be useful when you are debugging your code.   
    … …  
    129140 
    130141If your simulation crashes : 
    131 - guidelines to understand the problem [https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/Doc/CheckDebug] 
    132 - if debugging is required, look at the the Debugging section on the [https://forge.ipsl.jussieu.fr/orchidee/wiki/Documentation/UserGuide HowTo], starting with the [wiki:Documentation/UserGuide/flags introductory page on debug flags].  
     142- guidelines to understand the logs produced by libIGCM  [https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/Doc/CheckDebug] 
     143- if debugging is required, look at the [wiki:Documentation/UserGuide#Debuggingandprofiling Debugging section] on the [https://forge.ipsl.jussieu.fr/orchidee/wiki/Documentation/UserGuide HowTo], starting with the [wiki:Documentation/UserGuide/flags introductory page on debug flags].  
     144- the [https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/Doc/Setup#config.card TEST and DEVT options in config.card] can be useful as they keep more log files accessible 
    133145 
    134146== 6) How to get some help 
    135147 
    136 Step 1: Documentation and howto pages, training sessions, ... 
     1486a) Look at the documentation and howto pages, training sessions, ... 
    137149 
    138 Step 2: Ask your supervisor or close collaborators 
     1506b) Ask your supervisor or close collaborators 
    139151 
    140 Step 3: Email to orchidee-help at listes.ipsl.fr 
     1526c) Email to orchidee-help at listes.ipsl.fr 
    141153 
    142154== 7) Analyse your results 
    … …  
    153165- Presentation of your results (share your report or paper, invite the group to your seminar/defense, present a talk an ORCHIDEE weekly of DEV meeting) 
    154166- [wiki:Documentation/UserGuide/CommitOnTrunk Backup your development via svn] on a [wiki:Documentation/UserGuide/svnBranchePerso branch or perso directory] 
    155 - For inclusion in the trunk, this has to be proposed to the ORCHIDEE-Project group 
     167- For inclusion in the trunk, this has to be proposed to the ORCHIDEE-Project group, and a specific trusting protocol will be implemented 
    156168 
    157169