Erik Kluzek
NCAR
Mar-31-2012
$URL: https://svn-ccsm-models.cgd.ucar.edu/clm2/branch_tags/cesm1_0_4_rel_tags/cesm1_0_4_n05_clm4_0_32/models/lnd/clm/doc/UsersGuide/clm_ug.xml $
Dedication
Dedicated to the Land Model Working Group, winners of the 2008 CCSM Distinguished Achievement Award.
May you continue to collaborate together well, and continue to drive
the science of land surface modeling forward with your diligent and persistent efforts.
- Table of Contents
- Acknowledgments
- Introduction
- Introduction to the CLM4 User's Guide
- Important Notes and Best Practices for Usage of CLM4
- How to Use This Document
- What is new with CLM4 in CESM1.0.4 since previous public releases?
- What is new with CLM4 in CESM1.0.4 since the June 15th, 2011 CESM1.0.3 release?
- What is new with CLM4 in CESM1.0.4 Science since CLM4 in CESM1.0.3?
- What is new with CLM4 in CESM1.0.4 Software since CLM4 in CESM1.0.3?
- What was new with CLM4 in CESM1.0.3 since the December 8th, 2010 CESM1.0.2 release?
- What was new with CLM4 in CESM1.0.3 Science since CLM4 in CESM1.0.2?
- What is new with CLM4 in CESM1.0.3 Software since CLM4 in CESM1.0.2?
- What was new with CLM4 in CESM1.0.2 (in CESM1.0.2) since the September 17th, 2010 CESM1.0.1 release?
- What was new with CLM4 in CESM1.0.2 Science since CLM4 in CESM1.0.1?
- What was new with CLM4 in CESM1.0.2 Software since CLM4 in CESM1.0.1?
- What was new with CLM4 in CESM1.0.1 (in CESM1.0.1) since the April 1st, 2010 CCSM4.0 release?
- What was new with CLM4 in CESM1.0.1 Science since CCSM4.0?
- What was new with CLM4 in CESM1.0.1 Software since CCSM4.0?
- What was new with CLM4.0.00 since CLM3.5?
- What was new with CLM4.0.00 Science?
- What is new with CLM4.0.00 Software Infrastructure?
- What are The New Configuration Options in CLM4.0.00?
- What are The New Namelist Options in CLM4.0.00?
- What are The New History Fields?
- Quickstart to using CLM4
- What is scientifically validated and functional in CLM4?
- Standard Configuration and Namelist Options that are Validated
- Configure Modes NOT scientifically validated, documented, supported or, in some
cases, even advised to be used:
- Namelist options that should NOT be exercised:
- Build-Namelist options that should NOT be exercised:
- Namelist items that should NOT be exercised:
- What are the UNIX utilities required to use CLM?
- Other resources to get help from
- The CESM User's-Guide
- The CESM Bulletin Board
- The CLM web pages
- Reporting bugs in CLM4
- 1. How to customize the configuration for a case with CLM
- Choosing a compset using CLM
- Compsets coupled to data atmosphere and stub ocean/sea-ice ("I" compsets)
- Compsets coupled to active atmosphere with data ocean
- Fully coupled compsets with fully active ocean, sea-ice, and atmosphere
- Conclusion to choosing a compset
- Customizing the CLM configuration
- CLM Script configuration items
- Configure time User Namelist
- Precedence of Options
- Setting Your Initial Conditions File
- Other noteworthy configuration items
- Downloading DATM Forcing Data
- Customizing via the template files
- More information on the CLM configure script
- Customizing the CLM namelist
- Definition of Namelist items and their default values
- Examples of using different namelist features
- Customizing the DATM Namelist and Streams files
- CLM_QIAN mode and it's DATM settings
- CLM1PT mode and it's DATM settings
- CPLHIST3HrWx mode and it's DATM settings
- Conclusion to customizing chapter
- 2. Using the CLM tools to create your own input datasets
- Common environment variables and options used in building the FORTRAN
tools
- General information on running the FORTRAN tools
- Running FORTRAN tools with namelists
- Running FORTRAN tools with command line options
- Running FORTRAN tools built with SMP=TRUE
- The File Creation Process
- Using the cprnc tool to compare two history files
- Using interpinic to interpolate initial conditions to different
resolutions
- Using mkgriddata to create grid datasets
- mkgriddata namelist
- Convert CESM domain files to CLM grid files
- Create single point or regional area grid files
- Convert CAM files to CLM grid files (deprecated)
- Using mkdatadomain to create domain datasets for DATM or docn from CLM grid datasets
- Using mksurfdata to create surface datasets from grid datasets
- Running mksurfdata.pl
- Running mksurfdata by Hand
- Using NCL scripts ndepregrid.ncl and
aerdepregrid.ncl to interpolate aerosol deposition datasets
- Using ndepregrid.ncl to interpolate Nitrogen deposition datasets
- Using aerdepregrid.ncl to interpolate Aerosol deposition datasets
- How to Customize Datasets for particular Observational Sites
- Conclusion of tools description
- 3. Adding New Resolutions or New Files to the build-namelist Database
- Managing Your Own Data-files
- Adding Resolution Names
- Adding or Changing Default Filenames
- What are the required files?
- 4. How to run some special cases
- Running with the prognostic crop model on
- Running with the irrigation model on
- Spinning up the Satellite Phenology Model (CLMSP spinup)
- Spinning up the biogeochemistry Carbon-Nitrogen Model (CN spinup)
- Spinning up the Carbon-Nitrogen Dynamic Global Vegetation Model (CNDV spinup)
- Running with MOAR data as atmospheric forcing to spinup the model
- Running with your own previous simulation as atmospheric forcing to spinup the model
- Doing perturbation error growth tests
- Running stand-alone CLM with transient historical CO2
concentration
- 5. How to run Single-Point/Regional cases
- Which Single Point Option Should I choose?
- Running
PTS_MODE configurations - Warning about Running with a Single-Processor on a Batch Machine
- Running Supported Single-point/Regional Datasets
- Running Supported Single-point Datasets that have their own Atmospheric Forcing
- Creating your own single-point/regional surface datasets
- Using getregional_datasets.pl to get a complete suite of single-point/regional
surface datasets from global ones
- Running with your own atmosphere forcing
- 6. How to run PTCLM1.110726
- Introduction to PTCLM
- Guide to the options of PTCLM
- Overview on using PTCLM
- Details on the options of PTCLM
- Examples using PTCLM
- Adding data for use by PTCLM
- PTCLM Group Site Lists
- Dynamic Land-Use Change Files for use by PTCLM
- Converting AmeriFlux Data for use by PTCLM
- PTCLM transient example over a shorter time period
- A bit about the structure of PTCLM, what it does, and how it works
- 7. Trouble Shooting Problems
- Trouble with Configuration
- Trouble with Building
- Trouble with Running
- Tracking Problems by Querying Log Files
- General Advice on Debugging Run time Problems
- A. Editing Template Files Before Configure
- Outline of the CLM template
- Outline of the DATM template
- Adding a new DATM_MODE to the DATM template
- B. Using the Script runinit_ibm.csh to both Run CLM and
Interpolate Datasets
- C. Scripts for testing CLM
- Testing CLM Using the CESM Test Scripts
- Testing CLM Using the CLM Stand-Alone Testing Scripts
- Testing PTCLM use the PTCLM test script
- D. Building the Users-Guide Documentation for CLM