CESM CASEROOT env_run.xml file

Model Version: CESM2.0
HTML created on: 2017-06-21

Description

The CASEROOT scripts read the XML settings in the env_run.xml file in order to
determine case run specific settings.

Interface Tools

CESM2.0 supports multiple run groups. The xmlquery and xmlchange script tools
accept the --subgroup command line argument to define one of the run groups.
Changes to these settings may be made prior to calling case.submit.

Examples

Navigation Instuctions

Clicking on the blue link will display additional descriptive information.
Click on the "Show Details" button and then cntl+F key to search for specific strings in this file.



File Description Header <header>

    These variables MAY BE CHANGED ANYTIME during a run.
    Additional machine speific variables that can be changed
    during a run are contained in the env_mach_specific file
    Note1: users SHOULD NOT modify BUILD_COMPETE in env_build.xml
    this is done automatically by the scripts.
    

Run Group Settings <group id="run_desc"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LOGDIR
    • value = $CASEROOT/logs
  • Data Type <type> : char
  • Description <desc> : Extra copies of the component log files will be saved here.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CASESTR
    • value = UNSET
  • Data Type <type> : char
  • Description <desc> : case description
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = RUNDIR
    • value = $CIME_OUTPUT_ROOT/$CASE/run
  • Data Type <type> : char
  • Description <desc> : The directory where the executable will be run. By default this is set to EXEROOT/../run. RUNDIR allows you to keep the run directory separate from the build directory

Run Group Settings <group id="run_begin_stop_restart"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = RUN_TYPE
    • value = startup
  • Data Type <type> : char
  • Valid Values <valid_values> : startup,hybrid,branch
  • Description <desc> : Determines the model run initialization type. This setting is only important for the initial run of a production run when the CONTINUE_RUN variable is set to FALSE. After the initial run, the CONTINUE_RUN variable is set to TRUE, and the model restarts exactly using input files in a case, date, and bit-for-bit continuous fashion. Default: startup. -- In a startup run (the default), all components are initialized using baseline states. These baseline states are set independently by each component and can include the use of restart files, initial files, external observed data files, or internal initialization (i.e., a cold start). In a startup run, the coupler sends the start date to the components at initialization. In addition, the coupler does not need an input data file. In a startup initialization, the ocean model does not start until the second ocean coupling (normally the second day). -- In a branch run, all components are initialized using a consistent set of restart files from a previous run (determined by the RUN_REFCASE and RUN_REFDATE variables in env_run.xml). The case name is generally changed for a branch run, although it does not have to be. In a branch run, setting RUN_STARTDATE is ignored because the model components obtain the start date from their restart datasets. Therefore, the start date cannot be changed for a branch run. This is the same mechanism that is used for performing a restart run (where CONTINUE_RUN is set to TRUE in the env_run.xml) Branch runs are typically used when sensitivity or parameter studies are required, or when settings for history file output streams need to be modified while still maintaining bit-for-bit reproducibility. Under this scenario, the new case is able to produce an exact bit-for-bit restart in the same manner as a continuation run IF no source code or component namelist inputs are modified. All models use restart files to perform this type of run. RUN_REFCASE and RUN_REFDATE are required for branch runs. To set up a branch run, locate the restart tar file or restart directory for RUN_REFCASE and RUN_REFDATE from a previous run, then place those files in the RUNDIR directory. --- In a hybrid run the model is initialized as a startup, BUT uses initialization datasets FROM A PREVIOUS case. This is somewhat analogous to a branch run with relaxed restart constraints. A hybrid run allows users to bring together combinations of initial/restart files from a previous case (specified by RUN_REFCASE) at a given model output date (specified by RUN_REFDATE). Unlike a branch run, the starting date of a hybrid run (specified by RUN_STARTDATE) can be modified relative to the reference case. In a hybrid run, the model does not continue in a bit-for-bit fashion with respect to the reference case. The resulting climate, however, should be continuous provided that no model source code or namelists are changed in the hybrid run. In a hybrid initialization, the ocean model does not start until the second ocean coupling (normally the second day), and the coupler does a cold start without a restart file.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = RUN_REFDIR
    • value = ccsm4_init
  • Data Type <type> : char
  • Description <desc> : Reference directory containing RUN_REFCASE data - used for hybrid or branch runs
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = RUN_REFCASE
    • value = case.std
  • Data Type <type> : char
  • Description <desc> : Reference case for hybrid or branch runs
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = RUN_REFDATE
    • value = 0001-01-01
  • Data Type <type> : char
  • Description <desc> : Reference date for hybrid or branch runs (yyyy-mm-dd)
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = RUN_REFTOD
    • value = 00000
  • Data Type <type> : char
  • Description <desc> : Reference time of day (seconds) for hybrid or branch runs (sssss)
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GET_REFCASE
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : Flag for automatically prestaging the refcase restart dataset. If TRUE, then the refcase data is prestaged into the executable directory
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = RUN_STARTDATE
    • value = 1850-01-01
  • Data Type <type> : char
  • Description <desc> : Run start date (yyyy-mm-dd). Only used for startup or hybrid runs.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = START_TOD
    • value = 0
  • Data Type <type> : integer
  • Description <desc> : Run start time-of-day
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = STOP_OPTION
    • value = nyears
  • Data Type <type> : char
  • Valid Values <valid_values> : none,never,nsteps,nstep,nseconds,nsecond,nminutes,nminute,nhours,nhour,ndays,nday,nmonths,nmonth,nyears,nyear,date,ifdays0,end
  • Description <desc> : Sets the run length along with STOP_N and STOP_DATE
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = STOP_N
    • value = 2
  • Data Type <type> : integer
  • Description <desc> : Provides a numerical count for $STOP_OPTION.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = STOP_DATE
    • value = -999
  • Data Type <type> : integer
  • Description <desc> : Alternative date yyyymmdd date option, sets the run length with STOP_OPTION and STOP_N negative value implies off
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = REST_OPTION
    • value = nmonths
  • Data Type <type> : char
  • Valid Values <valid_values> : none,never,nsteps,nstep,nseconds,nsecond,nminutes,nminute,nhours,nhour,ndays,nday,nmonths,nmonth,nyears,nyear,date,ifdays0,end
  • Description <desc> : sets frequency of model restart writes (same options as STOP_OPTION)
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = REST_N
    • value = 2
  • Data Type <type> : integer
  • Description <desc> : sets model restart writes with REST_OPTION and REST_DATE
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = REST_DATE
    • value = $STOP_DATE
  • Data Type <type> : char
  • Description <desc> : Alternative date in yyyymmdd format sets model restart write date with REST_OPTION and REST_N
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PAUSE_OPTION
    • value = never
  • Data Type <type> : char
  • Valid Values <valid_values> : none,never,nsteps,nstep,nseconds,nsecond,nminutes,nminute,nhours,nhour,ndays,nday,nmonths,nmonth,nyears,nyear
  • Description <desc> : Sets the pause frequency along with PAUSE_N
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PAUSE_N
    • value = 0
  • Data Type <type> : integer
  • Description <desc> : Provides a numerical count for $PAUSE_OPTION.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PAUSE_COMPONENT_LIST
    • value = none
  • Data Type <type> : char
  • Description <desc> : A colon-separated list of components to receive pause and resume signals A value of 'all' means all components will pause and resume A value of 'none' means that no components will pause or resume
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = BARRIER_N
    • value = 1
  • Data Type <type> : char
  • Description <desc> : sets periodic model barriers with BARRIER_OPTION and BARRIER_DATE for synchronization
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = BARRIER_DATE
    • value = -999
  • Data Type <type> : char
  • Description <desc> : Alternative date in yyyymmdd format sets periodic model barriers with BARRIER_OPTION and BARRIER_N for synchronization
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ESP_RUN_ON_PAUSE
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : ESP component runs after driver 'pause cycle' If any component 'pauses' (see PAUSE_OPTION, PAUSE_N and PAUSE_COMPONENT_LIST XML variables), the ESP component (if present) will be run to process the component 'pause' (restart) files and set any required 'resume' signals. If true, esp_cpl_dt and esp_cpl_offset settings are ignored. default: false
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CONTINUE_RUN
    • value = TRUE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : A setting of TRUE implies a continuation run When you first begin a branch, hybrid or startup run, CONTINUE_RUN must be set to FALSE. When you successfully run and get a restart file, you will need to change CONTINUE_RUN to TRUE for the remainder of your run. This variable determines if the run is a restart run. Set to FALSE when initializing a startup, branch or hybrid case. Set to TRUE when continuing a run.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = RESUBMIT
    • value = 0
  • Data Type <type> : integer
  • Description <desc> : If RESUBMIT is greater than 0, then case will automatically resubmit Enables the model to automatically resubmit a new run. To get multiple runs, set RESUBMIT greater than 0, then RESUBMIT will be decremented and the case will be resubmitted. The case will stop automatically resubmitting when the RESUBMIT value reaches 0. Long runs can easily outstrip supercomputer queue time limits. For this reason, a case is usually run as a series of jobs, each restarting where the previous finished.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = RESUBMIT_SETS_CONTINUE_RUN
    • value = TRUE
  • Data Type <type> : logical
  • Description <desc> : This flag controls whether the RESUBMIT flag causes CONTINUE_RUN to toggle from FALSE to TRUE. The default is TRUE. This flag might be used in conjunction with COMP_RUN_BARRIERS for timing tests.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = RUN_WITH_SUBMIT
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : Logical to determine whether CESM run has been submitted with the submit script or not
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = BARRIER_OPTION
    • value = never
  • Data Type <type> : char
  • Valid Values <valid_values> : none,never,nsteps,nstep,nseconds,nsecond,nminutes,nminute,nhours,nhour,ndays,nday,nmonths,nmonth,nyears,nyear,date,ifdays0,end
  • Description <desc> : sets frequency of full model barrier (same options as STOP_OPTION) for synchronization with BARRIER_N and BARRIER_DATE

