This page contains the complete list of xml variables in env_build.xml.
These variables are locked after $CASE.build is called.
They are grouped by categories designed to aid browsing. Clicking on the name
of a variable will display descriptive information. If search terms
are entered in the text box below, the list will be condensed to
contain only matched variables.
Variable Name |
File Name |
OS
operating system - DO NOT EDIT UNLESS for userdefined machine - ignored once Macros has been created
|
env_build.xml |
COMPILERS
machine compiler (must match one the supported compilers) - ignored once Macros has been created .
Set in $CCSMROOT/scripts/ccsm_utils/Machines/config_machines.xml for each machine.
|
env_build.xml |
COMPILER
Machine compiler (must match one the supported compilers) .
Set in $CCSMROOT/scripts/ccsm_utils/Machines/config_machines.xml for each supported machine.
Must be explicitly set in env_build.xml for userdefined machine.
|
env_build.xml |
MPILIBS
supported mpi libraries for target machine - set in config_machines.xml - (DO NOT EDIT) .
Set in $CCSMROOT/scripts/ccsm_utils/Machines/config_machines.xml for each supported machine.
Must be explicitly set in env_build.xml for userdefined machine.
|
env_build.xml |
MPILIB
mpi library (must match one of the supported libraries) - ignored once Macros has been created .
Set in $CCSMROOT/scripts/ccsm_utils/Machines/config_machines.xml for each supported machine.
Must be explicitly set in env_build.xml for userdefined machine.
|
env_build.xml |
PIO_CONFIG_OPTS
PIO configure options, see PIO configure utility for details
|
env_build.xml |
Variable Name |
File Name |
CESMSCRATCHROOT
scratch root directory for each machine. For now, primarily used for shared library builds .
The CESM 'scratchroot' root directory. Base diretory for build and run directories.
|
env_build.xml |
EXEROOT
case executable root directory (executable is $EXEROOT/cesm.exe, component libraries are in $EXEROOT/bld) .
The CESM executable root directory. 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, CESM 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 mass storage device
EXEROOT is set in CCSMROOT/scripts/ccsm_utils/Machines/config_machines.xml
for each supported machine. Must explicitly set it in env_build.xml for a
userdefined machine.
|
env_build.xml |
SUPPORTED_BY
email address of person (or group) that supports the build and port for this machine (do not edit)
|
env_build.xml |
CALENDAR
calendar type
Valid Values: NO_LEAP,GREGORIAN
|
env_build.xml |
COMP_INTERFACE
use MCT or ESMF component interfaces
Valid Values: MCT,ESMF
|
env_build.xml |
USE_ESMF_LIB
TRUE implies using the ESMF library specified by ESMF_LIBDIR or ESMFMKFILE
Valid Values: TRUE,FALSE
|
env_build.xml |
DEBUG
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.
The default is FALSE.
Valid Values: TRUE,FALSE
|
env_build.xml |
BUILD_THREADED
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.
The default is FALSE.
Valid Values: TRUE,FALSE
|
env_build.xml |
USE_TRILINOS
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 CESM
executable. This is currently only supported for certain machines.
Valid Values: TRUE,FALSE
|
env_build.xml |
GMAKE
|
env_build.xml |
GMAKE_J
Number of processors for gmake
|
env_build.xml |
Variable Name |
File Name |
CICE_MODE
Option to the CICE configure utility for the -mode argument (default is prognostic)
Valid Values: prognostic,prescribed,thermo_only
|
env_build.xml |
CICE_CONFIG_OPTS
CICE configure options, see CICE configure utility for details .
Provides option(s) for the CLM configure utility.
CICE_CONFIG_OPTS are normally set as compset variables (e.g., -ntr_aero 3)
and in general should not be modified for supported compsets.
It is recommended that if you want to modify this value for your experiment,
you should use your own user-defined component sets via using create_newcase
with a compset_file argument.
This is an advanced flag and should only be used by expert users.
|
env_build.xml |
CICE_AUTO_DECOMP
if false, user must set the CICE decomp, otherwise cesm_setup script sets it .
This is for experts only - if CICE_AUTO_DECOMP is set to false, then
can manually set the values of CICE_BLCKX, CICE_BLCKY, CICE_MXBLCKS,
CICE_DECOMPTYPE, and CICE_DECOMPSETTING
Valid Values: true,false
|
env_build.xml |
CICE_BLCKX
Size of cice block in first horiz dimension (do not edit if CICE_AUTO_DECOMP is true) .
This is for experts only - automatically set if CICE_AUTO_DECOMP is true,
to set this value, must first set CICE_AUTO_DECOMP to false
|
env_build.xml |
CICE_BLCKY
Size of cice block in second horiz dimension (do not edit if CICE_AUTO_DECOMP is true) .
This is for experts only - automatically set if CICE_AUTO_DECOMP is true,
to set this value, must first set CICE_AUTO_DECOMP to false
|
env_build.xml |
CICE_MXBLCKS
Max number of cice blocks per processor (do not edit if CICE_AUTO_DECOMP is true) .
This is for experts only - automatically set if CICE_AUTO_DECOMP is true,
to set this value, must first set CICE_AUTO_DECOMP to false
|
env_build.xml |
CICE_DECOMPTYPE
cice block distribution type (do not edit if CICE_AUTO_DECOMP is true) .
This is for experts only - automatically set if CICE_AUTO_DECOMP is true,
to set this value, must first set CICE_AUTO_DECOMP to false
|
env_build.xml |
CICE_DECOMPSETTING
cice decomp setting for decomp type (do not edit if CICE_AUTO_DECOMP is true) .
This is for experts only - automatically set if CICE_AUTO_DECOMP is true,
to set this value, must first set CICE_AUTO_DECOMP to false
|
env_build.xml |
Variable Name |
File Name |
OCN_SUBMODEL
Optional ocean submodel option. Any one of: moby
|
env_build.xml |
OCN_TRACER_MODULES
Optional ocean tracers. Valid values are Any combination of: iage cfc ecosys
|
env_build.xml |
OCN_TRACER_MODULES_OPT
Optional ocean tracers option. Any one of: darwin quota mono
|
env_build.xml |
POP_AUTO_DECOMP
if false, user must set the POP decomp, otherwise cesm_setup script sets it
Valid Values: true,false
|
env_build.xml |
POP_BLCKX
Size of pop block in first horiz dimension (do not edit if POP_AUTO_DECOMP is true)
|
env_build.xml |
POP_BLCKY
Size of pop block in second horiz dimension (do not edit if POP_AUTO_DECOMP is true)
|
env_build.xml |
POP_NX_BLOCKS
Number of pop blocks in first horiz dimension (do not edit if POP_AUTO_DECOMP is true)
|
env_build.xml |
POP_NY_BLOCKS
Number of pop blocks in second horiz dimension (do not edit if POP_AUTO_DECOMP is true)
|
env_build.xml |
POP_MXBLCKS
Max number of pop blocks per processor (do not edit if POP_AUTO_DECOMP is true)
|
env_build.xml |
POP_DECOMPTYPE
pop block distribution type (do not edit if POP_AUTO_DECOMP is true)
|
env_build.xml |
Variable Name |
File Name |
BUILD_COMPLETE
Status output: if TRUE, models have been built successfully. (DO NOT EDIT)
Valid Values: TRUE,FALSE
|
env_build.xml |
SMP_BUILD
Status: smp status of previous build, coded string. (DO NOT EDIT)
|
env_build.xml |
SMP_VALUE
Status: smp status of current case, coded string (DO NOT EDIT)
|
env_build.xml |
NINST_BUILD
Status: ninst status of previous build, coded string. (DO NOT EDIT)
|
env_build.xml |
NINST_VALUE
Status: ninst status of current case, coded string (DO NOT EDIT)
|
env_build.xml |
BUILD_STATUS
Status: of prior build. (DO NOT EDIT)
|
env_build.xml |
Variable Name |
File Name |
GRID
CESM grid - DO NOT EDIT (for experts only)
|
env_build.xml |
ATM_GRID
atmosphere grid - DO NOT EDIT (for experts only)
|
env_build.xml |
ATM_NX
number of atmosphere cells in i direction - DO NOT EDIT (for experts only)
|
env_build.xml |
ATM_NY
number of atmosphere cells in j direction - DO NOT EDIT (for experts only)
|
env_build.xml |
LND_GRID
land grid - DO NOT EDIT (for experts only)
|
env_build.xml |
LND_NX
number of land cells in i direction - DO NOT EDIT (for experts only)
|
env_build.xml |
LND_NY
number of land cells in j direction - DO NOT EDIT (for experts only)
|
env_build.xml |
OCN_GRID
ocn grid - DO NOT EDIT (for experts only)
|
env_build.xml |
OCN_NX
number of ocn cells in i direction - DO NOT EDIT (for experts only)
|
env_build.xml |
OCN_NY
number of ocn cells in j direction - DO NOT EDIT (for experts only)
|
env_build.xml |
ICE_GRID
ice grid (must equal ocn grid) - DO NOT EDIT (for experts only)
|
env_build.xml |
ICE_NX
number of ice cells in i direction - DO NOT EDIT (for experts only)
|
env_build.xml |
ICE_NY
number of ice cells in j direction - DO NOT EDIT (for experts only)
|
env_build.xml |
ROF_GRID
|
env_build.xml |
ROF_NX
number of rof cells in i direction - DO NOT EDIT (for experts only)
|
env_build.xml |
ROF_NY
number of rof cells in j direction - DO NOT EDIT (for experts only)
|
env_build.xml |
GLC_GRID
|
env_build.xml |
GLC_NX
number of glc cells in i direction - DO NOT EDIT (for experts only)
|
env_build.xml |
GLC_NY
number of glc cells in j direction - DO NOT EDIT (for experts only)
|
env_build.xml |
WAV_GRID
|
env_build.xml |
WAV_NX
number of wav cells in i direction - DO NOT EDIT (for experts only)
|
env_build.xml |
WAV_NY
number of wav cells in j direction - DO NOT EDIT (for experts only)
|
env_build.xml |
MASK_GRID
grid mask - DO NOT EDIT (for experts only)
|
env_build.xml |