Changes between Version 65 and Version 66 of Documentation


Ignore:
Timestamp:
2015-05-05T15:28:10+02:00 (9 years ago)
Author:
nvuilsce
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Documentation

    v65 v66  
    1 ||'''[wiki:Documentation Documentation]'''||[wiki:trunk Main Version]||[wiki:Tags Tag Versions]||[wiki:Branches Other Versions]||[wiki:Scripts Scripts]||[wiki:Forcings Forcings]||[wiki:Simulations Simulations]||[wiki:Evaluation Evaluation]||[wiki:Tools Tools]||[wiki:HowTo How to]||[wiki:Training Training course]||[wiki:Meetings Meetings]||[wiki:Seminars Seminars]||[wiki:UserList UserList]||[wiki:Contact Contact]|| 
     1{{{ 
     2#!html 
     3<center> 
     4<table style="width:80%; border=1; background-color: #B9B9B9; text-align: left"> 
     5  <tr> 
     6    <td> <a href=https://forge.ipsl.jussieu.fr/orchidee/wiki/DevelopmentActivities> 
     7         <h1 style="text-align: right; color: #C30000"> 
     8         Development Activities</h1></a></td> 
     9 
     10   <td> <a href=https://forge.ipsl.jussieu.fr/orchidee/wiki/Documentation> 
     11         <h1 style="text-align: right; color: #C30000"> 
     12         Documentation </h1></a></td> 
     13 
     14   <td> <a href=https://forge.ipsl.jussieu.fr/orchidee/wiki/SourceCode> 
     15         <h1 style="text-align: right; color: #C30000"> 
     16         Source Code </h1></a></td> 
     17 
     18   <td> <a href=https://forge.ipsl.jussieu.fr/orchidee/wiki/ReferenceSimulations> 
     19         <h1 style="text-align: right; color: #C30000"> 
     20         Reference Simulations </h1></a></td> 
     21 
     22   <td> <a href=https://forge.ipsl.jussieu.fr/orchidee/wiki/GroupActivities> 
     23         <h1 style="text-align: right; color: #C30000"> 
     24         Group Activities </h1></a></td> 
     25 
     26 </tr> 
     27</table> 
     28</center> 
     29}}} 
    230 
    331 
    4 = Documentation =  
     32= Documentation = 
    533 
    6 You will find here information on the code itself, dealing with either scientific or technical aspects. More information on how to use the model can be find on the [wiki:Scripts] page and [wiki:HowTo].  
     34---- 
    735 
    8 == Coding Guidelines == 
     36[[PageOutline]]  
    937 
    10 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. 
    11 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. 
    12 See [attachment:ORCHIDEE_Coding_Guidelines_v1.0.pdf​ coding_guidelines.pdf] and [attachment:ORCHIDEE_Coding_Guidelines_v1.0.doc coding_guidelines.doc] 
     38== Scientific Documentation == 
    1339 
     40All the scientific documentation is available on the [http://labex.ipsl.fr/orchidee/ ORCHIDEE website][[BR]] 
    1441 
    15 == Scientific documentation == 
     42== Implementation of the code == 
     43 
    1644'''Embedded documentation'''[[BR]] 
    1745 
    … …  
    2250 
    2351 
     52'''Coding Guidelines''' 
    2453 
    25 '''Specific topics'''[[BR]] 
     54A 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. 
     55Moreover, 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. 
     56See [attachment:ORCHIDEE_Coding_Guidelines_v1.0(1).pdf​ coding_guidelines.pdf] and [attachment:ORCHIDEE_Coding_Guidelines_v1.0.doc coding_guidelines.doc] 
    2657 
    27  * CMIP5 [wiki:Documentation/MetaforOrc METAFOR] questionary.  
    28  * [wiki:Documentation/OrchideeParameters Parameters]: list of the parameters used by the model 
    29  * Physical range of the parameters: [https://docs.google.com/spreadsheets/d/1DYVvvqxVoXFAqA_M_hvkd-Ooru6ZQ32Lz2oa8oKKA5E/edit?usp=sharing Parameters Range Table]  
     58== User Guide == 
     59In the User Guide you'll find a '''How To''' documentation, the old Scripts page and Tools : Documentation/UserGuide 
    3060 
    31 == Technical Reports == 
    32  * 2103/12 B. Guenet [http:"//forge.ipsl.jussieu.fr/orchidee/attachment/wiki/Documentation/REPORT ON THE ROLE OF LITTER IN THE WATER FLUXES.pdf" "REPORT ON THE ROLE OF LITTER IN THE WATER FLUXES.pdf"] 
    33  * 2014/10 A. Ducharne [http:"//forge.ipsl.jussieu.fr/orchidee/attachment/wiki/Documentation/eqs_hydrol.pdf" "Technical note on hydrol.f90 (in progress)"] 
    34  * 2014/10 F. Wang: Notes on the coupling with LMDz [wiki:Documentation/CouplingLMDZ CouplingLMDZ]  
     61See also documentation related to the ORCHIDEE Training course : GroupActivites/Training 
     62== Forcings == 
    3563 
    36 == Tutorial Course ==  
    37 See the program and download all presentations and exercices since the last training course: [wiki:Training] 
     64All the information on the forcing files available to run ORCHIDEE are here: Documentation/Forcings 
    3865 
    39 Find here an complementary introduction to ORCHIDEE explained by a user, Amélie Rajaud spring 2013 [attachment:ORCHIDEE_SIMULATIONS_for_dummies_Rajaud_2013.pdf]. Note that some of the links have changed since this presentation was written. 
    40  
    41  
    42 == Phd thesis == 
    43  * Isabelle Gouttevin, '''Representing high latitudes in a land surface model : soil freezing and model performances''', 2012. Download the manuscript [http://dods.ipsl.jussieu.fr/orchidee/WIKI/PHD_THESIS/Manuscript_IG_print_depot.pdf here (in french)] and the presentation [http://dods.ipsl.jussieu.fr/orchidee/WIKI/PHD_THESIS/Soutenance_IG_EN_send.pdf here (in english)] 
    44  
    45 == Reference paper == 
    46  * Ducoudré, Nathalie I., Laval, Katia, et Perrier, Alain (1993). '''SECHIBA, a New Set of Parameterizations of the Hydrologic Exchanges at the Land-Atmosphere Interface within the LMD Atmospheric General Circulation Model.''' Journal of Climate, 6(2), 248--273.[http://journals.ametsoc.org/doi/abs/10.1175/1520-0442%281993%29006%3C0248%3ASANSOP%3E2.0.CO%3B2 link] 
    47  * Polcher, J., Laval, K., Dümenil, L., Lean, J., et Rowntree, P. R. (1996). '''Comparing three land surface schemes used in general circulation models.''' Journal of Hydrology, 180(1-4), 373--394. [http://www.sciencedirect.com/science/article/pii/0022169495028862  link] 
    48  * Ducharne, A., Laval, K., et Polcher, J. (1998). '''Sensitivity of the hydrological cycle to the parametrization of soil hydrology in a GCM.''' Climate Dynamics, 14, 307--327. [http://www.springerlink.com/content/6kcrkqp1vdeu2lm9/ link] 
    49  * Rosnay, P. de et Polcher, J. (1999). '''Modelling root water uptake in a complex land surface scheme coupled to a GCM.''' Hydrol. Earth Syst. Sci., 2(2/3), 239--255. [http://www.hydrol-earth-syst-sci.net/2/239/1998/hess-2-239-1998.html link] 
    50  * Krinner, G., Viovy, N., Noblet-Ducoudre, N. de, Ogee, J., Polcher, J., Friedlingstein, P., Ciais, P., Sitch, S., and Prentice, I. C (2005). '''A dynamic global vegetation model for studies of the coupled atmosphere-biosphere system.''' Global Biogeochem. Cycles, 19, GB1015. [http://europa.agu.org/?view=article&uri=/journals/gb/gb0501/2003GB002199/2003GB002199.xml&t=2005,krinner link] 
    51  * d'Orgeval, T. et Polcher, J. (2008). '''Impacts of precipitation events and land-use changes on West African river discharges during the years 1951--2000.''' Climate Dynamics, 31(2), 249--262. [http://www.springerlink.com/content/k221658437u00qj8/ link] 
    52  * Guimberteau M., Laval K., Perrier A. and Polcher J.: '''Global effect of irrigation and its impact on the onset of the Indian summer monsoon''', Climate Dynamics, in press (Available online 5 Dec. 2011), doi:10.1007/s00382-011-1252-5 [http://www.springerlink.com/content/w7748168783p7r69/ link] 
    53  * Guimberteau, M., Drapeau, G., Ronchail, J., Sultan, B., Polcher, J., Martinez, J.-M., Prigent, C., Guyot, J.-L., Cochonneau, G., Espinoza, J. C., Filizola, N., Fraizy, P., Lavado, W., De Oliveira, E., Pombosa, R., Noriega, L., and Vauchel, P. (2012): '''Discharge simulation in the sub-basins of the Amazon using ORCHIDEE forced by new datasets''', Hydrol. Earth Syst. Sci., 16, 911-935, doi:10.5194/hess-16-911-2012, 2012 [http://www.hydrol-earth-syst-sci.net/16/911/2012/hess-16-911-2012.html link] 
    54  * Guimberteau M., Perrier A., Laval K. and Polcher J. (2012): '''A comprehensive approach to analyze discrepancies between land surface models and in-situ measurements: a case study over the US and Illinois with SECHIBA forced by NLDAS''', Hydrol. Earth Syst. Sci., 16, 3973-3988, doi:10.5194/hess-16-3973-2012, 2012 [http://www.hydrol-earth-syst-sci.net/16/3973/2012/hess-16-3973-2012.html link] 
    55  
    56  
    57 == Other Presentations == 
    58  * Parallelism : To know about how ORCHIDEE is parallelized, look at the following page : [wiki:ParallelVersion]. 
    59  * Technical notes from G. Krinner that give the main equations of STOMATE and LPJ components. [http://www.ipsl.jussieu.fr/~ssipsl/doc/note.technique_krinner99.ps note.technique_krinner99.ps][[BR]] 
    60  * Presentation that gives the structure in which ORCHIDEE was coded (2000). [http://dods.ipsl.jussieu.fr/orchidee/WEBORCHIDEE/orchidee.pdf orchidee.pdf] 
    61  * Manuals : Written by Fabienne Maignan and Martial Mancip in 2008. 
    62    * [http://dods.ipsl.jussieu.fr/orchidee/WIKI/USERS_MANUAL/ICD_080416.doc Interface Control Document][[BR]] 
    63    * [http://dods.ipsl.jussieu.fr/orchidee/WIKI/USERS_MANUAL/DD_080414.doc  Design Document][[BR]] 
    64    * [http://dods.ipsl.jussieu.fr/orchidee/WIKI/USERS_MANUAL/UM_080417.doc User Manual] (Some parts of the user manual need to be updated.) 
    65  
    66  
    67  
    68 == [https://forge.ipsl.jussieu.fr/orchidee/wiki/Archives_before_2010 Archives before 2010] == 
    69  
    70  
     66== Archive == 
     67Find here old presentations and documentations [wiki:Documentation/Archive]