Run Group Settings <group id="run_data_archive"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = DOUT_S
    • value = TRUE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : Logical to turn on short term archiving. If TRUE, short term archiving will be turned on.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = DOUT_S_SAVE_INTERIM_RESTART_FILES
    • value = TRUE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : Logical to archive all interim restart files, not just those at eor If TRUE, perform short term archiving on all interim restart files, not just those at the end of the run. By default, this value is FALSE. The restart files are saved under the specific component directory ($DOUT_S_ROOT/$CASE/$COMPONENT/rest rather than the top-level $DOUT_S_ROOT/$CASE/rest directory). Interim restart files are created using the REST_N and REST_OPTION variables. This is for expert users ONLY and requires expert knowledge. We will not document this further in this guide.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = SYSLOG_N
    • value = 900
  • Data Type <type> : integer
  • Description <desc> : system workload snapshot frequency (in seconds, if greater than 0; disabled otherwise)

Run Group Settings <group id="run_flags"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CHECK_TIMING
    • value = TRUE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : logical to diagnose model timing at the end of the run
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = TIMER_LEVEL
    • value = 4
  • Data Type <type> : integer
  • Description <desc> : timer output depth
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = SAVE_TIMING_DIR
    • value = timing
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : Where to auto archive timing data
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = COMP_RUN_BARRIERS
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : Turns on component barriers for component timing. This variable is for testing and debugging only and should never be set for a production run.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CPL_DECOMP
    • value = 0
  • Data Type <type> : integer
  • Valid Values <valid_values> : 0,1,2,3,4,5,6
  • Description <desc> : Coupler decomposition option.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = INFO_DBUG
    • value = 1
  • Data Type <type> : integer
  • Valid Values <valid_values> : 0,1,2,3
  • Description <desc> : level of debug output, 0=minimum, 1=normal, 2=more, 3=too much
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = DRV_THREADING
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : Turns on component varying thread control in the driver. Used to set the driver namelist variable "drv_threading".
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = SAVE_TIMING
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : logical to save timing files in rundir
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = TIMER_DETAIL
    • value = 2
  • Data Type <type> : integer
  • Description <desc> : timer output depth
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = BFBFLAG
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : turns on coupler bit-for-bit reproducibility with varying pe counts
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = FLDS_WISO
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : Turn on the passing of water isotope fields through the coupler

