The following packages are required to work with ESMPy:
The following packages are optional:
Getting the code¶
The ESMPy source code can be downloaded from the ESMF git repository.
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).
ESMPy conda packages are available through the conda-forge channel:
conda create -n esmpy -c conda-forge esmpy
Specific versions of the conda package can be installed like this:
conda create -n esmpy -c conda-forge esmpy=8.1.0
Development versions can be found in the
conda create -n esmpy -c conda-forge -c esmpy_dev esmpy
Installing ESMPy from Source¶
When installing from source, ESMPy requires a pointer to a file named esmf.mk that is generated during an ESMF installation. The path of this file is:
ESMFMKFILE flag is set when building ESMPy then it will not need to be
referenced again. If not, an environment variable of the same name must be set
with the path to the esmf.mk file every time a new shell is initiated.
ESMPy can be installed in a custom location using the
--install-base flags to the install command. If this
is done, then this location needs to be added to the
variable every time a new shell is initiated. If a
custom install location is not specified, ESMPy will be installed in the
standard Python package installation directory on that particular machine.
An installation of ESMPy in the default location for Python packages can be done with the following command issued from the top level ESMPy directory:
python setup.py build --ESMFMKFILE=<DIR_TO_esmf.mk>/esmf.mk install
custom install location:
python setup.py build --ESMFMKFILE=<DIR_TO_esmf.mk>/esmf.mk python setup.py install --prefix=<custom_install_location> setenv PYTHONPATH <custom_install_location>/lib/\*/site_packages
Please contact firstname.lastname@example.org with any questions.
To use ESMPy in an external program, import it with:
The ESMPy testing is done with the nose package, both in serial and parallel. The nose commands are wrapped in the following ESMPy targets:
python setup.py test python setup.py test_examples python setup.py test_regrid_from_file python setup.py test_parallel python setup.py test_examples_parallel python setup.py test_regrid_from_file_parallel
regrid_from_file tests can take up a lot of memory and bandwidth.
test_regrid_from_file_dryrun command will simply download the test
files without actually running them (allowing the stress on the machine to
be applied to bandwidth first, and then memory).
Alternatively, individual tests can be run with nose using the following format:
ESMPy doesn’t include many aspects of ESMF, including components, field bundles, time management, etc. The limitations listed here are relative to ESMF offline and integrated regridding capabilities.
ESMPy cannot use an ESMF installation that is built with external LAPACK support.
Coordinates cannot be retrieved from the elements of a
Mesh. This can affect the ability to set
Fieldvalues on a source
Meshcreated from file when using conservative regridding.
Gridsupport is limited to cubed-sphere grids created on 6 processors. A cubed-sphere grid can be created on any number of processors, but only when it is created on 6 processors will the coordinates be retrievable for the entire object. A
Fieldcreated from a cubed-sphere
Gridcannot be written to file in parallel.
There is no
FieldBundleclass, only single
Nightly regression testing is limited to a small subset of the ESMF test platforms, including Darwin and Linux running gfortran with openMPI.