Changes between Version 23 and Version 24 of Documentation/ORCHIDEE_DOC


Ignore:
Timestamp:
2012-02-17T16:37:11+01:00 (13 years ago)
Author:
maignan
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Documentation/ORCHIDEE_DOC

    v23 v24  
    2828 * A variable without units is labelled as (unitless)[[BR]] 
    2929 * If the range of the variable is know, this range is given i.e. (0-1, unitless)[[BR]] 
    30  * Units are written in latex and no fractions should be used i.e. {{{m s^{-1}}}} instead of {{{m/s}}}[[BR]] 
    31  * Units are contained within the following tags {{{@tex m s^{-1} @endtex}}}[[BR]] 
     30 * Units are written in latex and no fractions should be used i.e. {{{(m s^{-1})}}} instead of {{{(m/s)}}}[[BR]] 
     31 * Units are contained within the following tags {{{@tex ($m s^{-1}$) @endtex}}}[[BR]] 
    3232 * Flowcharts are made with dia and stored as *.dot[[BR]] 
    3333 * Each equation is saved as a separate file. The equation is written in latex contained between \begin{equation} and \end{equation}. This file is named of the subroutine/function it belongs to.[[BR]] 
    34  * Tier 2 extracts comments preceded by a number i.e. !! 1. Initialize variable and organizes these comments as a 'table of content'. Take this in mind when numbering sections of code and use short headers. More information can be given below the header.[[BR]] 
     34 * Tier 2 extracts comments preceded by a number i.e. !! 1. Initialize variable and organizes these comments as a 'table of content'. Take this in mind when numbering sections of code and use short headers. More information can be given below the header. 
     35 * For the declaration part, please use:  
     36    !! 0. Variables and parameter declaration[[BR]] 
     37    !! 0.1 Input variables[[BR]] 
     38    !! 0.2 Output variables[[BR]] 
     39    !! 0.3 Modified variables[[BR]] 
     40    !! 0.4 Local variables[[BR]] 
    3541[[BR]] 
    3642 * Tier 1 and tier 2 do not extract the comments below the section declaring the variables. Tier 3 should do so. In preparation of Tier 3, please duplicate the equations in the header description and the source code. Use !! for comments that should be extracted by tier 3, use ! for comments that help to understand the flow of the code but should be printed in the pdf and html.[[BR]]