Run Group Settings <group id="run_cesm"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PROFILE_PAPI_ENABLE
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : Enables the papi hardware counters in gptl The papi library must be included in the build step for this to work.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ESMF_LOGFILE_KIND
    • value = ESMF_LOGKIND_NONE
  • Data Type <type> : char
  • Valid Values <valid_values> : ESMF_LOGKIND_SINGLE,ESMF_LOGKIND_MULTI,ESMF_LOGKIND_NONE
  • Description <desc> : Determines what ESMF log files (if any) are generated when USE_ESMF_LIB is TRUE. ESMF_LOGKIND_SINGLE: Use a single log file, combining messages from all of the PETs. Not supported on some platforms. ESMF_LOGKIND_MULTI: Use multiple log files -- one per PET. ESMF_LOGKIND_NONE: Do not issue messages to a log file. By default, no ESMF log files are generated.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = TPROF_TOTAL
    • value = 0
  • Data Type <type> : integer
  • Description <desc> : Determines number of times profiler is called over the model run period. This sets values for tprof_option and tprof_n that determine the timing output file frequency

Run Group Settings <group id="run_domain"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PTS_MODE
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : Operate on only a single point of the global grid - DO NOT EDIT (for experts only)
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PTS_LAT
    • value = -999.99
  • Data Type <type> : real
  • Description <desc> : Latitude to find nearest points for points mode (only used if PTS_MODE is TRUE)
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PTS_LON
    • value = -999.99
  • Data Type <type> : real
  • Description <desc> : Longitude to find nearest points for points mode (only used if PTS_MODE is TRUE)
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM_DOMAIN_FILE
    • value = domain.lnd.fv0.9x1.25_gx1v7.151020.nc
  • Data Type <type> : char
  • Description <desc> : atm domain file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM_DOMAIN_PATH
    • value = $DIN_LOC_ROOT/share/domains
  • Data Type <type> : char
  • Description <desc> : path of atm domain file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LND_DOMAIN_FILE
    • value = domain.lnd.fv0.9x1.25_gx1v7.151020.nc
  • Data Type <type> : char
  • Description <desc> : lnd domain file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LND_DOMAIN_PATH
    • value = $DIN_LOC_ROOT/share/domains
  • Data Type <type> : char
  • Description <desc> : path of lnd domain file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ROF_DOMAIN_FILE
    • value = UNSET
  • Data Type <type> : char
  • Description <desc> : rof domain file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ROF_DOMAIN_PATH
    • value = $DIN_LOC_ROOT/share/domains
  • Data Type <type> : char
  • Description <desc> : path of rof domain file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = WAV_DOMAIN_FILE
    • value = UNSET
  • Data Type <type> : char
  • Description <desc> : wav domain file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = WAV_DOMAIN_PATH
    • value = $DIN_LOC_ROOT/share/domains
  • Data Type <type> : char
  • Description <desc> : path of wav domain file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ICE_DOMAIN_FILE
    • value = domain.ocn.gx1v7.151008.nc
  • Data Type <type> : char
  • Description <desc> : ice domain file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ICE_DOMAIN_PATH
    • value = $DIN_LOC_ROOT/share/domains
  • Data Type <type> : char
  • Description <desc> : path of ice domain file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN_DOMAIN_FILE
    • value = domain.ocn.gx1v7.151008.nc
  • Data Type <type> : char
  • Description <desc> : ocn domain file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN_DOMAIN_PATH
    • value = $DIN_LOC_ROOT/share/domains
  • Data Type <type> : char
  • Description <desc> : path of ocn domain file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GLC_DOMAIN_FILE
    • value = UNSET
  • Data Type <type> : char
  • Description <desc> : glc domain file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GLC_DOMAIN_PATH
    • value = $DIN_LOC_ROOT/share/domains
  • Data Type <type> : char
  • Description <desc> : path of glc domain file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM2OCN_FMAPNAME
    • value = cpl/gridmaps/fv0.9x1.25/map_fv0.9x1.25_TO_gx1v7_aave.151008.nc
  • Data Type <type> : char
  • Description <desc> : atm2ocn flux mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM2OCN_FMAPTYPE
    • value = X
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : atm2ocn flux mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM2OCN_SMAPNAME
    • value = cpl/gridmaps/fv0.9x1.25/map_fv0.9x1.25_TO_gx1v7_blin.151008.nc
  • Data Type <type> : char
  • Description <desc> : atm2ocn state mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM2OCN_SMAPTYPE
    • value = X
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : atm2ocn state mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM2OCN_VMAPNAME
    • value = cpl/gridmaps/fv0.9x1.25/map_fv0.9x1.25_TO_gx1v7_patc.151008.nc
  • Data Type <type> : char
  • Description <desc> : atm2ocn vector mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM2OCN_VMAPTYPE
    • value = X
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : atm2ocn vector mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM2LND_FMAPNAME
    • value = idmap
  • Data Type <type> : char
  • Description <desc> : atm2lnd flux mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM2LND_FMAPTYPE
    • value = X
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : atm2lnd flux mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM2LND_SMAPNAME
    • value = idmap
  • Data Type <type> : char
  • Description <desc> : atm2lnd state mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM2LND_SMAPTYPE
    • value = X
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : atm2lnd state mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM2WAV_SMAPNAME
    • value = cpl/gridmaps/fv0.9x1.25/map_fv0.9x1.25_TO_ww3a_bilin.160324.nc
  • Data Type <type> : char
  • Description <desc> : atm2wav state mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM2WAV_SMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : atm2wav state mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN2ATM_FMAPNAME
    • value = cpl/gridmaps/gx1v7/map_gx1v7_TO_fv0.9x1.25_aave.151008.nc
  • Data Type <type> : char
  • Description <desc> : ocn2atm flux mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN2ATM_FMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : ocn2atm flux mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN2ATM_SMAPNAME
    • value = cpl/gridmaps/gx1v7/map_gx1v7_TO_fv0.9x1.25_aave.151008.nc
  • Data Type <type> : char
  • Description <desc> : ocn2atm state mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN2ATM_SMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : ocn2atm state mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LND2ATM_FMAPNAME
    • value = idmap
  • Data Type <type> : char
  • Description <desc> : lnd2atm flux mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LND2ATM_FMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : lnd2atm flux mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LND2ATM_SMAPNAME
    • value = idmap
  • Data Type <type> : char
  • Description <desc> : lnd2atm state mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LND2ATM_SMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : lnd2atm state mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LND2GLC_FMAPNAME
    • value = cpl/gridmaps/fv0.9x1.25/map_fv0.9x1.25_TO_gland4km_aave.170429.nc
  • Data Type <type> : char
  • Description <desc> : lnd2glc flux mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LND2GLC_FMAPTYPE
    • value = X
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : lnd2glc flux mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LND2GLC_SMAPNAME
    • value = cpl/gridmaps/fv0.9x1.25/map_fv0.9x1.25_TO_gland4km_blin.170429.nc
  • Data Type <type> : char
  • Description <desc> : lnd2glc state mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LND2GLC_SMAPTYPE
    • value = X
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : lnd2glc state mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LND2ROF_FMAPNAME
    • value = lnd/clm2/mappingdata/maps/0.9x1.25/map_0.9x1.25_nomask_to_0.5x0.5_nomask_aave_da_c120522.nc
  • Data Type <type> : char
  • Description <desc> : lnd2rof flux mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LND2ROF_FMAPTYPE
    • value = X
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : lnd2rof flux mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ROF2LND_FMAPNAME
    • value = lnd/clm2/mappingdata/maps/0.9x1.25/map_0.5x0.5_nomask_to_0.9x1.25_nomask_aave_da_c121019.nc
  • Data Type <type> : char
  • Description <desc> : rof2lnd flux mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ROF2LND_FMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : rof2lnd flux mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ROF2OCN_FMAPNAME
    • value = cpl/gridmaps/r05/map_r05_TO_gx1v7_aave.161012.nc
  • Data Type <type> : char
  • Description <desc> : rof2ocn flux mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ROF2OCN_FMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : rof2ocn flux mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ROF2OCN_LIQ_RMAPNAME
    • value = cpl/gridmaps/r05/map_r05_to_gx1v7_nn_open_ocean_nnsm_e1000r300_marginal_sea_170413.nc
  • Data Type <type> : char
  • Description <desc> : rof2ocn runoff mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ROF2OCN_LIQ_RMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : rof2ocn runoff mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ROF2OCN_ICE_RMAPNAME
    • value = cpl/gridmaps/r05/map_r05_to_gx1v7_nnsm_e1000r300_170413.nc
  • Data Type <type> : char
  • Description <desc> : rof2ocn runoff mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ROF2OCN_ICE_RMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : rof2ocn runoff mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GLC2LND_FMAPNAME
    • value = cpl/gridmaps/gland4km/map_gland4km_TO_fv0.9x1.25_aave.170429.nc
  • Data Type <type> : char
  • Description <desc> : glc2lnd flux mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GLC2LND_FMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : glc2lnd flux mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GLC2LND_SMAPNAME
    • value = cpl/gridmaps/gland4km/map_gland4km_TO_fv0.9x1.25_aave.170429.nc
  • Data Type <type> : char
  • Description <desc> : glc2lnd state mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GLC2LND_SMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : glc2lnd state mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GLC2ICE_RMAPNAME
    • value = idmap
  • Data Type <type> : char
  • Description <desc> : glc2ice runoff mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GLC2ICE_RMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : glc2ice runoff mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GLC2OCN_RMAPNAME
    • value = cpl/gridmaps/gland4km/map_gland4km_to_gx1v7_nnsm_e1000r300_170501.nc
  • Data Type <type> : char
  • Description <desc> : glc2ocn runoff mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GLC2OCN_RMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : glc2ocn runoff mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN2WAV_SMAPNAME
    • value = cpl/gridmaps/gx1v7/map_gx1v7_TO_ww3a_splice_170214.nc
  • Data Type <type> : char
  • Description <desc> : ocn2wav state mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN2WAV_SMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : ocn2wav state mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ICE2WAV_SMAPNAME
    • value = cpl/gridmaps/gx1v7/map_gx1v7_TO_ww3a_splice_170214.nc
  • Data Type <type> : char
  • Description <desc> : ice2wav state mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ICE2WAV_SMAPTYPE
    • value = Y
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : ice2wav state mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = WAV2OCN_SMAPNAME
    • value = cpl/gridmaps/ww3a/map_ww3a_TO_gx1v7_splice_170214.nc
  • Data Type <type> : char
  • Description <desc> : wav2ocn state mapping file
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = WAV2OCN_SMAPTYPE
    • value = X
  • Data Type <type> : char
  • Valid Values <valid_values> : X,Y
  • Description <desc> : wav2ocn state mapping file decomp type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = VECT_MAP
    • value = cart3d
  • Data Type <type> : char
  • Valid Values <valid_values> : none,npfix,cart3d,cart3d_diag,cart3d_uvw,cart3d_uvw_diag
  • Description <desc> : vector mapping option
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = EPS_FRAC
    • value = 1.0e-02
  • Data Type <type> : char
  • Description <desc> : Error tolerance for differences in fractions in domain checking
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = EPS_AAREA
    • value = 9.0e-07
  • Data Type <type> : real
  • Description <desc> : Error tolerance for differences in atm/land areas in domain checking
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = EPS_AMASK
    • value = 1.0e-13
  • Data Type <type> : real
  • Description <desc> : Error tolerance for differences in atm/land masks in domain checking
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = EPS_AGRID
    • value = 1.0e-12
  • Data Type <type> : real
  • Description <desc> : Error tolerance for differences in atm/land lat/lon in domain checking
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = EPS_OAREA
    • value = 1.0e-01
  • Data Type <type> : real
  • Description <desc> : Error tolerance for differences in ocean/ice lon/lat in domain checking
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = EPS_OMASK
    • value = 1.0e-06
  • Data Type <type> : real
  • Description <desc> : Error tolerance for differences in ocean/ice lon/lat in domain checking
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = EPS_OGRID
    • value = 1.0e-02
  • Data Type <type> : real
  • Description <desc> : Error tolerance for differences in ocean/ice lon/lat in domain checking

