[MITgcm-devel] manual chapter 3

[chris hill]

Hi All,

  A quick bit of info thats is vaguely relevant

  Any symbol that appears in a namelist is under

  Browse Code
   --> Parameters

  http://mitgcm.org/r2_web_testing/latest/code_reference/parameters.html

  see - for example the alphabetic table at

http://mitgcm.org/r2_web_testing/latest/code_reference/vdb/parmdict.htm

   if (and I know its a big if!) we actually used the MITgcm structured 
description comment in the descriptions of those symbols the 
"description" column would be filled in for all of them too!

Chris

Andrea Molod wrote:
> hi there,
> 
> after talking a little with jean-michel, i would like to propose
> the following little changes to chapter 3 (in addition to the ones
> that are on the 'to do' list checked in to the manual directory):
> 
> add a section that will be section 3.7 (before the section that
> is called 'Doing it yourself: customizing the code') called:
> 
> Doing it yourself: customizing MITgcm configuration
> 
> and add in there, at a minimum, a list of the defaults in the
> data namelists. the list of data namelist parameters along with
> a brief description of what the parameter does is printed out
> in the config summary that is in the model standard out.
> 
> i guess it is my sense (maybe not correct?) that this is what
> many users do with MITgcm, at least in the beginning. and this
> is what they would look for instructions on how to do.
> 
> if people agree, i will change the text accordingly. in addition,
> to get the list jean-michel has agreed to run a little test experiment 
> with an almost empty data file. ed, can you take the config summary from 
> standard out and grep and cut and all that to make something
> that we can put into the document with verbatim? this would include
> a complete list of what's in the cofig summary, the description and
> the default values. for the arrays in there, i guess it makes sense
> to leave out the default values (ie, dX).
> 
> something like this, ie, a list of what is in the namelist and what
> are the default values, would be great to have for the package
> namelists, too. i will start this (by grepping the package.readparams
> fortran code) for the packages i know.
> 
> comments? thoughts?
> 
> andrea
> 
> _______________________________________________
> MITgcm-devel mailing list
> MITgcm-devel at mitgcm.org
> http://mitgcm.org/mailman/listinfo/mitgcm-devel
>