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.
Macro Generation Settings (used by setup)
| Variable Name |
File Name |
 OSoperating system - DO NOT EDIT UNLESS for userdefined machine - ignored once Macros has been created | env_build.xml |
 COMPILERSmachine 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 |
 COMPILERMachine 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 |
 MPILIBSsupported 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 |
 MPILIBmpi 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_OPTSPIO configure options, see PIO configure utility for details | env_build.xml |
Build Control Settings (used by $CASE.build)
| Variable Name |
File Name |
 CESMSCRATCHROOTscratch 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 |
 EXEROOTcase 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_BYemail address of person (or group) that supports the build and port for this machine (do not edit) | env_build.xml |
 CALENDARcalendar type
Valid Values: NO_LEAP,GREGORIAN | env_build.xml |
 COMP_INTERFACEuse MCT or ESMF component interfaces
Valid Values: MCT,ESMF | env_build.xml |
 USE_ESMF_LIBTRUE implies using the ESMF library specified by ESMF_LIBDIR or ESMFMKFILE
Valid Values: TRUE,FALSE | env_build.xml |
 DEBUGTRUE 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_THREADEDTRUE 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_TRILINOSTRUE 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_JNumber of processors for gmake | env_build.xml |
CAM build-time settings
| Variable Name |
File Name |
 CAM_CONFIG_OPTSCAM configure options, see CAM configure utility for details .
Provides option(s) for the CAM configure utility.
CAM_CONFIG_OPTS are normally set as compset variables (e.g., -phys cam3_5_1 -chem waccm_mozart)
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. | env_build.xml |
 CAM_DYCORECAM dynamical core
Valid Values: eul,fv,se | env_build.xml |
CICE build-time settings
| Variable Name |
File Name |
 CICE_MODEOption to the CICE configure utility for the -mode argument (default is prognostic)
Valid Values: prognostic,prescribed,thermo_only | env_build.xml |
 CICE_CONFIG_OPTSCICE 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_DECOMPif 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_BLCKXSize 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_BLCKYSize 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_MXBLCKSMax 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_DECOMPTYPEcice 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_DECOMPSETTINGcice 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 |
CLM build-time settings
| Variable Name |
File Name |
 CLM_CONFIG_OPTSCLM configure options . Provides option(s) for the CLM configure utility.
CLM_CONFIG_OPTS are normally set as compset variables (e.g., -bgc cn)
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 |
POP2 build-time settings
| Variable Name |
File Name |
 OCN_SUBMODELOptional ocean submodel option. Any one of: moby | env_build.xml |
 OCN_TRACER_MODULESOptional ocean tracers. Valid values are Any combination of: iage cfc ecosys | env_build.xml |
 OCN_TRACER_MODULES_OPTOptional ocean tracers option. Any one of: darwin quota mono | env_build.xml |
 POP_AUTO_DECOMPif false, user must set the POP decomp, otherwise cesm_setup script sets it
Valid Values: true,false | env_build.xml |
 POP_BLCKXSize of pop block in first horiz dimension (do not edit if POP_AUTO_DECOMP is true) | env_build.xml |
 POP_BLCKYSize of pop block in second horiz dimension (do not edit if POP_AUTO_DECOMP is true) | env_build.xml |
 POP_NX_BLOCKSNumber of pop blocks in first horiz dimension (do not edit if POP_AUTO_DECOMP is true) | env_build.xml |
 POP_NY_BLOCKSNumber of pop blocks in second horiz dimension (do not edit if POP_AUTO_DECOMP is true) | env_build.xml |
 POP_MXBLCKSMax number of pop blocks per processor (do not edit if POP_AUTO_DECOMP is true) | env_build.xml |
 POP_DECOMPTYPEpop block distribution type (do not edit if POP_AUTO_DECOMP is true) | env_build.xml |