Run Group Settings <group id="run_din"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = NODENAME_REGEX
    • value = .*.cheyenne.ucar.edu
  • Data Type <type> : char
  • Description <desc> : A regular expression to match machine node names to ACME machine.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = NODE_FAIL_REGEX
    • value =
  • Data Type <type> : char
  • Description <desc> : A regular expression to search for an indication that a run failure was caused by a node failure and should therefore be re-attempted.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PROXY
    • value = UNSET
  • Data Type <type> : char
  • Description <desc> : Proxy (if any) setting for http_proxy to allow web access on this machine.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = TEST
    • value = FALSE
  • Data Type <type> : logical
  • Description <desc> : Indicates to case.submit that this is a test case.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = DIN_LOC_ROOT
    • value = $ENV{CESMDATAROOT}/inputdata
  • Data Type <type> : char
  • Description <desc> : The root directory of all CIME and component input data for the selected machine. This is usually a shared disk area. Default values for the target machine are in the $CIMEROOT/machines/config_machines.xml
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = DIN_LOC_ROOT_CLMFORC
    • value = $ENV{CESMDATAROOT}/lmwg
  • Data Type <type> : char
  • Description <desc> : CLM-specific root directory for CLM type input forcing data This directory will only be used for I (CLM/DATM) compsets and only for datm forcing data that is NOT checked into the svn repository (datasets other than the Qian or single-point forcing). This is usually a shared disk area. Default values for the target machine are in the $CIMEROOT/machines/config_machines.xml

