Chapter 1. How to customize the configuration for a case with CLM

Table of Contents
Choosing a compset using CLM
Customizing the CLM setup
Customizing the CLM namelist
Customizing the DATM Namelist and Streams files
Conclusion to customizing chapter

The CESM1.2.0 User's Guide gives you the details on how to create, setup, build, and run a case. That is the document to give you the details on using the CESM scripts. The purpose of this document is to give you the details when using CESM with CLM on how to customize and use advanced features in CLM. You should be familiar with the CESM1.2.0 User's Guide and how to setup cases with CESM1.2.0 before referring to this document.

In this chapter we deal with three different ways of customizing a case: Choosing a compset, Customizing Configuration options, and customizing the CLM Namelist. There are many different compsets that use CLM and many are setup to enable special features of CLM from the start. So the first thing you want to be familiar with are the different options in the compsets. The next section shows the different options for customizing the configuration options for CLM. Here we introduce the CLM configure and build-namelist scripts and how using the options in env_build.xml and env_run.xml you can customize the configuration and the namelist.

Choosing a compset using CLM

When setting up a new case one of the first choices to make is which "component set" (or compset) to use. The compset refers to which component models are used as well as specific settings for them. We label the different types of compsets with a different letter of the alphabet from "A" (for all data model) to "X" (for all dead model). The compsets of interest when working with CLM are the "I" compsets (which contain CLM with a data atmosphere model and a stub ocean, and stub sea-ice models), "E" and "F" compsets (which contain CLM with the active atmosphere model (CAM), prescribed sea-ice model, and a data ocean model), and "B" compsets which have all active components. Below we go into details on the "I" compsets which emphasize CLM as the only active model, and just mention the two other categories.

When working with CLM you usually want to start with a relevant "I" compset before moving to the more complex cases that involve other active model components. The "I" compsets can exercise CLM in a way that is similar to the coupled modes, but with much lower computational cost and faster turnaround times.

Compsets coupled to data atmosphere and stub ocean/sea-ice ("I" compsets)

