Changes between Version 15 and Version 16 of Documentation/ORCHIDEE_DOC


Ignore:
Timestamp:
2011-12-04T21:12:32+01:00 (12 years ago)
Author:
maignan
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ORCHIDEE_DOC

    v15 v16  
    11= ORCHIDEE Documentation Work = 
    22[[BR]] 
    3 == AIM, PINCIPLES, EXAMPLES == 
     3== AIM, PRINCIPLES, EXAMPLES == 
    44== Background (2010) == 
    55The current documentation of ORCHIDEE is incomplete, inconsistent in its level of detail, tri-lingual, fragmented and has been published in black, grey and white literature. Although considerable work has been done in the past, it is difficult for the current users to benefit from this work. The current organisation of the documentation is unlikely to attract new ORCHIDEE users and it is unlikely to meet traceability standards required by modern science.[[BR]] 
     
    2020 1. Aims, concept and planning of the documentation effort and retreat [attachment:1-Retreat_intro_111201.ppt] 
    2121 1. Annotated example to help the responsibles in preparing documentation [attachment:2-ScientificDocumentation_111201_Part1.pdf], [attachment:2-ScientificDocumentation_111201_Part2.pdf] and * [attachment:2-ScientificDocumentation_111201_Part3.pdf] 
    22  1. Who does what? [attachment:4-Retreat_Workload_111201.doc] 
     22 1. Who does what? [attachment:4-Retreat_Workload_111202.doc] 
    2323 1. A protocol and two examples were prepared to guide the documentation effort. All can be downloaded below. Alternatively, the examples or can be retrieved from the documentation branch which is readable for everybody (and writable to the administrators). Use the source code from this branch (1.9.5.2) as your starting poit (to avoid documenting old code). 
    24  Protocol for documenting source code [attachment:3-Protocol_111201.doc] 
     24 Protocol for documenting source code [attachment:3-Protocol_111202.doc] 
    2525 Stomate_alloc.f90 [attachment:stomate_alloc.f90] 
    2626 Diffuco_trans_co2.f90