Run Group Settings <group id="run_dout"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = DOUT_S_ROOT
    • value = $CIME_OUTPUT_ROOT/archive/$CASE
  • Data Type <type> : char
  • Description <desc> : Root directory for short term archiving. This directory must be visible to compute nodes.

Run Group Settings <group id="run_mpi"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = MPI_RUN_COMMAND
    • value = UNSET
  • Data Type <type> : char
  • Description <desc> : override the mpi run command, do not include model executable

Run Group Settings <group id="run_pio"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_ASYNC_INTERFACE
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : TRUE implies perform asynchronous i/o
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_REARR_COMM_TYPE
    • value = p2p
  • Data Type <type> : char
  • Valid Values <valid_values> : p2p,coll,default
  • Description <desc> : pio rearranger communication type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_REARR_COMM_FCD
    • value = 2denable
  • Data Type <type> : char
  • Valid Values <valid_values> : 2denable,io2comp,comp2io,disable,default
  • Description <desc> : pio rearranger communication flow control direction
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_REARR_COMM_MAX_PEND_REQ_COMP2IO
    • value = 0
  • Data Type <type> : integer
  • Valid Values <valid_values> :
  • Description <desc> : pio rearranger communication max pending requests (comp2io) : 0 implies that CIME internally calculates the value ( = max(64, 2 * PIO_NUMTASKS) ), -1 implies no bound on max pending requests
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_REARR_COMM_ENABLE_HS_COMP2IO
    • value = TRUE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : pio rearranger communiation options (comp2io) : TRUE implies enable handshake
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_REARR_COMM_ENABLE_ISEND_COMP2IO
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : pio rearranger communiation options (comp2io) : TRUE implies enable isend
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_REARR_COMM_MAX_PEND_REQ_IO2COMP
    • value = 64
  • Data Type <type> : integer
  • Valid Values <valid_values> :
  • Description <desc> : pio rearranger communication max pending requests (io2comp) : -1 implies no bound on max pending requests
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_REARR_COMM_ENABLE_HS_IO2COMP
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : pio rearranger communiation options (io2comp) : TRUE implies enable handshake
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_REARR_COMM_ENABLE_ISEND_IO2COMP
    • value = TRUE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : pio rearranger communiation options (io2comp) : TRUE implies enable isend
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_DEBUG_LEVEL
    • value = 0
  • Data Type <type> : integer
  • Description <desc> : pio debug level
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_BLOCKSIZE
    • value = -1
  • Data Type <type> : integer
  • Description <desc> : pio blocksize for box decompositions
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_BUFFER_SIZE_LIMIT
    • value = -1
  • Data Type <type> : integer
  • Description <desc> : pio buffer size limit for pnetcdf output
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_TYPENAME
    • value =
  • Data Type <type> : char
  • Values <values> :
    • Value <value component=ATM> pnetcdf
    • Value <value component=CPL> pnetcdf
    • Value <value component=OCN> pnetcdf
    • Value <value component=WAV> pnetcdf
    • Value <value component=GLC> pnetcdf
    • Value <value component=ICE> pnetcdf
    • Value <value component=ROF> pnetcdf
    • Value <value component=LND> pnetcdf
    • Value <value component=ESP> pnetcdf
  • Valid Values <valid_values> : netcdf,pnetcdf,netcdf4p,netcdf4c
  • Description <desc> : pio io type
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_STRIDE
    • value =
  • Data Type <type> : integer
  • Values <values> :
    • Value <value component=ATM> $PES_PER_NODE
    • Value <value component=CPL> $PES_PER_NODE
    • Value <value component=OCN> $PES_PER_NODE
    • Value <value component=WAV> $PES_PER_NODE
    • Value <value component=GLC> $PES_PER_NODE
    • Value <value component=ICE> $PES_PER_NODE
    • Value <value component=ROF> $PES_PER_NODE
    • Value <value component=LND> $PES_PER_NODE
    • Value <value component=ESP> $PES_PER_NODE
  • Description <desc> : stride in compute comm of io tasks for each component, if this value is -99 it will be computed based on PIO_NUMTASKS and number of compute tasks
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_REARRANGER
    • value =
  • Data Type <type> : integer
  • Values <values> :
    • Value <value component=> $PIO_VERSION
    • Value <value component=ATM> $PIO_VERSION
    • Value <value component=CPL> $PIO_VERSION
    • Value <value component=OCN> $PIO_VERSION
    • Value <value component=WAV> $PIO_VERSION
    • Value <value component=GLC> $PIO_VERSION
    • Value <value component=ICE> $PIO_VERSION
    • Value <value component=ROF> $PIO_VERSION
    • Value <value component=LND> $PIO_VERSION
    • Value <value component=ESP> $PIO_VERSION
  • Valid Values <valid_values> : 1,2
  • Description <desc> : pio rearranger choice box=1, subset=2
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_ROOT
    • value =
  • Data Type <type> : integer
  • Values <values> :
    • Value <value component=ATM> 1
    • Value <value component=CPL> 1
    • Value <value component=OCN> 1
    • Value <value component=WAV> 1
    • Value <value component=GLC> 1
    • Value <value component=ICE> 1
    • Value <value component=ROF> 1
    • Value <value component=LND> 1
    • Value <value component=ESP> 1
  • Description <desc> : pio root processor relative to component root
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PIO_NUMTASKS
    • value =
  • Data Type <type> : integer
  • Values <values> :
    • Value <value component=ATM> -99
    • Value <value component=CPL> -99
    • Value <value component=OCN> -99
    • Value <value component=WAV> -99
    • Value <value component=GLC> -99
    • Value <value component=ICE> -99
    • Value <value component=ROF> -99
    • Value <value component=LND> -99
    • Value <value component=ESP> -99
  • Description <desc> : pio number of io tasks, if this value is -99 it will be computed based on PIO_STRIDE and number of tasks

