env_run.xml

<?xml version="1.0"?>
<file id="env_run.xml" version="2.0">
  <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.
    </header>
  <group id="run_coupling">
    <entry id="COUPLING_MODE" value="cesm">
      <type>char</type>
      <valid_values>cesm</valid_values>
      <desc>coupling mode</desc>
    </entry>
    <entry id="CPL_I2O_PER_CAT" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>determine if per ice thickness category fields are passed from ice to ocean - DO NOT EDIT (set by POP build-namelist)</desc>
    </entry>
    <entry id="ADD_AOFLUX_TO_RUNSEQ" value="TRUE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>add aoflux calculation to runseq</desc>
    </entry>
    <entry id="CCSM_BGC" value="none">
      <type>char</type>
      <valid_values>none,CO2A,CO2B,CO2C</valid_values>
      <desc>Activates additional CO2-related fields to be exchanged between components. Possible values are:

    CO2A: sets the driver namelist variable flds_co2a = .true.; this adds
    prognostic CO2 and diagnostic CO2 at the lowest model level to be sent from
    the atmosphere to the land and ocean.

    CO2B: sets the driver namelist variable flds_co2b = .true.; this adds
    prognostic CO2 and diagnostic CO2 at the lowest model level to be sent from
    the atmosphere just to the land, and the surface upward flux of CO2 to be
    sent from the land back to the atmosphere

    CO2C: sets the driver namelist variable flds_co2c = .true.; this adds
    prognostic CO2 and diagnostic CO2 at the lowest model level to be sent from
    the atmosphere to the land and ocean, and the surface upward flux of CO2
    to be sent from the land and the open ocean back to the atmosphere.

    The namelist variables flds_co2a, flds_co2b and flds_co2c are in the
    namelist group cpl_flds_inparm.
    </desc>
    </entry>
    <entry id="DMS_EMIS_OCN" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>
      Activates DMS fluxes to be sent from ocn to atm.
      Currently this is only available with BLOM ocean component.
    </desc>
    </entry>
    <entry id="BRF_EMIS_OCN" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>
      Activates Bromoform fluxes to be sent from ocn to atm.
      Currently this is only available with BLOM ocean component.
    </desc>
    </entry>
    <entry id="N2O_EMIS_OCN" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>
      Activates N2O fluxes to be sent from ocn to atm.
      Currently this is only available with BLOM ocean component.
    </desc>
    </entry>
    <entry id="NH3_EMIS_OCN" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>
      Activates NH3 fluxes to be sent from ocn to atm.
      Currently this is only available with BLOM ocean component.
    </desc>
    </entry>
    <entry id="NCPL_BASE_PERIOD" value="day">
      <type>char</type>
      <valid_values>hour,day,year,decade</valid_values>
      <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.</desc>
    </entry>
    <entry id="ATM_NCPL" value="48">
      <type>integer</type>
      <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.</desc>
    </entry>
    <entry id="LND_NCPL" value="$ATM_NCPL">
      <type>integer</type>
      <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.</desc>
    </entry>
    <entry id="ICE_NCPL" value="$ATM_NCPL">
      <type>integer</type>
      <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.</desc>
    </entry>
    <entry id="OCN_NCPL" value="$ATM_NCPL">
      <type>integer</type>
      <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.</desc>
    </entry>
    <entry id="GLC_NCPL" value="$ATM_NCPL">
      <type>integer</type>
      <desc>Number of glc coupling intervals per NCPL_BASE_PERIOD.</desc>
    </entry>
    <entry id="GLC_AVG_PERIOD" value="yearly">
      <type>char</type>
      <valid_values>glc_coupling_period,yearly</valid_values>
      <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.
    </desc>
    </entry>
    <entry id="ROF_NCPL" value="$ATM_NCPL">
      <type>integer</type>
      <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.</desc>
    </entry>
    <entry id="WAV_NCPL" value="$ATM_NCPL">
      <type>integer</type>
      <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.</desc>
    </entry>
    <entry id="CPL_SEQ_OPTION" value="OPTION2">
      <type>char</type>
      <valid_values>TIGHT,OPTION1,OPTION2</valid_values>
      <desc>
      OPTION1 (like RASM_OPTION1 in CPL7) runs prep_ocn_avg,
      BEFORE the aoflux and ocnalb calculations, thereby reducing
      most of the lags and field inconsistency but still allowing the
      ocean to run concurrently with the ice and atmosphere.
      OPTION2 (like CESM1_MOD in CPL7) runs prep_ocn_avg,
      AFTER the aoflux and ocnalb calculations, thereby permitting maximum
      concurrency
      TIGHT (like CESM1_MOD_TIGHT), is a tight coupling run sequence
    </desc>
    </entry>
  </group>
  <group id="run_desc">
    <entry id="LOGDIR" value="$CASEROOT/logs">
      <type>char</type>
      <desc>Extra copies of the component log files will be saved here.</desc>
    </entry>
    <entry id="CASESTR" value="UNSET">
      <type>char</type>
      <desc>case description</desc>
    </entry>
    <entry id="RUNDIR" value="$CIME_OUTPUT_ROOT/$CASE/run">
      <type>char</type>
      <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
    </desc>
    </entry>
  </group>
  <group id="run_begin_stop_restart">
    <entry id="RUN_TYPE" value="startup">
      <type>char</type>
      <valid_values>startup,hybrid,branch</valid_values>
      <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.
    </desc>
    </entry>
    <entry id="RUN_REFDIR" value="ccsm4_init">
      <type>char</type>
      <desc>
      Reference directory containing RUN_REFCASE data - used for hybrid or branch runs
    </desc>
    </entry>
    <entry id="RUN_REFCASE" value="case.std">
      <type>char</type>
      <desc>
      Reference case for hybrid or branch runs
    </desc>
    </entry>
    <entry id="RUN_REFDATE" value="0001-01-01">
      <type>char</type>
      <desc>
      Reference date for hybrid or branch runs (yyyy-mm-dd)
    </desc>
    </entry>
    <entry id="RUN_REFTOD" value="00000">
      <type>char</type>
      <desc>
      Reference time of day (seconds) for hybrid or branch runs (sssss)
    </desc>
    </entry>
    <entry id="GET_REFCASE" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>
      Flag for automatically prestaging the refcase restart dataset.
      If TRUE, then the refcase data is prestaged into the executable directory
    </desc>
    </entry>
    <entry id="RUN_STARTDATE" value="0001-01-01">
      <type>char</type>
      <desc>
      Run start date (yyyy-mm-dd). Only used for startup or hybrid runs.
    </desc>
    </entry>
    <entry id="START_TOD" value="0">
      <type>integer</type>
      <desc>
      Run start time-of-day
    </desc>
    </entry>
    <entry id="STOP_OPTION" value="ndays">
      <type>char</type>
      <valid_values>none,never,nsteps,nseconds,nminutes,nhours,ndays,nmonths,nyears,date,end</valid_values>
      <desc>
      Sets the run length along with STOP_N and STOP_DATE
    </desc>
    </entry>
    <entry id="STOP_N" value="5">
      <type>integer</type>
      <desc>
      Provides a numerical count for $STOP_OPTION.
    </desc>
    </entry>
    <entry id="STOP_DATE" value="-999">
      <type>integer</type>
      <desc>
      Alternative date yyyymmdd date option, sets the run length with STOP_OPTION and STOP_N
      negative value implies off
    </desc>
    </entry>
    <entry id="REST_OPTION" value="$STOP_OPTION">
      <type>char</type>
      <valid_values>none,never,nsteps,nseconds,nminutes,nhours,ndays,nmonths,nyears,date,end</valid_values>
      <desc>
      sets frequency of model restart writes (same options as STOP_OPTION)
    </desc>
    </entry>
    <entry id="REST_N" value="$STOP_N">
      <type>integer</type>
      <desc>
      sets model restart writes with REST_OPTION and REST_DATE
    </desc>
    </entry>
    <entry id="REST_DATE" value="$STOP_DATE">
      <type>char</type>
      <desc>
      Alternative date in yyyymmdd format
      sets model restart write date with REST_OPTION and REST_N
    </desc>
    </entry>
    <entry id="PAUSE_OPTION" value="never">
      <type>char</type>
      <valid_values>none,never,nsteps,nseconds,nminutes,nhours,ndays,nmonths,nyears</valid_values>
      <desc>
      Sets the pause frequency along with PAUSE_N
    </desc>
    </entry>
    <entry id="PAUSE_N" value="0">
      <type>integer</type>
      <desc>
      Provides a numerical count for $PAUSE_OPTION.
    </desc>
    </entry>
    <entry id="PAUSE_ACTIVE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>
      Pause the model at times specified by PAUSE_OPTION and PAUSE_N.
      Components 'pause' by writing a restart file.
    </desc>
      <values>
        <value compclass="ATM">FALSE</value>
        <value compclass="CPL">FALSE</value>
        <value compclass="OCN">FALSE</value>
        <value compclass="WAV">FALSE</value>
        <value compclass="GLC">FALSE</value>
        <value compclass="ICE">FALSE</value>
        <value compclass="ROF">FALSE</value>
        <value compclass="LND">FALSE</value>
      </values>
    </entry>
    <entry id="ESP_RUN_ON_PAUSE" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>
      ESP component runs after driver 'pause cycle' If any component
      'pauses' (see PAUSE_OPTION,
      PAUSE_N and PAUSE_ACTIVE_XXX 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
    </desc>
    </entry>
    <entry id="CONTINUE_RUN" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <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.
    </desc>
    </entry>
    <entry id="MEDIATOR_READ_RESTART" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>
      A setting of TRUE implies a continuation run for mediator only
    </desc>
    </entry>
    <entry id="RESUBMIT" value="0">
      <type>integer</type>
      <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.
    </desc>
    </entry>
    <entry id="RESUBMIT_SETS_CONTINUE_RUN" value="TRUE">
      <type>logical</type>
      <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.
    </desc>
    </entry>
    <entry id="RUN_WITH_SUBMIT" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>Logical to determine whether run has been submitted with the submit script or not</desc>
    </entry>
    <entry id="JOB_IDS">
      <type>char</type>
      <desc>List of job ids for most recent case.submit</desc>
    </entry>
    <entry id="JOB_PRIORITY" value="regular">
      <type>char</type>
      <valid_values>regular,premium,economy</valid_values>
      <desc>job priority for systems supporting this option</desc>
    </entry>
  </group>
  <group id="run_data_archive">
    <entry id="DOUT_S" value="TRUE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>Logical to turn on short term archiving.
    If TRUE, short term archiving will be turned on.</desc>
    </entry>
    <entry id="SYSLOG_N" value="900">
      <type>integer</type>
      <desc>system workload snapshot frequency (in seconds, if greater than 0; disabled otherwise)</desc>
    </entry>
    <entry id="DOUT_S_SAVE_INTERIM_RESTART_FILES" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <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.</desc>
    </entry>
  </group>
  <group id="build_def">
    <entry id="GMAKE" value="gmake">
      <type>char</type>
      <valid_values/>
      <desc>GNU make command</desc>
    </entry>
    <entry id="GMAKE_J" value="16">
      <type>integer</type>
      <valid_values/>
      <desc>Number of processors for gmake</desc>
    </entry>
  </group>
  <group id="run_flags">
    <entry id="CHECK_TIMING" value="TRUE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>logical to diagnose model timing at the end of the run</desc>
    </entry>
    <entry id="PROFILE_PAPI_ENABLE" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>Enables the papi hardware counters in gptl
    The papi library must be included in the build step for
    this to work.</desc>
    </entry>
    <entry id="ESMF_VERBOSITY_LEVEL" value="off">
      <type>char</type>
      <valid_values>off,low,high,max</valid_values>
      <desc>
      Determines the verbosity level in ESMF log files
      "off": no verbosity
      "low": some verbosity
      "high": more verbosity
      "max": all lower 16 bits
      By default, the verbosity level is set to "off"
    </desc>
    </entry>
    <entry id="ESMF_PROFILING_LEVEL" value="0">
      <type>char</type>
      <desc>
      Determines the profiling level in ESMF log files
      by default, it is set to 0 (only run method execution timings)
    </desc>
    </entry>
    <entry id="COMP_RUN_BARRIERS" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <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.
    </desc>
    </entry>
    <entry id="INFO_DBUG" value="1">
      <type>integer</type>
      <valid_values>0,1,2,3,4,5,6,7,8,9</valid_values>
      <desc>level of debug output, 0=minimum, 1=normal, 2=more, 3=too much</desc>
    </entry>
    <entry id="BFBFLAG" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>turns on coupler bit-for-bit reproducibility with varying pe counts</desc>
    </entry>
    <entry id="SAVE_TIMING" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>logical to save timing files in rundir</desc>
    </entry>
    <entry id="TPROF_TOTAL" value="0">
      <type>integer</type>
      <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
    </desc>
    </entry>
    <entry id="TIMER_DETAIL" value="2">
      <type>integer</type>
      <desc>
    integer indicating maximum detail level to profile. This xml
    variable is used to set the namelist variable
    timing_detail_limit. This namelist variable is used by perf_mod
    (in $CIMEROOT/src/share/timing/perf_mod.F90) to turn timers off
    and on depending on calls to the routine t_adj_detailf. If in the
    code a statement appears like t_adj_detailf(+1), then the current
    timer detail level is incremented by 1 and compared to the
    time_detail_limit obtained from the namelist.  If the limit is
    exceeded then the timer is turned off.
    </desc>
    </entry>
    <entry id="TIMER_LEVEL" value="4">
      <type>integer</type>
      <desc>Maximum code stack depth of enabled timers.</desc>
    </entry>
    <entry id="FLDS_WISO" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>Turn on the passing of water isotope fields through the coupler</desc>
    </entry>
  </group>
  <group id="run_domain">
    <entry id="PTS_LAT" value="-999.99">
      <type>real</type>
      <desc>Latitude of grid location, in single column mode interpolate datasets to this location
          in single point mode assume all datasets are at this location</desc>
    </entry>
    <entry id="PTS_LON" value="-999.99">
      <type>real</type>
      <desc>Longitude of grid location, in single column mode interpolate datasets to this location
          in single point mode assume all datasets are at this location</desc>
    </entry>
    <entry id="PTS_DOMAINFILE" value="$DIN_LOC_ROOT/share/domains/domain.lnd.fv1.9x2.5_gx1v7.181205.nc">
      <type>char</type>
      <desc>used only if if PTS_LAT and PTS_LON are greater than or
          equal to 0.  If this is the case then if PTS_DOMAINFILE is not
          equal to UNSET a nearest neighbor search of PTS_DOMAINFILE using
          PTS_LAT and PTS_LON will be done and the component mesh will have
          this nearest neighbor value. </desc>
    </entry>
    <entry id="LND_DOMAIN_FILE" value="UNSET">
      <type>char</type>
      <desc>lnd domain file</desc>
    </entry>
    <entry id="LND_DOMAIN_PATH" value="$DIN_LOC_ROOT/share/domains">
      <type>char</type>
      <desc>path of lnd domain file</desc>
    </entry>
    <entry id="ATM_DOMAIN_MESH" value="$DIN_LOC_ROOT/share/meshes/fv1.9x2.5_141008_ESMFmesh.nc">
      <type>char</type>
      <desc>atm mesh file (full pathname)</desc>
    </entry>
    <entry id="LND_DOMAIN_MESH" value="$DIN_LOC_ROOT/share/meshes/fv1.9x2.5_141008_ESMFmesh.nc">
      <type>char</type>
      <desc>lnd mesh file (full pathname)</desc>
    </entry>
    <entry id="ROF_DOMAIN_MESH" value="$DIN_LOC_ROOT/share/meshes/r05_nomask_c110308_ESMFmesh.nc">
      <type>char</type>
      <desc>rof mesh file (full pathname)</desc>
    </entry>
    <entry id="WAV_DOMAIN_MESH" value="$DIN_LOC_ROOT/share/meshes/ww3a_120222_ESMFmesh.nc">
      <type>char</type>
      <desc>wav mesh file (full pathname)</desc>
    </entry>
    <entry id="ICE_DOMAIN_MESH" value="$DIN_LOC_ROOT/share/meshes/gx1v7_151008_ESMFmesh.nc">
      <type>char</type>
      <desc>ice mesh file (full pahtname)</desc>
    </entry>
    <entry id="OCN_DOMAIN_MESH" value="$DIN_LOC_ROOT/share/meshes/gx1v7_151008_ESMFmesh.nc">
      <type>char</type>
      <desc>ocn mesh file (full pathname)</desc>
    </entry>
    <entry id="GLC_DOMAIN_MESH" value="$DIN_LOC_ROOT/share/meshes/greenland_4km_epsg3413_c170414_ESMFmesh_c20190729.nc">
      <type>char</type>
      <desc>glc mesh file (full pathname)</desc>
    </entry>
    <entry id="MASK_MESH" value="$DIN_LOC_ROOT/share/meshes/gx1v7_151008_ESMFmesh.nc">
      <type>char</type>
      <desc>mask mesh file (full pathname)</desc>
    </entry>
    <entry id="LND2ROF_FMAPNAME" value="unset">
      <type>char</type>
      <desc>lnd2rof flux mapping file</desc>
    </entry>
    <entry id="ROF2LND_FMAPNAME" value="unset">
      <type>char</type>
      <desc>rof2lnd flux mapping file</desc>
    </entry>
    <entry id="ROF2OCN_LIQ_RMAPNAME" value="cpl/gridmaps/r05/map_r05_to_gx1v7_nn_open_ocean_nnsm_e1000r300_marginal_sea_170413.nc">
      <type>char</type>
      <desc>rof2ocn runoff mapping file</desc>
    </entry>
    <entry id="ROF2OCN_ICE_RMAPNAME" value="cpl/gridmaps/r05/map_r05_to_gx1v7_nnsm_e1000r300_170413.nc">
      <type>char</type>
      <desc>rof2ocn runoff mapping file</desc>
    </entry>
    <entry id="EPS_FRAC" value="1.0e-02">
      <type>char</type>
      <desc>Error tolerance for differences in fractions in domain checking</desc>
    </entry>
    <entry id="EPS_AAREA" value="9.0e-07">
      <type>real</type>
      <desc>Error tolerance for differences in atm/land areas in domain checking</desc>
    </entry>
    <entry id="EPS_AMASK" value="1.0e-13">
      <type>real</type>
      <desc>Error tolerance for differences in atm/land masks in domain checking</desc>
    </entry>
    <entry id="EPS_AGRID" value="1.0e-12">
      <type>real</type>
      <desc>Error tolerance for differences in atm/land lat/lon in domain checking</desc>
    </entry>
    <entry id="EPS_OAREA" value="1.0e-01">
      <type>real</type>
      <desc>Error tolerance for differences in ocean/ice lon/lat in domain checking</desc>
    </entry>
    <entry id="EPS_OMASK" value="1.0e-06">
      <type>real</type>
      <desc>Error tolerance for differences in ocean/ice lon/lat in domain checking</desc>
    </entry>
    <entry id="EPS_OGRID" value="1.0e-02">
      <type>real</type>
      <desc>Error tolerance for differences in ocean/ice lon/lat in domain checking</desc>
    </entry>
  </group>
  <group id="run_din">
    <entry id="NODENAME_REGEX" value="UNSET">
      <type>char</type>
      <desc>
      A regular expression to match machine node names to ACME machine.
    </desc>
    </entry>
    <entry id="NODE_FAIL_REGEX">
      <type>char</type>
      <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.
    </desc>
    </entry>
    <entry id="PROXY" value="UNSET">
      <type>char</type>
      <desc>
      Proxy (if any) setting for http_proxy to allow web access on this machine.
    </desc>
    </entry>
    <entry id="TEST" value="FALSE">
      <type>logical</type>
      <desc>
      Indicates to case.submit that this is a test case.
    </desc>
    </entry>
    <entry id="DIN_LOC_ROOT" value="$ENV{CESMDATAROOT}/inputdata">
      <type>char</type>
      <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
    </desc>
    </entry>
    <entry id="DIN_LOC_ROOT_CLMFORC" value="$ENV{CESMDATAROOT}/inputdata/atm/datm7">
      <type>char</type>
      <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</desc>
    </entry>
    <entry id="DIN_STAGING_ROOT" value="UNSET">
      <type>char</type>
      <desc>
      On some systems the filesystem of DIN_LOC_ROOT is not available on compute nodes and
      data must be staged to a temporary location.  If this variable is defined it will
      be used as the root directory of an inputdata staging area.
      Default values for the target machine are in the
      $CIMEROOT/machines/config_machines.xml
    </desc>
    </entry>
  </group>
  <group id="run_dout">
    <entry id="DOUT_S_ROOT" value="$CIME_OUTPUT_ROOT/archive/$CASE">
      <type>char</type>
      <desc>Root directory for short term archiving. This directory must be visible to compute nodes.</desc>
    </entry>
  </group>
  <group id="run_mpi">
    <entry id="MPI_RUN_COMMAND" value="UNSET">
      <type>char</type>
      <desc>override the mpi run command, do not include model executable</desc>
    </entry>
  </group>
  <group id="run_pio">
    <entry id="PIO_REARR_COMM_TYPE" value="p2p">
      <type>char</type>
      <valid_values>p2p,coll,default</valid_values>
      <desc>pio rearranger communication type</desc>
    </entry>
    <entry id="PIO_REARR_COMM_FCD" value="2denable">
      <type>char</type>
      <valid_values>2denable,io2comp,comp2io,disable,default</valid_values>
      <desc>pio rearranger communication flow control direction</desc>
    </entry>
    <entry id="PIO_REARR_COMM_MAX_PEND_REQ_COMP2IO" value="-2">
      <type>integer</type>
      <valid_values/>
      <desc>pio rearranger communication max pending requests (io2comp) :
       -2 implies that CIME internally calculates the value ( = 64),
       -1 implies no bound on max pending requests
        0 implies that MPI_ALLTOALL will be used
    </desc>
    </entry>
    <entry id="PIO_REARR_COMM_ENABLE_HS_COMP2IO" value="TRUE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>pio rearranger communiation options (comp2io) : TRUE implies enable handshake </desc>
    </entry>
    <entry id="PIO_REARR_COMM_ENABLE_ISEND_COMP2IO" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>pio rearranger communiation options (comp2io) : TRUE implies enable isend</desc>
    </entry>
    <entry id="PIO_REARR_COMM_MAX_PEND_REQ_IO2COMP" value="64">
      <type>integer</type>
      <valid_values/>
      <desc>pio rearranger communication max pending requests (io2comp) : -1 implies no bound on max pending requests </desc>
    </entry>
    <entry id="PIO_REARR_COMM_ENABLE_HS_IO2COMP" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>pio rearranger communiation options (io2comp) : TRUE implies enable handshake</desc>
    </entry>
    <entry id="PIO_REARR_COMM_ENABLE_ISEND_IO2COMP" value="TRUE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>pio rearranger communiation options (io2comp) : TRUE implies enable isend</desc>
    </entry>
    <entry id="PIO_DEBUG_LEVEL" value="0">
      <type>integer</type>
      <desc>pio debug level</desc>
    </entry>
    <entry id="PIO_BLOCKSIZE" value="-1">
      <type>integer</type>
      <desc>pio blocksize for box decompositions</desc>
    </entry>
    <entry id="PIO_BUFFER_SIZE_LIMIT" value="-1">
      <type>integer</type>
      <desc>pio buffer size limit for pnetcdf output</desc>
    </entry>
    <entry id="PIO_ASYNC_INTERFACE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>TRUE implies perform asynchronous i/o</desc>
      <values>
        <value compclass="ATM">FALSE</value>
        <value compclass="CPL">FALSE</value>
        <value compclass="OCN">FALSE</value>
        <value compclass="WAV">FALSE</value>
        <value compclass="GLC">FALSE</value>
        <value compclass="ICE">FALSE</value>
        <value compclass="ROF">FALSE</value>
        <value compclass="LND">FALSE</value>
        <value compclass="ESP">FALSE</value>
      </values>
    </entry>
    <entry id="PIO_TYPENAME">
      <type>char</type>
      <valid_values>netcdf,pnetcdf,netcdf4p,netcdf4c,default</valid_values>
      <desc>pio io type</desc>
      <values>
        <value compclass="ATM">pnetcdf</value>
        <value compclass="CPL">pnetcdf</value>
        <value compclass="OCN">pnetcdf</value>
        <value compclass="WAV">pnetcdf</value>
        <value compclass="GLC">pnetcdf</value>
        <value compclass="ICE">pnetcdf</value>
        <value compclass="ROF">pnetcdf</value>
        <value compclass="LND">pnetcdf</value>
        <value compclass="ESP">pnetcdf</value>
      </values>
    </entry>
    <entry id="PIO_NETCDF_FORMAT">
      <type>char</type>
      <valid_values>classic,64bit_offset,64bit_data</valid_values>
      <desc>pio netcdf format (ignored for netcdf4p and netcdf4c)
    https://www.unidata.ucar.edu/software/netcdf/docs/data_type.html
    </desc>
      <values>
        <value compclass="ATM">64bit_offset</value>
        <value compclass="CPL">64bit_offset</value>
        <value compclass="OCN">64bit_offset</value>
        <value compclass="WAV">64bit_offset</value>
        <value compclass="GLC">64bit_offset</value>
        <value compclass="ICE">64bit_offset</value>
        <value compclass="ROF">64bit_offset</value>
        <value compclass="LND">64bit_offset</value>
        <value compclass="ESP">64bit_offset</value>
      </values>
    </entry>
    <entry id="PIO_STRIDE">
      <type>integer</type>
      <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
    </desc>
      <values>
        <value compclass="ATM">$MAX_MPITASKS_PER_NODE</value>
        <value compclass="CPL">$MAX_MPITASKS_PER_NODE</value>
        <value compclass="OCN">$MAX_MPITASKS_PER_NODE</value>
        <value compclass="WAV">$MAX_MPITASKS_PER_NODE</value>
        <value compclass="GLC">$MAX_MPITASKS_PER_NODE</value>
        <value compclass="ICE">$MAX_MPITASKS_PER_NODE</value>
        <value compclass="ROF">$MAX_MPITASKS_PER_NODE</value>
        <value compclass="LND">$MAX_MPITASKS_PER_NODE</value>
        <value compclass="ESP">$MAX_MPITASKS_PER_NODE</value>
      </values>
    </entry>
    <entry id="PIO_REARRANGER">
      <type>integer</type>
      <valid_values>1,2</valid_values>
      <desc>pio rearranger choice box=1, subset=2 </desc>
      <values>
        <value compclass="ATM">2</value>
        <value compclass="CPL">2</value>
        <value compclass="OCN">2</value>
        <value compclass="WAV">2</value>
        <value compclass="GLC">2</value>
        <value compclass="ICE">2</value>
        <value compclass="ROF">2</value>
        <value compclass="LND">2</value>
        <value compclass="ESP">2</value>
      </values>
    </entry>
    <entry id="PIO_ROOT">
      <type>integer</type>
      <desc>pio root processor relative to component root</desc>
      <values>
        <value compclass="ATM">1</value>
        <value compclass="CPL">1</value>
        <value compclass="OCN">1</value>
        <value compclass="WAV">1</value>
        <value compclass="GLC">1</value>
        <value compclass="ICE">1</value>
        <value compclass="ROF">1</value>
        <value compclass="LND">1</value>
        <value compclass="ESP">1</value>
      </values>
    </entry>
    <entry id="PIO_NUMTASKS">
      <type>integer</type>
      <desc>
      pio number of io tasks, if this value is -99 it will be computed based on PIO_STRIDE and
      number of tasks
    </desc>
      <values>
        <value compclass="ATM">-99</value>
        <value compclass="CPL">-99</value>
        <value compclass="OCN">-99</value>
        <value compclass="WAV">-99</value>
        <value compclass="GLC">-99</value>
        <value compclass="ICE">-99</value>
        <value compclass="ROF">-99</value>
        <value compclass="LND">-99</value>
        <value compclass="ESP">-99</value>
      </values>
    </entry>
  </group>
  <group id="external_tools">
    <entry id="PRERUN_SCRIPT">
      <type>char</type>
      <desc>External script to be run before model completion</desc>
    </entry>
    <entry id="POSTRUN_SCRIPT">
      <type>char</type>
      <desc>External script to be run after model completion</desc>
    </entry>
    <entry id="DATA_ASSIMILATION">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc> Run the external tool pointed to by DATA_ASSIMILATION_SCRIPT after the model run completes </desc>
      <values>
        <value compclass="ATM">FALSE</value>
        <value compclass="CPL">FALSE</value>
        <value compclass="OCN">FALSE</value>
        <value compclass="WAV">FALSE</value>
        <value compclass="GLC">FALSE</value>
        <value compclass="ICE">FALSE</value>
        <value compclass="ROF">FALSE</value>
        <value compclass="LND">FALSE</value>
      </values>
    </entry>
    <entry id="DATA_ASSIMILATION_CYCLES" value="1">
      <type>integer</type>
      <valid_values/>
      <desc> Number of model run - data assimilation steps to complete </desc>
    </entry>
    <entry id="DATA_ASSIMILATION_SCRIPT">
      <type>char</type>
      <valid_values/>
      <desc>External script to be run after model completion</desc>
    </entry>
    <entry id="EXTERNAL_WORKFLOW" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>whether the case uses an external workflow driver </desc>
    </entry>
  </group>
  <group id="data_models">
    <entry id="FORCE_PROGNOSTIC_FOR_DATAMODELS" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>if true, all data models are expected to get input sent back from the mediator</desc>
    </entry>
  </group>
  <group id="run_debug">
    <entry id="CREATE_ESMF_PET_FILES" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>if true, create ESMF PET log files even if there is no error encountered </desc>
    </entry>
  </group>
  <group id="github_interface">
    <entry id="GITHUB_CASE_REPOSITORY" value="https://github.com/CESM-Development/cmip7-cases">
      <type>char</type>
      <desc>web address of github case repository if defined.</desc>
    </entry>
    <entry id="GITHUB_ARCHIVE_CASE" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>turns on github archiving of case directory</desc>
    </entry>
  </group>
  <group id="run_component_cpl">
    <entry id="CPL_ALBAV" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>
      Only used for compsets with DATM and [POP or MOM] (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.
    </desc>
    </entry>
    <entry id="CPL_EPBAL" value="off">
      <type>char</type>
      <valid_values>off,ocn</valid_values>
      <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
    </desc>
    </entry>
  </group>
  <group id="med_history">
    <entry id="HIST_OPTION" value="never">
      <type>char</type>
      <valid_values>none,never,nsteps,nseconds,nminutes,nhours,ndays,nmonths,nyears,date,end</valid_values>
      <desc>Sets driver snapshot history file frequency (like REST_OPTION)</desc>
    </entry>
    <entry id="HIST_N" value="-999">
      <type>integer</type>
      <valid_values/>
      <desc>Sets driver snapshot history file frequency (like REST_N)</desc>
    </entry>
    <entry id="HIST_DATE" value="-999">
      <type>integer</type>
      <valid_values/>
      <desc>yyyymmdd format, sets coupler snapshot history date (like REST_DATE)</desc>
    </entry>
  </group>
  <group id="run_budgets">
    <entry id="BUDGETS" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <desc>logical that turns on diagnostic budgets for driver</desc>
    </entry>
  </group>
  <group id="run_co2">
    <entry id="CCSM_CO2_PPMV" value="367.0">
      <type>real</type>
      <valid_values/>
      <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.
    </desc>
    </entry>
  </group>
  <group id="run_glc">
    <entry id="GLC_NEC" value="10">
      <type>integer</type>
      <valid_values>1,3,5,10,36</valid_values>
      <desc>Number of glacier elevation classes used in CLM.
    Used by both CLM and the coupler (even if CISM is not running, and only SGLC is used).</desc>
    </entry>
    <entry id="GLC_TWO_WAY_COUPLING" value="FALSE">
      <type>logical</type>
      <valid_values>TRUE,FALSE</valid_values>
      <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.</desc>
    </entry>
  </group>
  <group id="run_physics">
    <entry id="TFREEZE_SALTWATER_OPTION" value="mushy">
      <type>char</type>
      <valid_values>minus1p8,linear_salt,mushy</valid_values>
      <desc>Freezing point calculation for salt water.</desc>
    </entry>
  </group>
</file>