Supported CLM Configurations are listed in Table 1-1 for the Scientifically Supported compsets (have been scientifically validated with long simulations) and in Table 1-2 for the Functionally Supported compsets (we've only checked that they function).

Table 1-1. Scientifically Supported I Compsets

Short NameDescriptionAtm. ForcingCompset Alias NamePeriod
CLM4.5SP Satellite phenology with new biogeophysCRUNCEP1850CRUCLM451850
CLM4.5BGC New biogeophys + CENTURY-like vertically resolved soil BGC + CH4 emissions, nitrogen updatesCRUNCEPI1850CRUCLM45BGC1850
I20TRCRUCLM45BGC20th Century
CLM4.5CN New biogeophys + CN soil BGC, nitrogenCRUNCEPI1850CRUCLM45CN1850
CLM4SP As in CCSM4/CESM1 releaseQianI18501850
I2000
I20TR20th Century
CLM4CN As in CCSM4/CESM1 releaseQianI1850CN1850
ICN2000
I20TRCN20th Century
IRCP26CNRCP 2.6 to 2100
IRCP45CNRCP 4.5 to 2100
IRCP60CNRCP 6.0 to 2100
IRCP85CNRCP 8.5 to 2100

Table 1-2. Functionally Supported I Compsets

Short NameDescriptionAtm. ForcingCompset Alias NamePeriod
CLM4.5BGC-CROPICRUCLM45BGCCROP New biogeophys + CENTURY-like vertically resolved soil BGC + CH4 emissions, nitrogen updates with prognostic CROPCRUNCEP2000
CLM4.5BGC-DVI1850CRUCLM45BGCDV New biogeophys + CENTURY-like vertically resolved soil BGC + CH4 emissions, nitrogen updates with DVCRUNCEP1850
CLM4.5SP-VICICLM45VIC Satellite phenology with new biogeophys with VIC hydrologyQian2000
CLM4CN-CROPICNCROP As in CCSM4/CESM1 releaseQian2000
CLM4CN-DVICNDV As in CCSM4/CESM1 releaseQian1850

Here is the entire list of compsets available. Note that using the "-user_compset" option even more combinations are possible. In the list below we give the alias name and then the long name which describes each component in parenthesis. Alias (Long-name with time-period and each component)

  1. I (2000_DATM%QIA_CLM40%SP_SICE_SOCN_RTM_SGLC_SWAV)

  2. I1850 (1850_DATM%QIA_CLM40%SP_SICE_SOCN_RTM_SGLC_SWAV)

  3. I1850CLM45 (1850_DATM%QIA_CLM45%SP_SICE_SOCN_RTM_SGLC_SWAV)

  4. I1850CLM45BGC (1850_DATM%QIA_CLM45%BGC_SICE_SOCN_RTM_SGLC_SWAV)

  5. I1850CLM45CN (1850_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_SGLC_SWAV)

  6. I1850CLM45CNF (1850_DATM%QIA_CLM45%CN_SICE_SOCN_RTM%FLOOD_SGLC_SWAV)

  7. I1850CN (1850_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_SGLC_SWAV)

  8. I1850CRU (1850_DATM%CRU_CLM40%SP_SICE_SOCN_RTM_SGLC_SWAV)

  9. I1850CRUCLM45 (1850_DATM%CRU_CLM45%SP_SICE_SOCN_RTM_SGLC_SWAV)

  10. I1850CRUCLM45BGC (1850_DATM%CRU_CLM45%BGC_SICE_SOCN_RTM_SGLC_SWAV)

  11. I1850CRUCLM45BGCDV (1850_DATM%CRU_CLM45%BGCDV_SICE_SOCN_RTM_SGLC_SWAV)

  12. I1850CRUCLM45CN (1850_DATM%CRU_CLM45%CN_SICE_SOCN_RTM_SGLC_SWAV)

  13. I1850CRUCN (1850_DATM%CRU_CLM40%CN_SICE_SOCN_RTM_SGLC_SWAV)

  14. I1850SPINUPCLM45BGC (1850_DATM%S1850_CLM45%BGC_SICE_SOCN_RTM_SGLC_SWAV)

  15. I1850SPINUPCN (1850_DATM%S1850_CLM40%CN_SICE_SOCN_RTM_SGLC_SWAV)

  16. I1PT (2000_DATM%1PT_CLM40%SP_SICE_SOCN_RTM_SGLC_SWAV)

  17. I1PTCLM45 (2000_DATM%1PT_CLM45%SP_SICE_SOCN_RTM_SGLC_SWAV)

  18. I20TR (20TR_DATM%QIA_CLM40%SP_SICE_SOCN_RTM_SGLC_SWAV)

  19. I20TRCLM45 (20TR_DATM%QIA_CLM45%SP_SICE_SOCN_RTM_SGLC_SWAV)

  20. I20TRCLM45CN (20TR_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_SGLC_SWAV)

  21. I20TRCN (20TR_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_SGLC_SWAV)

  22. I20TRCRU (20TR_DATM%CRU_CLM40%SP_SICE_SOCN_RTM_SGLC_SWAV)

  23. I20TRCRUCLM45 (20TR_DATM%CRU_CLM45%SP_SICE_SOCN_RTM_SGLC_SWAV)

  24. I20TRCRUCLM45BGC (20TR_DATM%CRU_CLM45%BGC_SICE_SOCN_RTM_SGLC_SWAV)

  25. I20TRCRUCLM45CN (20TR_DATM%CRU_CLM45%CN_SICE_SOCN_RTM_SGLC_SWAV)

  26. I20TRCRUCN (20TR_DATM%CRU_CLM40%CN_SICE_SOCN_RTM_SGLC_SWAV)

  27. I4804 (4804_DATM%QIA_CLM40%SP_SICE_SOCN_RTM_SGLC_SWAV)

  28. I4804CLM45 (4804_DATM%QIA_CLM45%SP_SICE_SOCN_RTM_SGLC_SWAV)

  29. I4804CLM45CN (4804_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_SGLC_SWAV)

  30. I4804CN (4804_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_SGLC_SWAV)

  31. ICLM45 (2000_DATM%QIA_CLM45%SP_SICE_SOCN_RTM_SGLC_SWAV)

  32. ICLM45BGC (2000_DATM%QIA_CLM45%BGC_SICE_SOCN_RTM_SGLC_SWAV)

  33. ICLM45BGCCROP (2000_DATM%QIA_CLM45%BGC-CROP_SICE_SOCN_RTM_SGLC_SWAV)

  34. ICLM45BGCDV (2000_DATM%QIA_CLM45%BGCDV_SICE_SOCN_RTM_SGLC_SWAV)

  35. ICLM45BGCDVCROP (2000_DATM%QIA_CLM45%BGCDV-CROP_SICE_SOCN_RTM_SGLC_SWAV)

  36. ICLM45BGCNoVS (2000_DATM%QIA_CLM45%NoVS_SICE_SOCN_RTM_SGLC_SWAV)

  37. ICLM45CN (2000_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_SGLC_SWAV)

  38. ICLM45CNCROP (2000_DATM%QIA_CLM45%CN-CROP_SICE_SOCN_RTM_SGLC_SWAV)

  39. ICLM45CNDV (2000_DATM%QIA_CLM45%CNDV_SICE_SOCN_RTM_SGLC_SWAV)

  40. ICLM45CNTEST (2003_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_SGLC_SWAV_TEST)

  41. ICLM45CRUBGC (2000_DATM%CRU_CLM45%BGC_SICE_SOCN_RTM_SGLC_SWAV)

  42. ICLM45GLCMEC (2000_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_CISM1_SWAV_TEST)

  43. ICLM45SNCRFRC (2000_DATM%QIA_CLM45%SP-SNCR_SICE_SOCN_RTM_SGLC_SWAV)

  44. ICLM45USUMB (2000_DATM%1PT_CLM45%SP_SICE_SOCN_RTM_SGLC_SWAV_CLMUSRDAT%1x1_US-UMB)

  45. ICLM45VIC (2000_DATM%QIA_CLM45%SP-VIC_SICE_SOCN_RTM_SGLC_SWAV)

  46. ICLM45alaskaCN (2000_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_SGLC_SWAV_CLMUSRDAT%13x12pt_f19_alaskaUSA)

  47. ICN (2000_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_SGLC_SWAV)

  48. ICNCROP (2000_DATM%QIA_CLM40%CN-CROP_SICE_SOCN_RTM_SGLC_SWAV)

  49. ICNDV (2000_DATM%QIA_CLM40%CNDV_SICE_SOCN_RTM_SGLC_SWAV)

  50. ICNDVCROP (2000_DATM%QIA_CLM40%CNDV-CROP_SICE_SOCN_RTM_SGLC_SWAV)

  51. ICNTEST (2003_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_SGLC_SWAV_TEST)

  52. ICRU (2000_DATM%CRU_CLM40%SP_SICE_SOCN_RTM_SGLC_SWAV)

  53. ICRUCLM45 (2000_DATM%CRU_CLM45_SICE_SOCN_RTM_SGLC_SWAV)

  54. ICRUCLM45BGC (2000_DATM%CRU_CLM45%BGC_SICE_SOCN_RTM_SGLC_SWAV)

  55. ICRUCLM45BGCCROP (2000_DATM%CRU_CLM45%BGC-CROP_SICE_SOCN_RTM_SGLC_SWAV)

  56. ICRUCLM45BGCTEST (2003_DATM%CRU_CLM45%BGC_SICE_SOCN_RTM_SGLC_SWAV_TEST)

  57. ICRUCLM45CN (2000_DATM%CRU_CLM45%CN_SICE_SOCN_RTM_SGLC_SWAV)

  58. ICRUCN (2000_DATM%CRU_CLM40%CN_SICE_SOCN_RTM_SGLC_SWAV)

  59. IG (2000_DATM%QIA_CLM40%SP_SICE_SOCN_RTM_CISM1_SWAV)

  60. IG1850 (1850_DATM%QIA_CLM40%SP_SICE_SOCN_RTM_CISM1_SWAV)

  61. IG1850CLM45 (1850_DATM%QIA_CLM45%SP_SICE_SOCN_RTM_CISM1_SWAV)

  62. IG1850CLM45CN (1850_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_CISM1_SWAV)

  63. IG1850CN (1850_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_CISM1_SWAV)

  64. IG20TR (20TR_DATM%QIA_CLM40%SP_SICE_SOCN_RTM_CISM1_SWAV)

  65. IG20TRCLM45 (20TR_DATM%QIA_CLM45%SP_SICE_SOCN_RTM_CISM1_SWAV)

  66. IG20TRCLM45CN (20TR_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_CISM1_SWAV)

  67. IG20TRCN (20TR_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_CISM1_SWAV)

  68. IG4804 (4804_DATM%QIA_CLM40%SP_SICE_SOCN_RTM_CISM1_SWAV)

  69. IG4804CLM45 (4804_DATM%QIA_CLM45%SP_SICE_SOCN_RTM_CISM1_SWAV)

  70. IG4804CLM45CN (4804_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_CISM1_SWAV)

  71. IG4804CN (4804_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_CISM1_SWAV)

  72. IGCLM45 (2000_DATM%QIA_CLM45%SP_SICE_SOCN_RTM_CISM1_SWAV)

  73. IGCLM45CN (2000_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_CISM1_SWAV)

  74. IGCN (2000_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_CISM1_SWAV)

  75. IGLCMEC (2000_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_CISM1_SWAV_TEST)

  76. IGRCP26CLM45CN (RCP2_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_CISM1_SWAV)

  77. IGRCP26CN (RCP2_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_CISM1_SWAV)

  78. IGRCP45CLM45CN (RCP4_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_CISM1_SWAV)

  79. IGRCP45CN (RCP4_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_CISM1_SWAV)

  80. IGRCP60CLM45CN (RCP6_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_CISM1_SWAV)

  81. IGRCP60CN (RCP6_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_CISM1_SWAV)

  82. IGRCP85CLM45CN (RCP8_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_CISM1_SWAV)

  83. IGRCP85CN (RCP8_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_CISM1_SWAV)

  84. IRCP26CLM45CN (RCP2_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_SGLC_SWAV)

  85. IRCP26CN (RCP2_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_SGLC_SWAV)

  86. IRCP45CLM45CN (RCP4_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_SGLC_SWAV)

  87. IRCP45CN (RCP4_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_SGLC_SWAV)

  88. IRCP60CLM45CN (RCP6_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_SGLC_SWAV)

  89. IRCP60CN (RCP6_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_SGLC_SWAV)

  90. IRCP85CLM45CN (RCP8_DATM%QIA_CLM45%CN_SICE_SOCN_RTM_SGLC_SWAV)

  91. IRCP85CN (RCP8_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_SGLC_SWAV)

  92. ISNCRFRC (2000_DATM%QIA_CLM40%SP-SNCR_SICE_SOCN_RTM_SGLC_SWAV)

  93. ITEST (2003_DATM%QIA_CLM40%SP_SICE_SOCN_RTM_SGLC_SWAV_TEST)

  94. ITESTCLM45 (2003_DATM%QIA_CLM45%SP_SICE_SOCN_RTM_SGLC_SWAV_TEST)

  95. IUSUMB (2000_DATM%1PT_CLM40%SP_SICE_SOCN_RTM_SGLC_SWAV_CLMUSRDAT%1x1_US-UMB)

  96. IalaskaCN (2000_DATM%QIA_CLM40%CN_SICE_SOCN_RTM_SGLC_SWAV_CLMUSRDAT%13x12pt_f19_alaskaUSA)

Compsets coupled to active atmosphere with data ocean

CAM compsets are compsets that start with "E" or "F" in the name. They are described more fully in the scripts documentation or the CAM documentation. "E" compsets have a slab ocean model while "F" compsets have a data ocean model.

Fully coupled compsets with fully active ocean, sea-ice, and atmosphere

Fully coupled compsets are compsets that start with "B" in the name. They are described more fully in the scripts documentation.

Conclusion to choosing a compset

We've introduced the basic type of compsets that use CLM and given some further details for the "standalone CLM" (or "I" compsets). The config_compsets.xml lists all of the compsets and gives a full description of each of them. In the next section we look into customizing the setup time options for compsets using CLM.