Run Group Settings <group id="run_coupling"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CPL_I2O_PER_CAT
    • value = TRUE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : determine if per ice thickness category fields are passed from ice to ocean - DO NOT EDIT (set by POP build-namelist)
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CCSM_BGC
    • value = CO2C
  • Data Type <type> : char
  • Valid Values <valid_values> : none,CO2A,CO2B,CO2C,CO2_DMSA
  • Description <desc> : Flag to turn on new fields in coupling. If the value is not none, the coupler is compiled so that optional BGC related fields are exchanged between component models.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = NCPL_BASE_PERIOD
    • value = day
  • Data Type <type> : char
  • Valid Values <valid_values> : hour,day,year,decade
  • Description <desc> : Base period associated with NCPL coupling frequency. This xml variable is only used to set the driver namelist variables, atm_cpl_dt, lnd_cpl_dt, ocn_cpl_dt, ice_cpl_dt, glc_cpl_dt, rof_cpl_dt, wav_cpl_dt, and esp_dt.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ATM_NCPL
    • value = 48
  • Data Type <type> : integer
  • Description <desc> : Number of atm coupling intervals per NCPL_BASE_PERIOD. This is used to set the driver namelist atm_cpl_dt, equal to basedt/ATM_NCPL, where basedt is equal to NCPL_BASE_PERIOD in seconds.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LND_NCPL
    • value = $ATM_NCPL
  • Data Type <type> : integer
  • Description <desc> : Number of land coupling intervals per NCPL_BASE_PERIOD. This is used to set the driver namelist atm_cpl_dt, equal to basedt/LND_NCPL, where basedt is equal to NCPL_BASE_PERIOD in seconds.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ICE_NCPL
    • value = $ATM_NCPL
  • Data Type <type> : integer
  • Description <desc> : Number of ice coupling intervals per NCPL_BASE_PERIOD. This is used to set the driver namelist ice_cpl_dt, equal to basedt/ICE_NCPL where basedt is equal to NCPL_BASE_PERIOD in seconds.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN_NCPL
    • value = 24
  • Data Type <type> : integer
  • Description <desc> : Number of ocn coupling intervals per NCPL_BASE_PERIOD. Thisn is used to set the driver namelist ocn_cpl_dt, equal to basedt/OCN_NCPL where basedt is equal to NCPL_BASE_PERIOD in seconds.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GLC_NCPL
    • value = 1
  • Data Type <type> : integer
  • Description <desc> : Number of glc coupling intervals per NCPL_BASE_PERIOD.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GLC_AVG_PERIOD
    • value = yearly
  • Data Type <type> : char
  • Valid Values <valid_values> : glc_coupling_period,yearly
  • Description <desc> : Period at which coupler averages fields sent to GLC. This supports doing the averaging to GLC less frequently than GLC is called (i.e., separating the averaging frequency from the calling frequency). This is useful because there are benefits to only averaging the GLC inputs as frequently as they are really needed (yearly for CISM), but GLC needs to still be called more frequently than that in order to support mid-year restarts. Setting GLC_AVG_PERIOD to 'glc_coupling_period' means that the averaging is done exactly when the GLC is called (governed by GLC_NCPL). IMPORTANT: In order to restart mid-year when running with CISM, you MUST specify GLC_AVG_PERIOD = 'yearly'. If using GLC_AVG_PERIOD = 'glc_coupling_period' with CISM, you can only restart on year boundaries.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = ROF_NCPL
    • value = 8
  • Data Type <type> : integer
  • Description <desc> : Number of rof coupling intervals per NCPL_BASE_PERIOD. This is used to set the driver namelist rof_cpl_dt, equal to basedt/ROF_NCPL where basedt is equal to NCPL_BASE_PERIOD in seconds.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = WAV_NCPL
    • value = $ATM_NCPL
  • Data Type <type> : integer
  • Description <desc> : Number of wav coupling intervals per NCPL_BASE_PERIOD. This is used to set the driver namelist wav_cpl_dt, equal to basedt/WAV_NCPL where basedt is equal to NCPL_BASE_PERIOD in seconds.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CPL_SEQ_OPTION
    • value = RASM_OPTION1
  • Data Type <type> : char
  • Valid Values <valid_values> : CESM1_ORIG,CESM1_ORIG_TIGHT,CESM1_MOD,CESM1_MOD_TIGHT,RASM_OPTION1,RASM_OPTION2
  • Description <desc> : Coupler sequencing option. This is used to set the driver namelist variable cpl_seq_option. CESM1_ORIG is the cesm1.1 implementation. CESM1_MOD includes a cesm1.3 mod that swaps ocean merging and atm/ocn flux computation. RASM_OPTION1 runs prep ocean before the ocean coupling reducing most of the lags and field inconsistency but still allowing the ocean to run concurrently with the ice and atmosphere. RASM_OPTION2 is similar to RASM_OPTION1 but sequences the ice model, prep ocean and ocean model in that order. The ocean model loses some of the concurrency with the ice model. CESM1_ORIG_TIGHT and CESM1_MOD_TIGHT are consistent with the old variables ocean_tight_coupling = true in the driver. That namelist is gone and the cpl_seq_option flags take it's place. TIGHT coupling makes no sense with the OPTION5 and OPTION6 flags.

