FAQ: Frequently Asked Questions
About ESMF
- When did ESMF begin and will it end?
- Is ESMF being used in any real codes?
- What platforms does ESMF run on?
- What's the performance overhead of using ESMF?
- What geophysical models does ESMF come with?
Getting Started
- What's the best way to get started?
- How does my code need to change to adopt ESMF?
- What are my download options?
- What does it mean to be ESMF compliant?
Support
- How do I join the ESMF mailing lists?
- I have sent an email to esmf_support but have not heard back from anyone, what should I do?
- How often are tutorials conducted?
- Is there support forum so that I can talk to other users?
Development
- How do I make a software contribution?
- How do I ask for a new feature?
- How do I find out if a method has been tested?
- How do I tell which beta snapshot I have downloaded?
About ESMF
When did ESMF begin and will it end?
The ESMF project started in early 2002. Its current NASA and Department of Defense funding ends in 2010. It is also funded through NCAR core funds, which continue indefinitely. We are constantly exploring new opportunities, and expect ESMF to be around for a long time!
Is ESMF being used in any real codes?
Yes! ESMF is being used by the National Weather Service Global Forecast System model at the National Centers for Environmental Prediction, by the GEOS-5 atmospheric general circulation model at NASA Goddard, the coupled HYbrid Coordinate Ocean Model and CICE sea ice model at the Naval Research Laboratory, and many more. Overall there are more than three dozen ESMF-ized components in the community that are at least at the working prototype stage.
What's the performance overhead of using ESMF?
It's typical to see a few percent overhead in adopting the ESMF superstructure. Many see no discernible increase in execution time. There are several detailed reports on ESMF performance.
What does it mean to be ESMF compliant?
There is currently no official, multi-agency definition of ESMF compliance. There is a working definition, which outlines the steps to ESMF adoption for single component applications and for multi-component applications.
What platforms does ESMF run on?
ESMF runs on most high performance computing platforms. Since platforms change frequently, not all versions of ESMF run on every platform.
What geophysical models does ESMF come with?
ESMF does not come with any numerical models. The opposite is true, numerical models are being restructured to included ESMF, thereby making them into ESMF components. ESMF does not provide the source code for these components.
Getting Started
What's the best way to get started?
If you're a modeler and have a specific model or model segment that you're interested in turning into an ESMF component, write to us at esmf_support@ucar.edu. We can talk about what ESMF can do for you, how to partition a system into components, and steps in the adoption process. If you're a technical person and would like to participate in (or just listen in on) ESMF development discussions, join the ESMF Joint Specification Team (JST) mailing list, esmf_jst@ucar.edu. If you prefer talking in real-time, we have weekly telecons and an annual community meeting. These are announced on this Web site and on the JST list. If you would just like highlights from time to time on how ESMF is doing, join the esmf_info@ucar.edu list.
How does my code need to change to adopt ESMF?
The changes that are typically requred to convert a code to ESMF are described in the ESMF User's Guide: How to Adapt Applications for ESMF. That's an overview that should help get you started.What are my download options?
Latest Public Release
The latest public release is always available from our download page.
All Releases
All releases are available under the download tab. Select "View all Releases" on the left navigation menu.
Beta snapshots for developers
You can get CVS snapshots through SourceForge's anonymous pserver. The method is a three step process:
- cvs -d:pserver:anonymous@esmf.cvs.sourceforge.net:/cvsroot/esmf login
- when prompted for a password, just hit return
- cvs -z3 -d:pserver:anonymous@esmf.cvs.sourceforge.net:/cvsroot/esmf co -P -rSNAPSHOT_TAG esmf
Source without documentation (for developers)
- cvs -d:pserver:anonymous@esmf.cvs.sourceforge.net:/cvsroot/esmf login
- when prompted for a password, just hit return
- cvs -z3 -d:pserver:anonymous@esmf.cvs.sourceforge.net:/cvsroot/esmf co -P -rSNAPSHOT_TAG esmf_no_docs
The community data portal
All releases are available for download from the CDP. Select ESMF from the list of codes available and then register for the site.
Support
How do I join the ESMF mailing lists?
Click on the links below for the three primary ESMF mailing lists.
| Name | Description |
|---|---|
| esmf_community@ucar.edu | Notification List for ESMF Community Meetings |
| esmf_info@ucar.edu | ESMF Progress and Events |
| esmf_jst@ucar.edu | Joint Specification Team Discussion |
I have sent an email to esmf_support but have not heard back from anyone, what should I do?
Your support emails are very important to us, and we try to respond to them quickly even if it is just to let you know that we have received your request. The esmf_support mailing list is protected, however, and only those people who have downloaded the software, or who have been manually added are allowed to post. We check for pending posts on a weekly basis. If you have been waiting more than a week, please submit your post again, it is likely that it was not received.
How often are tutorials conducted?
Tutorials are conducted on an as needed basis. If you are interested in a tutorial, please send an email to emsf_support@ucar.edu.
Is there support forum so that I can talk to other users?
ESMF currently does not have a user forum. We have been considering such a feature. If a user forum would be useful to you, please drop us a line at esmf_support@ucar.edu
Development
How do I make a software contribution?
Write to esmf_support@ucar.edu and let us know what you're interested in contributing. We strongly encourage you to do this before you get started! We can point you to the processes and conventions you need to follow in order to get your software into the ESMF source code smoothly. Details are included in the ESMF Developer's Guide.
How do I ask for a new feature?
Write to esmf_support@ucar.edu. If you'd like to talk with ESMF developers and other users about your feature request, we can address it during one of our weekly telecons (write to esmf_support@ucar.edu to get on the schedule). We also have quarterly Change Review Board (CRB) telecons during which people can advocate that their feature be considered for inclusion on the development schedule. That's a good way to get your feature request on track for implementation!
How do I find out if a method has been tested?
These lists are automatically generated on a weekly basis.
How do I tell which beta snapshot I have downloaded?
You can get to this information by taking a look at any of the "./CVS/Entries" files in any of the directories of the ESMF source tree that you checked out (via CVS beta snapshots). You will see the exact CVS tag as part of the text in the "Entries" files.
