{{{ #!html

Model developments

Documentation

Source Code

Reference Simulations

Group Activities & Contact

}}} = Documentation = [[PageOutline]] == Technical guide to use the model == * '''[wiki:Documentation/UserGuide]''': main user's guide for installing, running and working with the model ORCHIDEE. * See external documentation for running ORCHIDEE and other configurations with IPSL running environment "modipsl and libIGCM": https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/Doc * See also both '''scientific and technical''' documentation given during the different sessions of the ORCHIDEE '''Training course''' : GroupActivities/Training == Understanding the model == * Evolution of the functionality of ORCHIDEE: [wiki:Documentation/EvolutionOfFunctionality from Krinner et al 2005 to ORCHIDEE trunk4] * Description of the main functionality of [wiki:Documentation/TrunkFunctionality4 ORCHIDEE trunk] * List of parameters used in [http://forge.ipsl.jussieu.fr/orchidee/browser/trunk/ORCHIDEE/orchidee.default ORCHIDEE svn Milestone 4.0] * HYDROL : [http://forge.ipsl.jussieu.fr/orchidee/attachment/wiki/Documentation/eqs_hydrol_25April2018_Ducharne.pdf Technical note on hydrol.f90] (A. Ducharne, work in progress, updated on April 25, 2018) * The usage of frac_nobio in the code is documented here: [wiki:Documentation/Frac_Nobio] * Implicit coupling with LMDZ: [wiki:Documentation/LMDZ_coupling LMDZ-coupling] == Information about input and validation data == * Atmospheric forcing data sets: All the information on the forcing files available to run ORCHIDEE are here: Documentation/Forcings * Drivers: All the information on the drivers available to run ORCHIDEE are here: Documentation/Drivers * Ancillary data: All the information on the other input data files which are needed to describe the various surface characteristics used by ORCHIDEE are here: Documentation/Ancillary (needs to be updated for r6614) * Validation data: some information on the datasets available to evaluate ORCHIDEE are provided here wiki:Documentation/Validation/dataset and the summary of the meetings are here : Documentation/Validation == Archive == * Old presentations and documentation : [wiki:Documentation/Archive]. * [wiki:Documentation/OrchideeParameters List of parameters] used by the trunk before inclusion of nitrogen (before 3.0) * Physical range of the parameters: [https://docs.google.com/spreadsheets/d/1DYVvvqxVoXFAqA_M_hvkd-Ooru6ZQ32Lz2oa8oKKA5E/edit#gid=1984497631​ Parameters Range Table] (no information on the date of the document and the corresponding version of ORCHIDEE, but it is before 3.0) * An early version of ORCHIDEE (r2425) had its documentation embedded in the code. The software called DOXYGEN could extract this documentation to generate an html and pdf versions of the documentation. Although many remnants of this approach can still be found in the code, more recent documentation often no longer meets the requirements for DOXYGEN to work. New developments should still be properly documented following the [wiki:Documentation/ORCHIDEE_DOC documentation guidelines]. An example of the documentation generated by DOXYGEN for the trunk r2425 can be found at: * See [https://vesg.ipsl.upmc.fr/thredds/fileServer/IPSLFS/orchidee/DOXYGEN/webdoc_2425/annotated.html web-based scientific documentation for r2425 of the trunk]. * Download the pdf of the documentation for the same version and some older versions in complete or reduced form : [https://vesg.ipsl.upmc.fr/thredds/catalog/IPSLFS/orchidee/DOXYGEN/catalog.html].