Run Group Settings <group id="run_drv_history"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = HIST_OPTION
    • value = never
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : Sets driver snapshot history file frequency (like REST_OPTION)
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = HIST_N
    • value = -999
  • Data Type <type> : integer
  • Valid Values <valid_values> :
  • Description <desc> : Sets driver snapshot history file frequency (like REST_N)
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = HIST_DATE
    • value = -999
  • Data Type <type> : integer
  • Valid Values <valid_values> :
  • Description <desc> : yyyymmdd format, sets coupler snapshot history date (like REST_DATE)
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = AVGHIST_OPTION
    • value = never
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : Sets driver average history file frequency (like REST_OPTION)
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = AVGHIST_N
    • value = -999
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : Sets driver average history file frequency (like REST_N)
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = AVGHIST_DATE
    • value = -999
  • Data Type <type> : integer
  • Valid Values <valid_values> :
  • Description <desc> : yyyymmdd format, sets driver average history date (like REST_DATE)

Run Group Settings <group id="external_tools"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = PRERUN_SCRIPT
    • value =
  • Data Type <type> : char
  • Description <desc> : External script to be run before model completion
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = POSTRUN_SCRIPT
    • value =
  • Data Type <type> : char
  • Description <desc> : External script to be run after model completion
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = DATA_ASSIMILATION
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : Run the external tool pointed to by DATA_ASSIMILATION_SCRIPT after the model run completes
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = DATA_ASSIMILATION_CYCLES
    • value = 1
  • Data Type <type> : integer
  • Valid Values <valid_values> :
  • Description <desc> : Number of model run - data assimilation steps to complete
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = DATA_ASSIMILATION_SCRIPT
    • value =
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : External script to be run after model completion

Run Group Settings <group id="run_component_cpl"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CPL_ALBAV
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : Only used for compsets with DATM and POP (currently C, G and J): If true, compute albedos to work with daily avg SW down If false (default), albedos are computed with the assumption that downward solar radiation from the atm component has a diurnal cycle and zenith-angle dependence. This is normally the case when using an active atm component If true, albedos are computed with the assumption that downward solar radiation from the atm component is a daily average quantity and does not have a zenith-angle dependence. This is often the case when using a data atm component. Only used for compsets with DATM and POP (currently C, G and J). NOTE: This should really depend on the datm forcing and not the compset per se. So, for example, whether it is set in a J compset should depend on what datm forcing is used.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CPL_EPBAL
    • value = off
  • Data Type <type> : char
  • Valid Values <valid_values> : off,ocn
  • Description <desc> : Only used for compsets with DATM and POP (currently C, G and J): If ocn, ocn provides EP balance factor for precipitation. Provides EP balance factor for precip for POP. A factor computed by POP is applied to precipitation so that precipitation balances evaporation and ocn global salinity does not drift. This is intended for use when coupling POP to a DATM. Only used for C, G and J compsets. Default is off

Run Group Settings <group id="run_budgets"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = BUDGETS
    • value = TRUE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : logical that turns on diagnostic budgets for driver

Run Group Settings <group id="run_co2"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CCSM_CO2_PPMV
    • value = 284.7
  • Data Type <type> : real
  • Valid Values <valid_values> :
  • Description <desc> : Mechanism for setting the CO2 value in ppmv for CLM if CLM_CO2_TYPE is constant or for POP if OCN_CO2_TYPE is constant.

Run Group Settings <group id="run_glc"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GLC_NEC
    • value = 10
  • Data Type <type> : integer
  • Valid Values <valid_values> : 0,1,3,5,10,36
  • Description <desc> : Glacier model number of elevation classes, 0 implies no glacier land unit in clm Used by both CLM and CISM (even if CISM is not running, and only SGLC is used).
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = GLC_TWO_WAY_COUPLING
    • value = TRUE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : Whether the glacier component feeds back to the rest of the system This affects: (1) Whether CLM updates its areas based on glacier areas sent from GLC (2) Whether GLC sends fluxes (e.g., calving fluxes) to the coupler Note that this is set to TRUE by default for TG compsets - even though there are no feedbacks for TG compsets, this enables extra coupler diagnostics for these compsets.

Run Group Settings <group id="run_physics"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = TFREEZE_SALTWATER_OPTION
    • value = mushy
  • Data Type <type> : char
  • Valid Values <valid_values> : minus1p8,linear_salt,mushy
  • Description <desc> : Freezing point calculation for salt water.

Run Group Settings <group id="run_component_cam"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CAM_NML_USE_CASE
    • value = hist_cam6
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : CAM namelist use_case. Provides the use_case option for the CAM build-namelist utility (which is called from $CASEROOT/Buildconf/cam.buildnml). The CAM build-namelist leverages groups of namelist options (use cases) that are often paired with the CAM configure options. These use cases are xml files located in $CIMEROOT/../components/atm/cam/bld/namelist_files/use_cases. In general, this variable should not be modified for supported component sets (compsets). Recommendation: If you want to modify this value for your experiment, use your own user-defined component sets.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CAM_NAMELIST_OPTS
    • value = co2_cycle_rad_passive=.true.
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : CAM specific namelist settings for -namelist option Provides options to the -namelist argument for the CAM build-namelist utility. This should be reserved for component set specification. Users should modify CAM namelists only via the $CASEROOT/user_nl_cam file.

