README.md

Earth System Modeling Framework (ESMF)

Copyright (c) 2002-2024 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).
• Visit the ESMF Web Site for a general overview of the project.
• Please contact [email protected] with any questions or problems.

Downloading ESMF

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

• 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 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.8.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

• To use the ESMF command line tools follow the instructions located in Using Bundled ESMF Command Line Tools.

Linking to ESMF

• To build your application against an ESMF installation follow the 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.
• 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:

• https://www.earthsystemmodeling.org/

Software documentation for the last release:

• http://earthsystemmodeling.org/doc/

Software documentation for all releases:

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

Support:

• http://earthsystemmodeling.org/support/