Config Files

Overview

The config_files.xml file is the main entrypoint for CIME to load a models configuration.

The contents define entry elements that describe various variables used to configure the model.

These varaibles defines supported compsets, components, grids, machines, batch queue, and compiler macros.

These config_files.xml are stored in $CIMEROOT/CIME/data/config/<model>/.

Note

The preferred method of adding a new model to CIME is to add a config_files.xml with a single entry; MODEL_CONFIG_FILES to the CIME repository.

Using MODEL_CONFIG_FILES allows the models configuration to live outside the CIME repository.

Usage

The entries in config_files.xml will describe the following variables.

• ARCHIVE_SPEC_FILE
• BATCH_SPEC_FILE
• BUILD_LIB_FILE
• CASEFILE_HEADERS
• CMAKE_MACROS_DIR
• COMPSETS_SPEC_FILE
• COMP_ROOT_DIR_*
• CONFIG_*_FILE
• CONFIG_CPL_FILE_MODEL_SPECIFIC
• CONFIG_TESTS_FILE
• GRIDS_SPEC_FILE
• INPUTDATA_SPEC_FILE
• MACHINE_SPEC_FILE
• MODEL
• NAMELIST_DEFINITION_FILE
• PES_SPEC_FILE
• PIO_SPEC_FILE
• SYSTEM_TESTS_DIR
• TESTS_MODS_DIR
• TESTS_SPEC_FILE
• USER_MODS_DIR
• WORKFLOW_SPEC_FILE

Schema Definition

Version 3.0

This version will reference another config_files.xml file that can be stored in the models repository.

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="definitions_variables.xsl" ?>
<entry_id version="3.0">
   <entry id="MODEL_CONFIG_FILES">
      <type>char</type>
      <default_value>$SRCROOT/cime_config/config_files.xml</default_value>
      <group>case_last</group>
      <file>env_case.xml</file>
      <desc>file containing paths</desc>
   </entry>
</entry_id>