Run Group Settings <group id="run_component_clm"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = LND_TUNING_MODE
    • value = clm5_0_cam5.5
  • Data Type <type> : char
  • Valid Values <valid_values> : clm4_0_default,clm5_0_cam5.5,clm5_0_GSW3P,clm4_5_CRUNCEP
  • Description <desc> : Tuning parameters should be optimized for what CLM model version and what meteorlogical forcing combination?
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CLM_NML_USE_CASE
    • value = 20thC_glacierMEC_transient
  • Data Type <type> : char
  • Description <desc> : CLM namelist use_case. Determines the use-case that will be sent to the CLM build-namelist utility. This is normally set by the component set. This is an advanced flag and should only be used by expert users.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CLM_BLDNML_OPTS
    • value = -bgc bgc
  • Data Type <type> : char
  • Description <desc> : CLM build-namelist options
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CLM_CO2_TYPE
    • value = diagnostic
  • Data Type <type> : char
  • Valid Values <valid_values> : constant,diagnostic,prognostic
  • Description <desc> : Determines how CLM will determine where CO2 is set. If value is constant, it will be set to CCSM_CO2_PPMV, if value is either diagnostic or prognostic, the atmosphere model MUST send it to CLM. CLM_CO2_TYPE is normally set by the specific compset, since it HAS to be coordinated with settings for the atmospheric model. Do not modify this variable. If you want to modify for your experiment, use your own user-defined component set This is an advanced flag and should only be used by expert users.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CLM_NAMELIST_OPTS
    • value =
  • Data Type <type> : char
  • Description <desc> : CLM-specific namelist settings for -namelist option in the CLM build-namelist. CLM_NAMELIST_OPTS is normally set as a compset variable and in general should not be modified for supported compsets. It is recommended that if you want to modify this value for your experiment, you should use your own user-defined component sets via using create_newcase with a compset_file argument. This is an advanced flag and should only be used by expert users.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CLM_ACCELERATED_SPINUP
    • value = off
  • Data Type <type> : char
  • Valid Values <valid_values> : on,off
  • Description <desc> : Turn on any settings for accellerating the model spinup.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CLM_USRDAT_NAME
    • value = UNSET
  • Data Type <type> : char
  • Description <desc> : Dataset name for user-created datasets. This is used as the argument in Buildconf/clm.buildnml to build-namelist -clm_usr_name. An example of such a dataset would be 1x1pt_boulderCO_c090722. The default value is UNSET. This is an advanced flag and should only be used by expert users.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CLM_FORCE_COLDSTART
    • value = off
  • Data Type <type> : char
  • Valid Values <valid_values> : on,off
  • Description <desc> : Flag to the CLM build-namelist command to force CLM to do a cold start (finidat will be set to blanks). A value of on forces the model to spin up from a cold-start (arbitrary initial conditions). Setting this value in the xml file will take precedence over any settings for finidat in the $CASEROOT/user_clm_clm file.

Run Group Settings <group id="run_component_cice"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CICE_NAMELIST_OPTS
    • value =
  • Data Type <type> : char
  • Description <desc> : CICE specific namelist settings for -namelist option

Run Group Settings <group id="run_component_pop"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN_CHL_TYPE
    • value = prognostic
  • Data Type <type> : char
  • Valid Values <valid_values> : diagnostic,prognostic
  • Description <desc> : Determines provenance of surface Chl for radiative penetration, computations. This option is used in the POP ecosystem model. The default is diagnostic.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN_TAVG_TRACER_BUDGET
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : tavg output control for tracer-budget terms
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN_TAVG_HIFREQ
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : tavg output control for high-frequency output
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN_ONEDIM
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : TRUE turns off all horizontal motion in POP (single column)
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN_TRANSIENT
    • value = 1850-2000
  • Data Type <type> : char
  • Valid Values <valid_values> : unset,1850-2000,rcp4.5,rcp8.5
  • Description <desc> : Determine settings for transient forcing datasets (e.g., atmospheric pCFC concentrations). The create_newcase command selects the appropriate setting for this variable based on the specified compset. This option is used in the POP ecosystem model. Users should NOT EDIT this setting.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN_ICE_FORCING
    • value = active
  • Data Type <type> : char
  • Valid Values <valid_values> : active,inactive
  • Description <desc> : Determine under-ice forcing settings. The active option yields settings that are appropriate for coupling to an active ice model (e.g., a B or G-type compset). The inactive option yields settings that are appropriate for coupling to a data ice model (e.g., a C-type compset). The create_newcase command selects the appropriate setting for this variable based on the specified compset. Users should NOT EDIT this setting.
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = OCN_CO2_TYPE
    • value = diagnostic
  • Data Type <type> : char
  • Valid Values <valid_values> : constant,prognostic,diagnostic
  • Description <desc> : Determines provenance of atmospheric CO2 for gas flux computation. This option is used in the POP ecosystem model. The default is constant.

Run Group Settings <group id="run_component_mosart"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = MOSART_SIMYR
    • value = 1850
  • Data Type <type> : char
  • Valid Values <valid_values> :
  • Description <desc> : MOSART build-namelist options

Run Group Settings <group id="run_component_cism"> :

Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CISM_PHYS
    • value = cism2
  • Data Type <type> : char
  • Valid Values <valid_values> : cism1,cism2
  • Description <desc> : Version of CISM physics/dynamics to use
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CISM_EVOLVE
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : Whether CISM ice evolution is on or off
Entry ID/Value Definitions <entry> :
  • Attributes :
    • id = CISM_OBSERVED_IC
    • value = FALSE
  • Data Type <type> : logical
  • Valid Values <valid_values> : TRUE,FALSE
  • Description <desc> : For hybrid runs, whether CISM should use observed initial conditions instead of restart file. For hybrid runs, a value of FALSE (default) implies that CISM should use the restart file from the reference case; a value of TRUE implies that CISM should instead use the observed initial conditions that are generally used for startup runs. This variable is ignored for startup runs; for branch runs, it MUST BE FALSE.