Difference between revisions of "LMDZ.GENERIC directory layout and contents"

Latest revision as of 13:55, 27 May 2023

This page describes the directory structure of the Generic physics package and its main contents

The LMDZ.GENERIC directory

Once download from the svn server, the LMDZ.GENERIC directory contents should be something like:

deftank                               Making_New_Corrk_Directories.pdf
DOC                                   ManualGCM_GENERIC.pdf
How_to_add_an_aerosol_to_the_GCM.pdf  patch_large_domains
libf                                  README
Licence_CeCILL_V2-en.txt              utilities
Licence_CeCILL_V2-fr.txt

Where the noteworthy elements are:

• the ManualGCM_GENERIC.pdf, How_to_add_an_aerosol_to_the_GCM.pdf and Making_New_Corrk_Directories.pdf pdf documents containing some information on the model and how to use it (somewhat obsolete, should be superseded by this MediaWiki site)
• the DOC directory contains LaTeX files and figures used to generate ManualGCM_GENERIC.pdf
• the README file which contains dated brief comments about changes in the code
• the libf directory which contains the Fortran source code (see dedicated section below)
• the utilities directory which contains some post-processing tools (see dedicated section below).
• the deftank directory which contains examples of model input files (see dedicated section below).

The libf subdirectory

The libf directory contains tree subdirectories

aeronostd  dynphy_lonlat  phystd

• The main physics package code is in phystd, with aeronomy routines in the companion aeronostd directory
• the dynphy_lonlat directory merely contains a phystd subdirectory (this structure follows what is done in LMDZ.COMMON to ease physics-dynamics interface management). It is in the dynphy_lonlat/phystd directory that utilities main programs newstart and start2archive are located, along with physics-dynamics interface routines.

The deftank subdirectory

TODO... DESCRIBE CONTENTS AND SUBDIRS AND CROSS REFERENCE TO APPROPRIATE PAGES

The utilities subdirectory

TODO...DESCRIBE UTILITIES + README there