Driver CASEROOT Variable Definitions

Viewing compontent tag
cime5.6.19

Viewing model version
2.2.0

HTML created on
2020-09-28

Use CASEROOT tools xmlquery to query these variables and xmlchange to change their values.

Parameter Name Default Value Data Type Group CASEROOT File Valid Values Description
COMP_CLASSES CPL,ATM,LND,ICE,OCN,ROF,GLC,WAV,IAC,ESP char case_comp env_case.xml []
List of component classes supported by this driver
COMP_CPL cpl char case_comp env_case.xml ['cpl']
Name of coupling component
FILES_CONFIG_SPEC $CIMEROOT/config_files.xml char case_def env_case.xml []
 master configuration file that specifies all relevant filenames
    and directories to configure a case
CASEROOT UNSET char case_def env_case.xml []
full pathname of case
NONLOCAL FALSE logical case_def env_case.xml ['TRUE', 'FALSE']
user is not on the requested machine
CASETOOLS $CASEROOT/Tools char case_der env_case.xml []
Case Tools directory location (derived variable, not in namelists
CASEBUILD $CASEROOT/Buildconf char case_der env_case.xml []
Buildconf directory location (derived variable not in namelist)
SCRIPTSROOT $CIMEROOT/scripts char case_der env_case.xml []
Scripts root directory location (setup automatically to $CIMEROOT/scripts- DO NOT EDIT)
CIMEROOT UNSET char case_def env_case.xml []
full pathname of CIME source root directory
SRCROOT $CIMEROOT/.. char case_def env_case.xml []
full pathname of source root directory
UTILROOT $CIMEROOT/scripts/Tools char case_der env_case.xml []
Scripts root utils directory location (setup automatically to $CIMEROOT/scripts/Tools - DO NOT EDIT)
CASE UNSET char case_def env_case.xml []
case name
CASESTR UNSET char run_desc env_run.xml []
case description
COMPSET UNSET char case_last env_case.xml []
Component set long name (for documentation only - DO NOT EDIT)
GRID UNSET char build_grid env_build.xml []
Model grid - DO NOT EDIT (for experts only)
SUPPORTED_BY UNSET char case_def env_case.xml []
current machine name support contact
USER $ENV{USER} char case_desc env_case.xml []
case user name
REALUSER $ENV{USER} char case_desc env_case.xml []
username of user who created case
RUN_TYPE startup char run_begin_stop_restart env_run.xml ['startup', 'hybrid', 'branch']
      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.
    
RUN_REFDIR cesm2_init char run_begin_stop_restart env_run.xml []
      Reference directory containing RUN_REFCASE data - used for hybrid or branch runs
    
RUN_REFCASE case.std char run_begin_stop_restart env_run.xml []
      Reference case for hybrid or branch runs
    
RUN_REFDATE 0001-01-01 char run_begin_stop_restart env_run.xml []
      Reference date for hybrid or branch runs (yyyy-mm-dd)
    
RUN_REFTOD 00000 char run_begin_stop_restart env_run.xml []
      Reference time of day (seconds) for hybrid or branch runs (sssss)
    
GET_REFCASE FALSE logical run_begin_stop_restart env_run.xml ['TRUE', 'FALSE']
      Flag for automatically prestaging the refcase restart dataset.
      If TRUE, then the refcase data is prestaged into the executable directory
    
RUN_STARTDATE 0001-01-01 char run_begin_stop_restart env_run.xml []
      Run start date (yyyy-mm-dd). Only used for startup or hybrid runs.
    
START_TOD 0 integer run_begin_stop_restart env_run.xml []
      Run start time-of-day
    
STOP_OPTION ndays char run_begin_stop_restart env_run.xml ['none', 'never', 'nsteps', 'nstep', 'nseconds', 'nsecond', 'nminutes', 'nminute', 'nhours', 'nhour', 'ndays', 'nday', 'nmonths', 'nmonth', 'nyears', 'nyear', 'date', 'ifdays0', 'end']
      Sets the run length along with STOP_N and STOP_DATE
    
STOP_N 5 integer run_begin_stop_restart env_run.xml []
      Provides a numerical count for $STOP_OPTION.
    
STOP_DATE -999 integer run_begin_stop_restart env_run.xml []
      Alternative date yyyymmdd date option, sets the run length with STOP_OPTION and STOP_N
      negative value implies off
    
REST_OPTION $STOP_OPTION char run_begin_stop_restart env_run.xml ['none', 'never', 'nsteps', 'nstep', 'nseconds', 'nsecond', 'nminutes', 'nminute', 'nhours', 'nhour', 'ndays', 'nday', 'nmonths', 'nmonth', 'nyears', 'nyear', 'date', 'ifdays0', 'end']
      sets frequency of model restart writes (same options as STOP_OPTION)
    
REST_N $STOP_N integer run_begin_stop_restart env_run.xml []
      sets model restart writes with REST_OPTION and REST_DATE
    
REST_DATE $STOP_DATE char run_begin_stop_restart env_run.xml []
      Alternative date in yyyymmdd format
      sets model restart write date with REST_OPTION and REST_N
    
PAUSE_OPTION never char run_begin_stop_restart env_run.xml ['none', 'never', 'nsteps', 'nstep', 'nseconds', 'nsecond', 'nminutes', 'nminute', 'nhours', 'nhour', 'ndays', 'nday', 'nmonths', 'nmonth', 'nyears', 'nyear']
      Sets the pause frequency along with PAUSE_N
    
PAUSE_N 0 integer run_begin_stop_restart env_run.xml []
      Provides a numerical count for $PAUSE_OPTION.
    
PAUSE_ACTIVE logical run_begin_stop_restart env_run.xml ['TRUE', 'FALSE']
      Pause the model at times specified by PAUSE_OPTION and PAUSE_N.
      Components 'pause' by writing a restart file.
    
BARRIER_N 1 char run_begin_stop_restart env_run.xml []
      Sets periodic model barriers with BARRIER_OPTION and BARRIER_DATE for synchronization
    
BARRIER_DATE -999 char run_begin_stop_restart env_run.xml []
      Alternative date in yyyymmdd format
      sets periodic model barriers with BARRIER_OPTION and BARRIER_N for synchronization
    
ESP_RUN_ON_PAUSE FALSE logical run_begin_stop_restart env_run.xml ['TRUE', 'FALSE']
      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
    
CONTINUE_RUN FALSE logical run_begin_stop_restart env_run.xml ['TRUE', 'FALSE']
      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.
    
RESUBMIT 0 integer run_begin_stop_restart env_run.xml []
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.
    
RESUBMIT_SETS_CONTINUE_RUN TRUE logical run_begin_stop_restart env_run.xml []
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.
    
JOB_IDS char run_begin_stop_restart env_run.xml []
List of job ids for most recent case.submit
DOUT_S FALSE logical run_data_archive env_run.xml ['TRUE', 'FALSE']
Logical to turn on short term archiving.
    If TRUE, short term archiving will be turned on.
SYSLOG_N 900 integer run_data_archive env_run.xml []
system workload snapshot frequency (in seconds, if greater than 0; disabled otherwise)
environment_variables UNSET char config_batch env_mach_specific.xml []
The environment variables that will be loaded for this machine
BATCH_SYSTEM none char config_batch env_batch.xml ['nersc_slurm', 'lc_slurm', 'moab', 'pbs', 'lsf', 'slurm', 'cobalt', 'cobalt_theta', 'none']
The batch system type to use for this machine.
env UNSET char config_batch env_mach_specific.xml []
The individual environment variable entry for config_machines
limits UNSET char config_batch env_mach_specific.xml []
The limits tag
limit UNSET char config_batch env_mach_specific.xml []
The individual limit variable
PERL5LIB char build_derived env_build.xml []
Perl 5 library directory
CIME_OUTPUT_ROOT UNSET char build_def env_build.xml []
Output root directory for each machine.
		Base directory for build and run directories.
    
EXEROOT $CIME_OUTPUT_ROOT/$CASE/bld char build_def env_build.xml []
Case executable root directory.
    (executable is $EXEROOT/$MODEL.exe, component libraries are in $EXEROOT/lib)
    This is where the model builds its executable and by default runs the executable.
    Note that EXEROOT needs to have enough disk space for the experimental configuration
    requirements. As an example, a model run can produce more than a terabyte of
    data during a 100-year run, so you should set EXEROOT to scratch or
    tmp space and frequently back up the data to a long term archiving storage device
    For a supported machine, EXEROOT is set in $CIMEROOT/machines/config_machines.xml.
    For a userdefined machine, EXEROOT must explicitly be set it in env_build.xml.
OS USERDEFINED_required_macros char build_macros env_build.xml []
Operating system - DO NOT EDIT UNLESS for userdefined machine - ignored once Macros has been created.
COMPILER char build_macros env_build.xml []
Machine compiler (must match one the supported compilers)
    Set in $CIMEROOT/machines/config_machines.xml for each supported machine.
    Must be explicitly set in env_build.xml for userdefined machine.
MPILIB USERDEFINED_required_macros char build_macros env_build.xml []
mpi library (must match one of the supported libraries) -
    ignored once Macros has been created
    Set in $CIMEROOT/machines/config_machines.xml for each supported machine.
    Must be explicitly set in env_build.xml for userdefined machine.
CALENDAR NO_LEAP char build_def env_build.xml ['NO_LEAP', 'GREGORIAN']
calendar type
COMP_INTERFACE mct char build_def env_build.xml ['mct', 'nuopc', 'moab']
use MCT component interface
USE_ESMF_LIB FALSE logical build_def env_build.xml ['TRUE', 'FALSE']
TRUE implies using the ESMF library specified by ESMF_LIBDIR or ESMFMKFILE
DEBUG FALSE logical build_def env_build.xml ['TRUE', 'FALSE']
TRUE implies turning on run and compile time debugging
      Flag to turn on debugging for run time and compile time.
      If TRUE, compile-time debugging flags are activated that you can use to verify
      software robustness, such as bounds checking.
      Important:: On IBM machines, floating point trapping is not activated for production
      runs (i.e., non-DEBUG), due to performance penalties associated with turning on these flags.
FORCE_BUILD_SMP FALSE logical build_def env_build.xml ['TRUE', 'FALSE']
TRUE implies always build model for openmp capability
      If FALSE, component libraries are built with OpenMP capability if
      the NTHREADS_ setting for any component is greater than 1 in env_mach_pes.xml.
      If TRUE, the component libraries are always built with OpenMP capability.
SMP_PRESENT FALSE logical build_def env_build.xml ['TRUE', 'FALSE']
TRUE implies that at least one of the components is built threaded (DO NOT EDIT)
USE_PETSC FALSE logical build_def env_build.xml ['TRUE', 'FALSE']
TRUE implies linking to the PETSc library - set
    automatically by XXX_USE_PETSC options (do not edit). Flag to turn
    on linking to the PETSc library. Currently this is used by
    CLM. This is currently only supported for certain machines.
USE_ALBANY FALSE logical build_def env_build.xml ['TRUE', 'FALSE']
TRUE implies linking to the Albany library - set
    automatically by XXX_USE_ALBANY options (do not edit). Flag to
    turn on linking to the Albany library. Currently this is used by
    MALI. Note that Albany is a C++ library, so setting this
    variable to TRUE will involve the inclusion of C++ code in the
    MALI executable. This is currently only supported for certain
    machines.
USE_MOAB FALSE logical build_def env_build.xml ['TRUE', 'FALSE']
TRUE implies linking to the MOAB library
USE_TRILINOS FALSE logical build_def env_build.xml ['TRUE', 'FALSE']
TRUE implies linking to the trilinos library - set automatically by XXX_USE_TRILINOS options (do not edit)
      Flag to turn on linking to the trilinos library. Currently this is
      used by CISM. Note that trilinos is a C++ library, so setting this
      variable to TRUE will involve the inclusion of C++ code in the model
      executable. This is currently only supported for certain machines.
GMAKE gmake char build_def env_run.xml []
GNU make command
GMAKE_J 1 integer build_def env_run.xml []
Number of processors for gmake
BUILD_COMPLETE FALSE logical build_status env_build.xml ['TRUE', 'FALSE']
Status output: if TRUE, models have been built successfully. (DO NOT EDIT)>
SMP_BUILD 0 char build_status env_build.xml []
Status: smp status of previous build, coded string. (DO NOT EDIT)
SMP_VALUE 0 char build_status env_build.xml []
Status: smp status of current case, coded string (DO NOT EDIT)
NINST_BUILD 0 char build_status env_build.xml []
Status: ninst status of previous build, coded string. (DO NOT EDIT)>
NINST_VALUE 0 char build_status env_build.xml []
Status: ninst status of current case, coded string (DO NOT EDIT)
BUILD_STATUS 0 integer build_status env_build.xml ['0', '1', '2']
Status: of prior build. (DO NOT EDIT)
OBJROOT $EXEROOT char build_derived env_build.xml []
case build directory (set automatically to $EXEROOT, - DO NOT EDIT)
LIBROOT $EXEROOT/lib char build_derived env_build.xml []
case lib directory (set automatically to $EXEROOT/lib - DO NOT EDIT)
INCROOT $EXEROOT/lib/include char build_derived env_build.xml []
case lib include directory (set automatically to $EXEROOT/lib/include - DO NOT EDIT)
SHAREDLIBROOT $EXEROOT char build_derived env_build.xml []
Shared library root, (set automatically to $EXEROOT - DO NOT EDIT)
CHECK_TIMING TRUE logical run_flags env_run.xml ['TRUE', 'FALSE']
logical to diagnose model timing at the end of the run
PROFILE_PAPI_ENABLE FALSE logical run_flags env_run.xml ['TRUE', 'FALSE']
Enables the papi hardware counters in gptl
    The papi library must be included in the build step for
    this to work.
ESMF_LOGFILE_KIND ESMF_LOGKIND_NONE char run_flags env_run.xml ['ESMF_LOGKIND_SINGLE', 'ESMF_LOGKIND_MULTI', 'ESMF_LOGKIND_MULTI_ON_ERROR', 'ESMF_LOGKIND_NONE']
      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.
    
COMP_RUN_BARRIERS FALSE logical run_flags env_run.xml ['TRUE', 'FALSE']
Turns on component barriers for component timing.
	  This variable is for testing and debugging only and should never
	  be set for a production run.
    
COST_PES 0 integer mach_pes_last env_mach_pes.xml []
pes or cores used relative to MAX_MPITASKS_PER_NODE for accounting (0 means TOTALPES is valid)
ATM_GRID UNSET char build_grid env_build.xml []
atmosphere grid - DO NOT EDIT (for experts only)
ATM_NX 0 integer build_grid env_build.xml []
number of atmosphere cells in i direction - DO NOT EDIT (for experts only)
ATM_NY 0 integer build_grid env_build.xml []
number of atmosphere cells in j direction - DO NOT EDIT (for experts only)
LND_GRID UNSET char build_grid env_build.xml []
land grid - DO NOT EDIT (for experts only)
LND_NX 0 integer build_grid env_build.xml []
number of land cells in i direction - DO NOT EDIT (for experts only)
LND_NY 0 integer build_grid env_build.xml []
number of land cells in j direction - DO NOT EDIT (for experts only)
OCN_GRID UNSET char build_grid env_build.xml []
ocn grid - DO NOT EDIT (for experts only)
OCN_NX 0 integer build_grid env_build.xml []
number of ocn cells in i direction - DO NOT EDIT (for experts only)
OCN_NY 0 integer build_grid env_build.xml []
number of ocn cells in j direction - DO NOT EDIT (for experts only)
ICE_GRID UNSET char build_grid env_build.xml []
ice grid (must equal ocn grid) - DO NOT EDIT (for experts only)
ICE_NX 0 integer build_grid env_build.xml []
number of ice cells in i direction - DO NOT EDIT (for experts only)
ICE_NY 0 integer build_grid env_build.xml []
number of ice cells in j direction - DO NOT EDIT (for experts only)
ICE_NCAT 1 integer build_grid env_build.xml []
number of ice thickness categories - DO NOT EDIT (set by CICE configure)
ROF_GRID UNSET char build_grid env_build.xml []
river runoff (rof) grid
ROF_NX 0 integer build_grid env_build.xml []
number of rof cells in i direction - DO NOT EDIT (for experts only)
ROF_NY 0 integer build_grid env_build.xml []
number of rof cells in j direction - DO NOT EDIT (for experts only)
GLC_GRID gland5UM char build_grid env_build.xml ['gland20', 'gland10', 'gland5', 'gland5UM', 'gland4', 'mpas.aisgis20km', 'mpas.gis20km', 'mpas.ais20km', 'mpas.gis1to10km', 'null']
glacier (glc) grid - DO NOT EDIT (for experts only)
GLC_NX 0 integer build_grid env_build.xml []
number of glc cells in i direction - DO NOT EDIT (for experts only)
GLC_NY 0 integer build_grid env_build.xml []
number of glc cells in j direction - DO NOT EDIT (for experts only)
WAV_GRID UNSET char build_grid env_build.xml []
wave model (wav) grid
WAV_NX 0 integer build_grid env_build.xml []
number of wav cells in i direction - DO NOT EDIT (for experts only)
WAV_NY 0 integer build_grid env_build.xml []
number of wav cells in j direction - DO NOT EDIT (for experts only)
IAC_GRID UNSET char build_grid env_build.xml []
iac model (iac) grid
IAC_NX 0 integer build_grid env_build.xml []
number of iac cells in i direction - DO NOT EDIT (for experts only)
IAC_NY 0 integer build_grid env_build.xml []
number of iac cells in j direction - DO NOT EDIT (for experts only)
MASK_GRID UNSET char build_grid env_build.xml []
grid mask - DO NOT EDIT (for experts only)
IOP_MODE FALSE logical run_domain env_run.xml ['TRUE', 'FALSE']
Propogate a single point to the global grid  - DO NOT EDIT (for experts only)
PTS_MODE FALSE logical run_domain env_run.xml ['TRUE', 'FALSE']
Operate on only a single point of the global grid  - DO NOT EDIT (for experts only)
PTS_LAT -999.99 real run_domain env_run.xml []
Latitude to find nearest points for points mode (only used if PTS_MODE is TRUE)
PTS_LON -999.99 real run_domain env_run.xml []
Longitude to find nearest points for points mode (only used if PTS_MODE is TRUE)
ATM_DOMAIN_FILE UNSET char run_domain env_run.xml []
atm domain file
ATM_DOMAIN_PATH $DIN_LOC_ROOT/share/domains char run_domain env_run.xml []
path of atm domain file
LND_DOMAIN_FILE UNSET char run_domain env_run.xml []
lnd domain file
LND_DOMAIN_PATH $DIN_LOC_ROOT/share/domains char run_domain env_run.xml []
path of lnd domain file
ROF_DOMAIN_FILE UNSET char run_domain env_run.xml []
rof domain file
ROF_DOMAIN_PATH $DIN_LOC_ROOT/share/domains char run_domain env_run.xml []
path of rof domain file
WAV_DOMAIN_FILE UNSET char run_domain env_run.xml []
wav domain file
WAV_DOMAIN_PATH $DIN_LOC_ROOT/share/domains char run_domain env_run.xml []
path of wav domain file
IAC_DOMAIN_FILE UNSET char run_domain env_run.xml []
iac domain file
IAC_DOMAIN_PATH $DIN_LOC_ROOT/share/domains char run_domain env_run.xml []
path of iac domain file
ICE_DOMAIN_FILE UNSET char run_domain env_run.xml []
ice domain file
ICE_DOMAIN_PATH $DIN_LOC_ROOT/share/domains char run_domain env_run.xml []
path of ice domain file
OCN_DOMAIN_FILE UNSET char run_domain env_run.xml []
ocn domain file
OCN_DOMAIN_PATH $DIN_LOC_ROOT/share/domains char run_domain env_run.xml []
path of ocn domain file
GLC_DOMAIN_FILE UNSET char run_domain env_run.xml []
glc domain file
GLC_DOMAIN_PATH $DIN_LOC_ROOT/share/domains char run_domain env_run.xml []
path of glc domain file
ATM2OCN_FMAPNAME idmap char run_domain env_run.xml []
atm2ocn flux mapping file
ATM2OCN_FMAPTYPE X char run_domain env_run.xml ['X', 'Y']
atm2ocn flux mapping file decomp type
ATM2OCN_SMAPNAME idmap char run_domain env_run.xml []
atm2ocn state mapping file
ATM2OCN_SMAPTYPE X char run_domain env_run.xml ['X', 'Y']
atm2ocn state mapping file decomp type
ATM2OCN_VMAPNAME idmap char run_domain env_run.xml []
atm2ocn vector mapping file
ATM2OCN_VMAPTYPE X char run_domain env_run.xml ['X', 'Y']
atm2ocn vector mapping file decomp type
ATM2LND_FMAPNAME idmap char run_domain env_run.xml []
atm2lnd flux mapping file
ATM2LND_FMAPTYPE X char run_domain env_run.xml ['X', 'Y']
atm2lnd flux mapping file decomp type
ATM2LND_SMAPNAME idmap char run_domain env_run.xml []
atm2lnd state mapping file
ATM2LND_SMAPTYPE X char run_domain env_run.xml ['X', 'Y']
atm2lnd state mapping file decomp type
ATM2ROF_FMAPNAME idmap_ignore char run_domain env_run.xml []
atm2rof flux mapping file
ATM2ROF_FMAPTYPE X char run_domain env_run.xml ['X', 'Y']
atm2rof flux mapping file decomp type
ATM2ROF_SMAPNAME idmap_ignore char run_domain env_run.xml []
atm2rof state mapping file
ATM2ROF_SMAPTYPE X char run_domain env_run.xml ['X', 'Y']
atm2rof state mapping file decomp type
ATM2WAV_SMAPNAME idmap char run_domain env_run.xml []
atm2wav state mapping file
ATM2WAV_SMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
atm2wav state mapping file decomp type
OCN2ATM_FMAPNAME idmap char run_domain env_run.xml []
ocn2atm flux mapping file
OCN2ATM_FMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
ocn2atm flux mapping file decomp type
OCN2ATM_SMAPNAME idmap char run_domain env_run.xml []
ocn2atm state mapping file
OCN2ATM_SMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
ocn2atm state mapping file decomp type
LND2ATM_FMAPNAME idmap char run_domain env_run.xml []
lnd2atm flux mapping file
LND2ATM_FMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
lnd2atm flux mapping file decomp type
LND2ATM_SMAPNAME idmap char run_domain env_run.xml []
lnd2atm state mapping file
LND2ATM_SMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
lnd2atm state mapping file decomp type
LND2GLC_FMAPNAME idmap char run_domain env_run.xml []
lnd2glc flux mapping file
LND2GLC_FMAPTYPE X char run_domain env_run.xml ['X', 'Y']
lnd2glc flux mapping file decomp type
LND2GLC_SMAPNAME idmap char run_domain env_run.xml []
lnd2glc state mapping file
LND2GLC_SMAPTYPE X char run_domain env_run.xml ['X', 'Y']
lnd2glc state mapping file decomp type
LND2ROF_FMAPNAME idmap char run_domain env_run.xml []
lnd2rof flux mapping file
LND2ROF_FMAPTYPE X char run_domain env_run.xml ['X', 'Y']
lnd2rof flux mapping file decomp type
ROF2LND_FMAPNAME idmap char run_domain env_run.xml []
rof2lnd flux mapping file
ROF2LND_FMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
rof2lnd flux mapping file decomp type
ROF2OCN_FMAPNAME idmap_ignore char run_domain env_run.xml []
rof2ocn flux mapping file - the default value idmap_ignore, if set, will be ignored by buildnml and
    will generate a runtime error if in fact a file is required for the given compset
ROF2OCN_FMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
rof2ocn flux mapping file decomp type
ROF2OCN_LIQ_RMAPNAME idmap char run_domain env_run.xml []
rof2ocn runoff mapping file
ROF2OCN_LIQ_RMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
rof2ocn runoff mapping file decomp type
ROF2OCN_ICE_RMAPNAME idmap char run_domain env_run.xml []
rof2ocn runoff mapping file
ROF2OCN_ICE_RMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
rof2ocn runoff mapping file decomp type
GLC2LND_FMAPNAME idmap char run_domain env_run.xml []
glc2lnd flux mapping file
GLC2LND_FMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
glc2lnd flux mapping file decomp type
GLC2LND_SMAPNAME idmap char run_domain env_run.xml []
glc2lnd state mapping file
GLC2LND_SMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
glc2lnd state mapping file decomp type
GLC2ICE_FMAPNAME idmap_ignore char run_domain env_run.xml []
glc2ice flux mapping file - the default value idmap_ignore, if set, will be ignored by buildnml and
    will generate a runtime error if in fact a file is required for the given compset
GLC2ICE_FMAPTYPE X char run_domain env_run.xml ['X', 'Y']
glc2ice flux mapping file decomp type
GLC2ICE_SMAPNAME idmap_ignore char run_domain env_run.xml []
glc2ice state mapping file - the default value idmap_ignore, if set, will be ignored by buildnml and
    will generate a runtime error if in fact a file is required for the given compset
GLC2ICE_SMAPTYPE X char run_domain env_run.xml ['X', 'Y']
glc2ice state mapping file decomp type
GLC2ICE_RMAPNAME idmap_ignore char run_domain env_run.xml []
glc2ice runoff mapping file - the default value idmap_ignore, if set, will be ignored by buildnml and
    will generate a runtime error if in fact a file is required for the given compset
GLC2ICE_RMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
glc2ice runoff mapping file decomp type
GLC2OCN_FMAPNAME idmap_ignore char run_domain env_run.xml []
glc2ocn flux mapping file - the default value idmap_ignore, if set, will be ignored by buildnml and
    will generate a runtime error if in fact a file is required for the given compset
GLC2OCN_FMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
glc2ocn flux mapping file decomp type
GLC2OCN_SMAPNAME idmap_ignore char run_domain env_run.xml []
glc2ocn state mapping file - the default value idmap_ignore, if set, will be ignored by buildnml and
    will generate a runtime error if in fact a file is required for the given compset
GLC2OCN_SMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
glc2ocn state mapping file decomp type
GLC2OCN_LIQ_RMAPNAME idmap_ignore char run_domain env_run.xml []
glc2ocn runoff mapping file for liquid runoff - the default value idmap_ignore, if set, will be ignored by buildnml and
    will generate a runtime error if in fact a file is required for the given compset
GLC2OCN_LIQ_RMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
glc2ocn runoff mapping file decomp type for liquid runoff
GLC2OCN_ICE_RMAPNAME idmap_ignore char run_domain env_run.xml []
glc2ocn runoff mapping file for ice runoff - the default value idmap_ignore, if set, will be ignored by buildnml and
    will generate a runtime error if in fact a file is required for the given compset
GLC2OCN_ICE_RMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
glc2ocn runoff mapping file decomp type for ice runoff
OCN2GLC_FMAPNAME idmap_ignore char run_domain env_run.xml []
ocn2glc flux mapping file - the default value idmap_ignore, if set, will be ignored by buildnml and
    will generate a runtime error if in fact a file is required for the given compset
OCN2GLC_FMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
ocn2glc flux mapping file decomp type
OCN2GLC_SMAPNAME idmap_ignore char run_domain env_run.xml []
ocn2glc state mapping file - the default value idmap_ignore, if set, will be ignored by buildnml and
    will generate a runtime error if in fact a file is required for the given compset
OCN2GLC_SMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
ocn2glc state mapping file decomp type
OCN2WAV_SMAPNAME idmap char run_domain env_run.xml []
ocn2wav state mapping file
OCN2WAV_SMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
ocn2wav state mapping file decomp type
ICE2WAV_SMAPNAME idmap char run_domain env_run.xml []
ice2wav state mapping file
ICE2WAV_SMAPTYPE Y char run_domain env_run.xml ['X', 'Y']
ice2wav state mapping file decomp type
WAV2OCN_SMAPNAME idmap char run_domain env_run.xml []
wav2ocn state mapping file
WAV2OCN_SMAPTYPE X char run_domain env_run.xml ['X', 'Y']
wav2ocn state mapping file decomp type
IAC2ATM_FMAPNAME idmap char run_domain env_run.xml []
iac2atm flux mapping file
IAC2ATM_FMAPTYPE X char run_domain env_run.xml ['X', 'Y']
iac2atm flux mapping file decomp type
IAC2ATM_SMAPNAME idmap char run_domain env_run.xml []
iac2atm state mapping file
IAC2ATM_SMAPTYPE X char run_domain env_run.xml ['X', 'Y']
iac2atm state mapping file decomp type
IAC2LND_FMAPNAME idmap char run_domain env_run.xml []
iac2lnd flux mapping file
IAC2LND_FMAPTYPE X char run_domain env_run.xml ['X', 'Y']
iac2lnd flux mapping file decomp type
IAC2LND_SMAPNAME idmap char run_domain env_run.xml []
iac2lnd state mapping file
IAC2LND_SMAPTYPE X char run_domain env_run.xml ['X', 'Y']
iac2lnd state mapping file decomp type
VECT_MAP cart3d char run_domain env_run.xml ['none', 'npfix', 'cart3d', 'cart3d_diag', 'cart3d_uvw', 'cart3d_uvw_diag']
vector mapping option
EPS_FRAC 1.0e-02 char run_domain env_run.xml []
Error tolerance for differences in fractions in domain checking
EPS_AAREA 9.0e-07 real run_domain env_run.xml []
Error tolerance for differences in atm/land areas in domain checking
EPS_AMASK 1.0e-13 real run_domain env_run.xml []
Error tolerance for differences in atm/land masks in domain checking
EPS_AGRID 1.0e-12 real run_domain env_run.xml []
Error tolerance for differences in atm/land lat/lon in domain checking
EPS_OAREA 1.0e-01 real run_domain env_run.xml []
Error tolerance for differences in ocean/ice lon/lat in domain checking
EPS_OMASK 1.0e-06 real run_domain env_run.xml []
Error tolerance for differences in ocean/ice lon/lat in domain checking
EPS_OGRID 1.0e-01 real run_domain env_run.xml []
Error tolerance for differences in ocean/ice lon/lat in domain checking
MACH UNSET char case_def env_case.xml []
Machine name
MACHDIR char case_def env_case.xml []
Machines directory location
EXTRA_MACHDIR char case_def env_case.xml []
Path to an extra directory containing supplementary machines files
RUNDIR $CIME_OUTPUT_ROOT/$CASE/run char run_desc env_run.xml []
      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
    
NODENAME_REGEX UNSET char run_din env_run.xml []
      A regular expression to match machine node names to ACME machine.
    
NODE_FAIL_REGEX char run_din env_run.xml []
      A regular expression to search for an indication that a run failure
       was caused by a node failure and should therefore be re-attempted.
    
MPIRUN_RETRY_REGEX char run_din env_run.xml []
      A regular expression to search for an indication that a run failure
      was caused by a known event such as a timeout and should therefore
      be re-attempted.
    
MPIRUN_RETRY_COUNT 0 integer run_din env_run.xml []
The number of times to reattempt the mpirun command if
    MPIRUN_RETRY_REGEX is matched but ALLOCATE_SPARE_NODES is False
    
PROXY UNSET char run_din env_run.xml []
      Proxy (if any) setting for http_proxy to allow web access on this machine.
    
TEST FALSE logical run_din env_run.xml []
      Indicates to case.submit that this is a test case.
    
DIN_LOC_ROOT UNSET char run_din env_run.xml []
      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
    
DIN_LOC_ROOT_CLMFORC UNSET char run_din env_run.xml []
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
DOUT_S_ROOT UNSET char run_dout env_run.xml []
Root directory for short term archiving. This directory must be visible to compute nodes.
MPI_RUN_COMMAND UNSET char run_mpi env_run.xml []
override the mpi run command, do not include model executable
ALLOCATE_SPARE_NODES FALSE logical mach_pes env_mach_pes.xml ['TRUE', 'FALSE']
Allocate some spare nodes to handle node failures. The system will pick a reasonable number
FORCE_SPARE_NODES -999 integer mach_pes env_mach_pes.xml []
Force this exact number of spare nodes to be allocated
NTASKS integer mach_pes env_mach_pes.xml []
number of tasks for each component
NTASKS_PER_INST integer mach_pes env_mach_pes.xml []
Number of tasks per instance for each component. DO NOT EDIT: Set automatically by case.setup based on NTASKS, NINST and MULTI_DRIVER
NTHRDS integer mach_pes env_mach_pes.xml []
number of threads for each task in each component
ROOTPE integer mach_pes env_mach_pes.xml []
ROOTPE (mpi task in MPI_COMM_WORLD) for each component
MULTI_DRIVER FALSE logical mach_pes env_mach_pes.xml ['TRUE', 'FALSE']
MULTI_DRIVER mode provides a separate driver/coupler component for each
    ensemble member.  All components must have an equal number of members.  If
    MULTI_DRIVER mode is False prognostic components must have the same number
    of members but data or stub components may also have 1 member. 
NINST integer mach_pes env_mach_pes.xml []
Number of instances for each component.  If MULTI_DRIVER is True
    the NINST_MAX value will be used.
    
NINST_LAYOUT char mach_pes env_mach_pes.xml ['sequential', 'concurrent']
Layout of component instances for each component
PSTRID integer mach_pes env_mach_pes.xml []
The mpi global processors stride associated with the mpi tasks for the a component
TOTALPES 0 integer mach_pes_last env_mach_pes.xml []
total number of physical cores used (setup automatically - DO NOT EDIT)
MAX_TASKS_PER_NODE 0 integer mach_pes_last env_mach_pes.xml []
maximum number of tasks/ threads allowed per node 
MAX_MPITASKS_PER_NODE 0 integer mach_pes_last env_mach_pes.xml []
pes or cores per node for mpitasks 
COSTPES_PER_NODE $MAX_MPITASKS_PER_NODE integer mach_pes_last env_mach_pes.xml []
pes or cores per node for accounting purposes 
PIO_VERSION 1 integer build_macros env_build.xml ['1', '2']
PIO library version
PIO_CONFIG_OPTS char build_macros env_build.xml []
PIO configure options, see PIO configure utility for details
PIO_ASYNC_INTERFACE FALSE logical run_pio env_run.xml ['TRUE', 'FALSE']
TRUE implies perform asynchronous i/o
PIO_REARR_COMM_TYPE p2p char run_pio env_run.xml ['p2p', 'coll', 'default']
pio rearranger communication type
PIO_REARR_COMM_FCD 2denable char run_pio env_run.xml ['2denable', 'io2comp', 'comp2io', 'disable', 'default']
pio rearranger communication flow control direction
PIO_REARR_COMM_MAX_PEND_REQ_COMP2IO 0 integer run_pio env_run.xml []
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 
PIO_REARR_COMM_ENABLE_HS_COMP2IO TRUE logical run_pio env_run.xml ['TRUE', 'FALSE']
pio rearranger communiation options (comp2io) : TRUE implies enable handshake 
PIO_REARR_COMM_ENABLE_ISEND_COMP2IO FALSE logical run_pio env_run.xml ['TRUE', 'FALSE']
pio rearranger communiation options (comp2io) : TRUE implies enable isend
PIO_REARR_COMM_MAX_PEND_REQ_IO2COMP 64 integer run_pio env_run.xml []
pio rearranger communication max pending requests (io2comp) : 0 implies that CIME internally calculates the value (= 64), -1 implies no bound on max pending requests 
PIO_REARR_COMM_ENABLE_HS_IO2COMP FALSE logical run_pio env_run.xml ['TRUE', 'FALSE']
pio rearranger communiation options (io2comp) : TRUE implies enable handshake
PIO_REARR_COMM_ENABLE_ISEND_IO2COMP TRUE logical run_pio env_run.xml ['TRUE', 'FALSE']
pio rearranger communiation options (io2comp) : TRUE implies enable isend
PIO_DEBUG_LEVEL 0 integer run_pio env_run.xml []
pio debug level
PIO_BLOCKSIZE -1 integer run_pio env_run.xml []
pio blocksize for box decompositions
PIO_BUFFER_SIZE_LIMIT -1 integer run_pio env_run.xml []
pio buffer size limit for pnetcdf output
PIO_TYPENAME char run_pio env_run.xml ['netcdf', 'pnetcdf', 'netcdf4p', 'netcdf4c', 'default']
pio io type
PIO_NETCDF_FORMAT char run_pio env_run.xml ['classic', '64bit_offset', '64bit_data']
pio netcdf format (ignored for netcdf4p and netcdf4c)
    https://www.unidata.ucar.edu/software/netcdf/docs/data_type.html
    
PIO_STRIDE integer run_pio env_run.xml []
     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
    
PIO_REARRANGER integer run_pio env_run.xml ['1', '2']
pio rearranger choice box=1, subset=2 
PIO_ROOT integer run_pio env_run.xml []
pio root processor relative to component root
PIO_NUMTASKS integer run_pio env_run.xml []
      pio number of io tasks, if this value is -99 it will be computed based on PIO_STRIDE and
      number of tasks
    
NAME UNSET char test env_test.xml []
Test type name
DESC UNSET char test env_test.xml []
Test type descriptor
TESTCASE UNSET char test env_test.xml []
Testcase short name
CASEBASEID UNSET char test env_test.xml []
Case base ID
IS_FIRST_RUN TRUE logical test env_test.xml ['TRUE', 'FALSE']
Is first run of test
TEST_ARGV UNSET char test env_test.xml []
Arguments supplied to create_test
TEST_TESTID UNSET char test env_test.xml []
supplied or computed test id
TEST_MEMLEAK_TOLERANCE 0.10 real test env_test.xml []
Expected relative memory usage growth for test
TEST_TPUT_TOLERANCE 0.25 real test env_test.xml []
Expected throughput deviation
GENERATE_BASELINE FALSE logical test env_test.xml ['TRUE', 'FALSE']
Whether to generate a baseline
COMPARE_BASELINE FALSE logical test env_test.xml ['TRUE', 'FALSE']
Whether to compare the baseline
BASEGEN_CASE UNSET char test env_test.xml []
The tagname we are comparing baselines against
BASECMP_CASE UNSET char test env_test.xml []
The tagname we are comparing baselines against
BASELINE_ROOT /UNSET char test env_test.xml []
The directory where baselines are stored
BASELINE_NAME_GEN UNSET char test env_test.xml []
The tagname we are generating baselines for
BASELINE_NAME_CMP UNSET char test env_test.xml []
The tagname we are comparing baselines against
CLEANUP FALSE logical test env_test.xml ['TRUE', 'FALSE']
Whether to clean the test after it is built/run
CCSM_CPRNC UNSET char test env_test.xml []
standard full pathname of the cprnc executable. One can skip defining the xml entry, CCSM_CPRNC, and the sharedlib build system will automatically build cprnc
CPL_I2O_PER_CAT FALSE logical run_coupling env_run.xml ['TRUE', 'FALSE']
determine if per ice thickness category fields are passed from ice to ocean - DO NOT EDIT (set by POP build-namelist)
HIST_OPTION never char run_drv_history env_run.xml ['none', 'never', 'nsteps', 'nstep', 'nseconds', 'nsecond', 'nminutes', 'nminute', 'nhours', 'nhour', 'ndays', 'nday', 'nmonths', 'nmonth', 'nyears', 'nyear', 'date', 'ifdays0', 'end']
Sets driver snapshot history file frequency (like REST_OPTION)
HIST_N -999 integer run_drv_history env_run.xml []
Sets driver snapshot history file frequency (like REST_N)
    
HIST_DATE -999 integer run_drv_history env_run.xml []
yyyymmdd format, sets coupler snapshot history date (like REST_DATE)
CPL_DECOMP 0 integer run_flags env_run.xml ['0', '1', '2', '3', '4', '5', '6']
Coupler decomposition option.
INFO_DBUG 1 integer run_flags env_run.xml ['0', '1', '2', '3']
level of debug output, 0=minimum, 1=normal, 2=more, 3=too much
CLM_USE_PETSC FALSE logical build_component_clm env_build.xml ['TRUE', 'FALSE']
TRUE implies CLM is built with support for the PETSc
      library. The Variably Saturated Flow Model (VSFM) solver in CLM
      uses the PETSc library. In order to use the VSFM solver, CLM
      must be built with PETSc support and linking to PETSc must occur
      when building the ACME executable. This occurs if this variable
      is set to TRUE. Note that is only available on a limited set of
      machines/compilers.
PRERUN_SCRIPT char external_tools env_run.xml []
External script to be run before model completion
POSTRUN_SCRIPT char external_tools env_run.xml []
External script to be run after model completion
DATA_ASSIMILATION logical external_tools env_run.xml ['TRUE', 'FALSE']
 Run the external tool pointed to by DATA_ASSIMILATION_SCRIPT after the model run completes 
DATA_ASSIMILATION_CYCLES 1 integer external_tools env_run.xml []
 Number of model run - data assimilation steps to complete 
DATA_ASSIMILATION_SCRIPT char external_tools env_run.xml []
External script to be run after model completion
EXTERNAL_WORKFLOW FALSE logical external_tools env_run.xml ['TRUE', 'FALSE']
whether the case uses an external workflow driver 
USER_REQUESTED_QUEUE char job_submission env_workflow.xml []
Store user override for queue
USER_REQUESTED_WALLTIME char job_submission env_workflow.xml []
Store user override for walltime
JOB_QUEUE char job_submission env_workflow.xml []
The machine queue in which to submit the job.  Default determined in config_machines.xml can be overwritten by testing
JOB_WALLCLOCK_TIME char job_submission env_workflow.xml []
The machine wallclock setting.  Default determined in
   config_machines.xml can be overwritten by testing.  Format is
   DD:HH:MM with DD assumed 0 if not present, this is translated to
   the format specified by walltime format defined in
   config_batch.xml
BATCH_COMMAND_FLAGS char job_submission env_workflow.xml []
Override the batch submit command this job. Do not include executable or dependencies
PROJECT char job_submission env_workflow.xml []
project for project-sensitive build and run paths, and job scripts
CHARGE_ACCOUNT char job_submission env_workflow.xml []
project to charge in scripts if different from PROJECT
MODEL_VERSION unknown char case_der env_case.xml []
Apparent version of the model used for this case
PROJECT_REQUIRED FALSE logical job_submission env_batch.xml ['TRUE', 'FALSE']
whether the PROJECT value is required on this machine
COMPARE_TO_NUOPC FALSE logical comparison_to_nuopc env_build.xml ['TRUE', 'FALSE']
TRUE=>turn on CPP variable COMPARE_TO_NUOPC
Parameter Name Default Value Data Type Group CASEROOT File Valid Values Description