Contents

• 1 What is the Earth System Modeling Framework?
• 2 The ESMF User's Guide
• 3 How to Contact User Support and Find Additional Information
• 4 How to Submit Comments, Bug Reports, and Feature Requests
• 5 Quick Start
  • 5.1 Downloading ESMF
    • 5.1.1 From the ESMF web site
    • 5.1.2 From the SourceForge website
  • 5.2 Unpacking the download
  • 5.3 Directory Structure
  • 5.4 Building ESMF
    • 5.4.1 Environment variables
    • 5.4.2 GNU make
    • 5.4.3 gmake info
    • 5.4.4 Building makefile targets
    • 5.4.5 Testing makefile targets
    • 5.4.6 Building and using bundled ESMF Command Line Tools
  
  
• 6 Compiling and Linking User Code against an ESMF Installation
  • 6.1 esmf.mk method
  • 6.2 CMake method
  
  
• 7 Debugging of ESMF User Applications
• 8 Using Bundled ESMF Command Line Tools
• 9 Building and Installing the ESMF
  • 9.1 ESMF Download Options
  • 9.2 Acquiring Development Snapshots
  • 9.3 System Requirements
  • 9.4 Third Party Libraries
    • 9.4.1 LAPACK
    • 9.4.2 NetCDF
    • 9.4.3 Parallel-NetCDF
    • 9.4.4 PIO
    • 9.4.5 Accelerator Software Stacks
    • 9.4.6 XERCES
    • 9.4.7 yaml-cpp
    • 9.4.8 MOAB
  • 9.5 ESMF Environment Variables
  • 9.6 Supported Platforms
  • 9.7 Building the ESMF Library
  • 9.8 Building the ESMF Documentation
  • 9.9 Installing the ESMF
  
  
• 10 Porting the ESMF
  • 10.1 The ESMF Build System
    • 10.1.1 General structure
    • 10.1.2 Build configuration
    • 10.1.3 Source code configuration
  • 10.2 Porting the ESMF to New Platforms
    • 10.2.1 Customizing the build_rules.mk fragment
    • 10.2.2 Customizing ESMC_Conf.h and ESMF_Conf.inc
  • 10.3 Shared Object Libraries
  • 10.4 Customized SITE Files
  
  
• 11 Validating an ESMF Build
  • 11.1 Running ESMF Self-Tests
    • 11.1.1 Setting up ESMF to run test suite applications
    • 11.1.2 Running ESMF unit tests
    • 11.1.3 Running ESMF system tests
  • 11.2 Running ESMF Examples
    • 11.2.1 Example source code
    • 11.2.2 Building and running examples
  • 11.3 Validating an existing ESMF installation
  
  
• 12 Architectural Overview
  • 12.1 Key Concepts
    • 12.1.1 Modularity
    • 12.1.2 Flexibility
    • 12.1.3 Hierarchical organization
    • 12.1.4 Communication within Components
    • 12.1.5 Uniform communication API
  • 12.2 Superstructure
    • 12.2.1 Import and export State classes
    • 12.2.2 Interface standards
    • 12.2.3 Gridded Component class
    • 12.2.4 Coupler Component class
    • 12.2.5 Flexible data and control flow
  • 12.3 Infrastructure
    • 12.3.1 FieldBundle, Field and Array classes
    • 12.3.2 Grid class
    • 12.3.3 Time and Calendar management
    • 12.3.4 Config resource file manager
    • 12.3.5 DELayout and virtual machine
    • 12.3.6 Logging and error handling
    • 12.3.7 File input and output
  
  
• 13 How to Adapt Applications for ESMF
  • 13.1 Individual Components
  • 13.2 Full Application
  
  
• 14 Glossary
• Bibliography