Build Status (For Documentation Only: DO NOT EDIT)
| Variable Name |
File Name |
 BUILD_COMPLETEStatus output: if TRUE, models have been built successfully. (DO NOT EDIT)
Valid Values: TRUE,FALSE | env_build.xml |
 SMP_BUILDStatus: smp status of previous build, coded string. (DO NOT EDIT) | env_build.xml |
 SMP_VALUEStatus: smp status of current case, coded string (DO NOT EDIT) | env_build.xml |
 NINST_BUILDStatus: ninst status of previous build, coded string. (DO NOT EDIT) | env_build.xml |
 NINST_VALUEStatus: ninst status of current case, coded string (DO NOT EDIT) | env_build.xml |
 BUILD_STATUSStatus: of prior build. (DO NOT EDIT) | env_build.xml |
Build Derived Directories (DO NOT EDIT)
| Variable Name |
File Name |
 OBJROOTcase build directory (set automatically to $EXEROOT, - DO NOT EDIT) | env_build.xml |
 LIBROOTcase lib directory (set automatically to $EXEROOT/lib - DO NOT EDIT) | env_build.xml |
 INCROOTcase lib include directory (set automatically to $EXEROOT/lib/include - DO NOT EDIT) | env_build.xml |
 SHAREDLIBROOTShared library root, (set automatically to $EXEROOT - DO NOT EDIT) | env_build.xml |
 SHAREDLIBROOTDIRShared library root directory, neeed for cleaning shared builds (set automatically to $EXEROOT - DO NOT EDIT) | env_build.xml |
Model Grid Specification (Experts Only: in general DO NOT EDIT)
| Variable Name |
File Name |
 GRIDCESM grid - DO NOT EDIT (for experts only) | env_build.xml |
 ATM_GRIDatmosphere grid - DO NOT EDIT (for experts only) | env_build.xml |
 ATM_NXnumber of atmosphere cells in i direction - DO NOT EDIT (for experts only) | env_build.xml |
 ATM_NYnumber of atmosphere cells in j direction - DO NOT EDIT (for experts only) | env_build.xml |
 LND_GRIDland grid - DO NOT EDIT (for experts only) | env_build.xml |
 LND_NXnumber of land cells in i direction - DO NOT EDIT (for experts only) | env_build.xml |
 LND_NYnumber of land cells in j direction - DO NOT EDIT (for experts only) | env_build.xml |
 OCN_GRIDocn grid - DO NOT EDIT (for experts only) | env_build.xml |
 OCN_NXnumber of ocn cells in i direction - DO NOT EDIT (for experts only) | env_build.xml |
 OCN_NYnumber of ocn cells in j direction - DO NOT EDIT (for experts only) | env_build.xml |
 ICE_GRIDice grid (must equal ocn grid) - DO NOT EDIT (for experts only) | env_build.xml |
 ICE_NXnumber of ice cells in i direction - DO NOT EDIT (for experts only) | env_build.xml |
 ICE_NYnumber of ice cells in j direction - DO NOT EDIT (for experts only) | env_build.xml |
 ROF_GRID | env_build.xml |
 ROF_NXnumber of rof cells in i direction - DO NOT EDIT (for experts only) | env_build.xml |
 ROF_NYnumber of rof cells in j direction - DO NOT EDIT (for experts only) | env_build.xml |
 GLC_GRID | env_build.xml |
 GLC_NXnumber of glc cells in i direction - DO NOT EDIT (for experts only) | env_build.xml |
 GLC_NYnumber of glc cells in j direction - DO NOT EDIT (for experts only) | env_build.xml |
 WAV_GRID | env_build.xml |
 WAV_NXnumber of wav cells in i direction - DO NOT EDIT (for experts only) | env_build.xml |
 WAV_NYnumber of wav cells in j direction - DO NOT EDIT (for experts only) | env_build.xml |
 MASK_GRIDgrid mask - DO NOT EDIT (for experts only) | env_build.xml |