Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit



Failed to load latest commit information.
Latest commit message
Commit time

ESMF Doc Build ESMPy Doc Build

Earth System Modeling Framework (ESMF)

Copyright (c) 2002-2022 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 with any questions or problems.

Downloading ESMF

The ESMF library source code is available for download at GitHub:

Building ESMF

To build ESMF from source:

Pre-built ESMF

Pre-built binaries for ESMF and ESMPy are available through a number of channels:

  • Docker Hub: Under ESMF Organization. To install locally, run:

    docker run -it --rm esmf/esmf-build-release:latest

    Replace latest in the above command with a valid version, like 8.4.0, in order to access a specific ESMF version.

  • Anaconda Conda-Forge: Under conda-forge/esmpy. To install locally (note Windows is not supported), run:

    conda create -n esmpy -c conda-forge esmpy

Running ESMF Command Line Tools

Linking to ESMF

Add-On Packages

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

  • ESMPy - Python interface to ESMF.
  • ESMX - A layer providing the Earth System Model eXecutable. The ESMX layer is built on top of ESMF and NUOPC.
  • 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:

Software documentation for the last release:

Software documentation for all releases:



The Earth System Modeling Framework (ESMF) is a suite of software tools for developing high-performance, multi-component Earth science modeling applications.







No packages published