search

ESCOMP / CTSM

Community Terrestrial Systems Model (includes the Community Land Model of CESM)
http://www.cesm.ucar.edu/models/cesm2.0/land/
Other
308 stars 311 forks source link

Incorporate documentation of namelist variables in our sphinx-based documentation #1061

Open billsacks opened 4 years ago

billsacks commented 4 years ago

Currently, we rely on http://www.cesm.ucar.edu/models/cesm2/settings/current/clm5_0_nml.html for documentation of our namelist variables. However, this is tied to CESM releases, so is out-of-date with respect to the available options in the latest version of CTSM.

We should consider incorporating documentation of these namelist variables in our sphinx-based documentation, or coming up with some other mechanism to keep a version of this documentation up-to-date with master as well as other supported versions of CTSM.

(This issue occurred to me while documenting CTSM-LILAC: I started to point to the above page, but then realized that it isn't completely accurate.)

ekluzek commented 4 years ago

The is a style sheet so that you can look at the namelist_definitition and namelist_defaults files directly. So you can for example pull up those files in a browser and it will display the contents sensibly. I used to use this a lot, but haven't recently. So it's possible the style sheet might need to be updated (if it's useful).

We should be able to pull some of the scripting that creates the CESM namelist file into our document build so that we have the same kind of view in our documentation as well. That would take some work to figure out though.