Earth System Modeling Framework (ESMF)

Copyright (c) 2002-2020 University Corporation for Atmospheric Research, Massachusetts Institute of Technology, Geophysical Fluid Dynamics Laboratory, University of Michigan, National Centers for Environmental Prediction, Los Alamos National Laboratory, Argonne National Laboratory, NASA Goddard Space Flight Center. All rights reserved.

Hello and welcome to ESMF.

• The ESMF User's Guide contains information on building and installing ESMF.
• The ESMF Reference Manual contains information on the architecture of ESMF, example code, and details of the API (Application Programming Interface).
• Please contact [email protected] with any questions or problems.

Downloading ESMF

• The ESMF library source code is also available for download at:
  • https://github.com/esmf-org/esmf/releases

Building ESMF

• To build ESMF from source consult the Building ESMF section of the ESMF User's Guide.
• For testing ESMF, see Testing makefile targets.
• Pre-built binaries for ESMF and ESMPy are also available on conda-forge (note Windows is not supported):

conda create -c conda-forge -n <env> esmf esmpy

Linking to ESMF

• To link your application to an ESMF installation follow instructions located in Compiling and Linking User Code against an ESMF Installation.

Add-On Packages

Several add-on packages are included with ESMF under ./src/addon:

• ESMPy - Python interface to ESMF.
• MAPL - Usability layer developed under the NASA Modeling Analysis and Prediction (MAP) program.
• NUOPC - Interoperability layer developed under the National Unified Operational Prediction Capability (NUOPC) program.

See each addon package for a specific README file.

More Help

Information about the ESMF project can be found at the ESMF web site:

• https://www.earthsystemmodeling.org/

Software documentation for the last public release is at:

• http://earthsystemmodeling.org/doc/ -> Users -> User Docs

Software documentation for all releases is at:

• http://earthsystemmodeling.org/static/releases.html