{{{ #!html

Development Activities

Documentation

Source Code

Reference Simulations

Group Activities

}}} = Documentation = ---- [[PageOutline]] == Scientific Documentation == All the scientific documentation is available on the [http://labex.ipsl.fr/orchidee/ ORCHIDEE website][[BR]] == Implementation of the code == '''Embedded documentation'''[[BR]] ORCHIDEE has a scientific documentation embedded into the code that generates html and pdf versions. See [wiki:Documentation/ORCHIDEE_DOC ORCHIDEE_DOC] page for knowing more. Below are listed the documentation of some versions of ORCHIDEE : * trunk ORCHIDEE, revision 2425: [http://dods.ipsl.jussieu.fr/orchidee/DOXYGEN/documentation_2425.pdf the pdf document], [http://dods.ipsl.jussieu.fr/orchidee/DOXYGEN/webdoc_2425 the web documentation] and [http://dods.ipsl.jussieu.fr/orchidee/DOXYGEN/documentation_reduced_2425.pdf a reduced version] of the pdf document. * trunk ORCHIDEE, revision 1240: [http://dods.ipsl.jussieu.fr/orchidee/DOXYGEN/documentation_1240.pdf the pdf document], [http://dods.ipsl.jussieu.fr/orchidee/DOXYGEN/webdoc_1240 the web documentation] and [http://dods.ipsl.jussieu.fr/orchidee/DOXYGEN/documentation_reduced_1240.pdf a reduced version] of the pdf document. * branches/ORCHIDEE_DOC, revision 808: [http://dods.ipsl.jussieu.fr/orchidee/DOXYGEN/documentation.pdf the pdf document], [http://dods.ipsl.jussieu.fr/orchidee/DOXYGEN/webdoc the web documentation] and [http://dods.ipsl.jussieu.fr/orchidee/DOXYGEN/documentation_reduced.pdf a reduced version] of the pdf document.[[BR]] '''Coding Guidelines''' A coding guidelines has been established to facilitate the developement of the ORCHIDEE code. All developers should follow such guide lines when improving or adding new features to the code. Moreover, any new suggestions to these coding guide lines, in order to improve the readability, the efficiency and the robustness of the code are welcome. You can make these suggestions to the ORCHIDEE project group. See [attachment:ORCHIDEE_Coding_Guidelines_v1.0(1).pdf​ coding_guidelines.pdf] and [attachment:ORCHIDEE_Coding_Guidelines_v1.0.doc coding_guidelines.doc] == User Guide == In the User Guide you'll find a '''How To''' documentation, the old Scripts page and Tools : Documentation/UserGuide See also documentation related to the ORCHIDEE '''Training course''' : GroupActivities/Training See the complete '''parameter list''' for ORCHIDEE with default values and help comments : Documentation/OrchideeParameters == Forcings == All the information on the forcing files available to run ORCHIDEE are here: Documentation/Forcings == Archive == Find here old presentations and documentations [wiki:Documentation/Archive]