CESM3.0a Driver CASEROOT Variable Definitions

List of component classes supported by this driver

Container environment to invoke, if any

Name of coupling component

coupling mode

 main configuration file that specifies all relevant filenames
    and directories to configure a case

full pathname of case

user is not on the requested machine

Case Tools directory location (derived variable, not in namelists

Buildconf directory location (derived variable not in namelist)

Extra copies of the component log files will be saved here.

Scripts root directory location (setup automatically to $CIMEROOT/scripts- DO NOT EDIT)

full pathname of CIME source root directory

full pathname of source root directory

Scripts root utils directory location (setup automatically to $CIMEROOT/scripts/Tools - DO NOT EDIT)

case name

case description

Component set long name (for documentation only - DO NOT EDIT)

Model grid - DO NOT EDIT (for experts only)

current machine name support contact

case user name

username of user who created case

Unique identifier for case

      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.
    

      Reference directory containing RUN_REFCASE data - used for hybrid or branch runs
    

      Reference case for hybrid or branch runs
    

      Reference date for hybrid or branch runs (yyyy-mm-dd)
    

      Reference time of day (seconds) for hybrid or branch runs (sssss)
    

      Flag for automatically prestaging the refcase restart dataset.
      If TRUE, then the refcase data is prestaged into the executable directory
    

      Run start date (yyyy-mm-dd). Only used for startup or hybrid runs.
    

      Run start time-of-day, units are seconds with values from 0 to 86400.
    

      Sets the run length along with STOP_N and STOP_DATE
    

      Provides a numerical count for $STOP_OPTION.
    

      Alternative date yyyymmdd date option, sets the run length with STOP_OPTION and STOP_N
      negative value implies off
    

      sets frequency of model restart writes (same options as STOP_OPTION)
    

      sets model restart writes with REST_OPTION and REST_DATE
    

      Alternative date in yyyymmdd format
      sets model restart write date with REST_OPTION and REST_N
    

      Name of the restart pointer file, this can be used to restart from an
      intermediate restart by appending the restart date and time in format YYYY-MM-DD-SSSSS
    

      Sets the pause frequency along with PAUSE_N
    

      Provides a numerical count for $PAUSE_OPTION.
    

      Pause the model at times specified by PAUSE_OPTION and PAUSE_N.
      Components 'pause' by writing a restart file.
    

      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
    

      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.
    

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.
    

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.
    

Logical to determine whether run has been submitted with the submit script or not

List of job ids for most recent case.submit

job priority for systems supporting this option

Logical to turn on short term archiving.
    If TRUE, short term archiving will be turned on.

Logical to run post-processing analysis tools.
    If TRUE, post-processing scripts will be run

system workload snapshot frequency (in seconds, if greater than 0; disabled otherwise)

The environment variables that will be loaded for this machine

The batch system type to use for this machine.

The individual environment variable entry for config_machines

The limits tag

The individual limit variable

Perl 5 library directory

The mpi run command associated with the machine configured batch system

The module system type defined for this machine

The module initialization path for module system defined for this machine

The module command path for module system defined for this machine

Output root directory for each machine.
                Base directory for build and run directories.
    

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.

Operating system - DO NOT EDIT UNLESS for userdefined machine - ignored once Macros has been created.

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.

email address of person (or group) that supports the build and port for this machine (do not edit)>

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 type

use NUOPC component interface

TRUE implies using the ESMF library specified by ESMF_LIBDIR or ESMFMKFILE

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.

TRUE implies always build model for openmp capability
      If FALSE, component libraries are built with OpenMP capability only if
      the NTHREADS_ setting for that component is greater than 1 in env_mach_pes.xml.
      If TRUE, the component libraries are always built with OpenMP capability.

TRUE implies always build model for openmp capability
      If FALSE, component libraries are built with OpenMP capability only if
      the NTHREADS_ setting for that component is greater than 1 in env_mach_pes.xml.
      If TRUE, the component libraries are always built with OpenMP capability.

If set will compile and submit with this gpu type enabled 

True=>compile the GPU code with OpenACC GPU flags 

True=>compile the GPU code with OpenMP GPU flags 

True=>compile the GPU code with KOKKOS GPU target 

If set will attach this script to the MPI run command, mapping
    different MPI ranks to different GPUs within the same compute node 

TRUE indicates that the ESMF Aware threading method is used

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.

 TRUE implies linking to the FTorch library to allow calls between
    fortran and a PyTorch model that has been saved to TorchScript.
    

location of libtorch and supporting libraries, may be supplied by ftorch interface if not present

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
    MPASLI. Note that Albany is a C++ library, so setting this
    variable to TRUE will involve the inclusion of C++ code in the
    MPASLI executable. This is currently only supported for certain
    machines.

TRUE implies linking to the MOAB library

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.

GNU make command

Number of processors for gmake

Status output: if TRUE, models have been built successfully. (DO NOT EDIT)>

Status: smp status of previous build, coded string. (DO NOT EDIT)

Status: smp status of current case, coded string (DO NOT EDIT)

Status: ninst status of previous build, coded string. (DO NOT EDIT)>

Status: ninst status of current case, coded string (DO NOT EDIT)

Status: of prior build. (DO NOT EDIT)

case build directory (set automatically to $EXEROOT, - DO NOT EDIT)

case lib directory (set automatically to $EXEROOT/lib - DO NOT EDIT)

case lib include directory (set automatically to $EXEROOT/lib/include - DO NOT EDIT)

Shared library root, (set automatically to $EXEROOT - DO NOT EDIT)

logical to diagnose model timing at the end of the run

Enables the papi hardware counters in gptl
    The papi library must be included in the build step for
    this to work.

      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"
    

      Determines the profiling level in ESMF log files
      by default, it is set to 0 (only run method execution timings)
    

Turns on component barriers for component timing.
          This variable is for testing and debugging only and should never
          be set for a production run.
    

pes or cores used relative to MAX_MPITASKS_PER_NODE for accounting (0 means TOTALPES is valid)

atmosphere grid - DO NOT EDIT (for experts only)

number of atmosphere cells in i direction - DO NOT EDIT (for experts only)

number of atmosphere cells in j direction - DO NOT EDIT (for experts only)

land grid - DO NOT EDIT (for experts only)

number of land cells in i direction - DO NOT EDIT (for experts only)

number of land cells in j direction - DO NOT EDIT (for experts only)

ocn grid - DO NOT EDIT (for experts only)

number of ocn cells in i direction - DO NOT EDIT (for experts only)

number of ocn cells in j direction - DO NOT EDIT (for experts only)

ice grid (must equal ocn grid) - DO NOT EDIT (for experts only)

number of ice cells in i direction - DO NOT EDIT (for experts only)

number of ice cells in j direction - DO NOT EDIT (for experts only)

number of ice thickness categories - DO NOT EDIT (set by CICE configure)

river runoff (rof) grid

number of rof cells in i direction - DO NOT EDIT (for experts only)

number of rof cells in j direction - DO NOT EDIT (for experts only)

glacier (glc) grid - DO NOT EDIT (for experts only)

number of glc cells in i direction - DO NOT EDIT (for experts only)

number of glc cells in j direction - DO NOT EDIT (for experts only)

wave model (wav) grid

number of wav cells in i direction - DO NOT EDIT (for experts only)

number of wav cells in j direction - DO NOT EDIT (for experts only)

grid mask - DO NOT EDIT (for experts only)

Latitude of grid location, in single column mode interpolate datasets to this location
          in single point mode assume all datasets are at this location

Longitude of grid location, in single column mode interpolate datasets to this location
          in single point mode assume all datasets are at this location

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. 

lnd domain file

path of lnd domain file

atm mesh file (full pathname)

lnd mesh file (full pathname)

rof mesh file (full pathname)

wav mesh file (full pathname)

ice mesh file (full pahtname)

ocn mesh file (full pathname)

glc mesh file (full pathname)

mask mesh file (full pathname)

lnd2rof flux mapping file

rof2lnd flux mapping file

rof2ocn runoff mapping file

rof2ocn runoff mapping file

ocn2wav state mapping file

wav2ocn state mapping file

Error tolerance for differences in fractions in domain checking

Error tolerance for differences in atm/land areas in domain checking

Error tolerance for differences in atm/land masks in domain checking

Error tolerance for differences in atm/land lat/lon in domain checking

Error tolerance for differences in ocean/ice lon/lat in domain checking

Error tolerance for differences in ocean/ice lon/lat in domain checking

Error tolerance for differences in ocean/ice lon/lat in domain checking

Machine name

Machines directory location

Path to an extra directory containing supplementary machines files

      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
    

      A regular expression to match machine node names to ACME machine.
    

      A regular expression to search for an indication that a run failure was caused by a node failure
      and should therefore be re-attempted.
    

      Proxy (if any) setting for http_proxy to allow web access on this machine.
    

      Indicates to case.submit that this is a test case.
    

      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
    

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

      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
    

Root directory for short term archiving. This directory must be visible to compute nodes.

override the mpi run command, do not include model executable

Allocate some spare nodes to handle node failures. The system will pick a reasonable number

Force this exact number of spare nodes to be allocated

number of tasks for each component

Number of tasks per instance for each component. DO NOT EDIT: Set automatically by case.setup based on NTASKS, NINST and MULTI_DRIVER

number of threads for each task in each component

ROOTPE (mpi task in MPI_COMM_WORLD) for each component

MULTI_DRIVER mode provides a separate driver/coupler component for each
    ensemble member.  All components must have an equal number of members.
    Multidriver is always true for nuopc, variable is left for compatibility with the mct driver

Number of instances of the model.
    

The mpi global processors stride associated with the mpi tasks for the a component

total number of MPI tasks (setup automatically - DO NOT EDIT)

maximum number of tasks/ threads allowed per node 

pes or cores per node for accounting purposes 

minimum memory request per node (currently only used on derecho)

maximum memory request per node (currently only used on derecho)

Number of CPU cores per GPU node used for simulation 

False=>assign only one MPI task per GPU; True=>assign multiple MPI tasks per GPU 

Number of GPUs per node used for simulation 

Maximum number of GPUs allowed per node 

pes or cores per node for accounting purposes 

PIO library version

PIO configure options, see PIO configure utility for details

pio rearranger communication type

pio rearranger communication flow control direction

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
    

pio rearranger communiation options (comp2io) : TRUE implies enable handshake 

pio rearranger communiation options (comp2io) : TRUE implies enable isend

pio rearranger communication max pending requests (io2comp) : -1 implies no bound on max pending requests 

pio rearranger communiation options (io2comp) : TRUE implies enable handshake

pio rearranger communiation options (io2comp) : TRUE implies enable isend

pio debug level

pio blocksize for box decompositions

Task count for asyncronous IO, only valid if PIO_ASYNC_INTERFACE is True

Stride of tasks for asyncronous IO, only valid if PIO_ASYNC_INTERFACE is True

RootPE of tasks for asyncronous IO, only valid if PIO_ASYNC_INTERFACE is True

pio buffer size limit for pnetcdf output

TRUE implies perform asynchronous i/o

pio io type

pio netcdf format (ignored for netcdf4p and netcdf4c)
    https://www.unidata.ucar.edu/software/netcdf/docs/data_type.html
    

     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 choice box=1, subset=2 

pio root processor relative to component root

      pio number of io tasks, if this value is -99 it will be computed based on PIO_STRIDE and
      number of tasks
    

Test type name

Test type descriptor

Testcase short name

Case base ID

Is first run of test

Arguments supplied to create_test

supplied or computed test id

Expected relative memory usage growth for test

Expected throughput deviation

Whether to generate a baseline

Whether to compare the baseline

The tagname we are comparing baselines against

The tagname we are comparing baselines against

The directory where baselines are stored

The tagname we are generating baselines for

The tagname we are comparing baselines against

Whether to clean the test after it is built/run

standard full pathname of the cprnc executable

determine if per ice thickness category fields are passed from ice to ocean - DO NOT EDIT (set by MOM6)

External script to be run before model completion

External script to be run after model completion

 Run the external tool pointed to by DATA_ASSIMILATION_SCRIPT after the model run completes 

 Number of model run - data assimilation steps to complete 

External script to be run after model completion

whether the case uses an external workflow driver 

Store user override for queue

Store user override for walltime

The machine queue in which to submit the job.  Default determined in config_machines.xml can be overwritten by testing

The machine wallclock setting.  Default determined in config_machines.xml can be overwritten by testing

Override the batch submit command this job. Do not include executable or dependencies

project for project-sensitive build and run paths, and job scripts

project to charge in scripts if different from PROJECT

Apparent version of the model used for this case

whether the PROJECT value is required on this machine

if true, all data models are expected to get input sent back from the mediator

if true, create ESMF PET log files even if there is no error encountered 

Remote git repository used for this case

Support libraries required

add aoflux calculation to runseq

turns on coupler bit-for-bit reproducibility with varying pe counts