Add package for ESMF (#2831)

* Add package for ESMF

* Apparently mvapich2 is supported?

1 files changed, 253 insertions, 0 deletions

diff --git a/var/spack/repos/builtin/packages/esmf/package.py b/var/spack/repos/builtin/packages/esmf/package.py
new file mode 100644
index 0000000000..9d68d17846
--- /dev/null
+++ b/var/spack/repos/builtin/packages/esmf/package.py
@@ -0,0 +1,253 @@
+##############################################################################
+# Copyright (c) 2013-2016, Lawrence Livermore National Security, LLC.
+# Produced at the Lawrence Livermore National Laboratory.
+#
+# This file is part of Spack.
+# Created by Todd Gamblin, tgamblin@llnl.gov, All rights reserved.
+# LLNL-CODE-647188
+#
+# For details, see https://github.com/llnl/spack
+# Please also see the LICENSE file for our notice and the LGPL.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License (as
+# published by the Free Software Foundation) version 2.1, February 1999.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the IMPLIED WARRANTY OF
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the terms and
+# conditions of the GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+##############################################################################
+from spack import *
+import os
+
+
+class Esmf(Package):
+    """The Earth System Modeling Framework (ESMF) is high-performance, flexible
+    software infrastructure for building and coupling weather, climate, and
+    related Earth science applications. The ESMF defines an architecture for
+    composing complex, coupled modeling systems and includes data structures
+    and utilities for developing individual models."""
+
+    homepage = "https://www.earthsystemcog.org/projects/esmf/"
+    url      = "http://www.earthsystemmodeling.org/esmf_releases/non_public/ESMF_7_0_1/esmf_7_0_1_src.tar.gz"
+
+    version('7.0.1', 'd3316ea79b032b8fb0cd40e5868a0261')
+
+    variant('mpi',     default=True,  description='Build with MPI support')
+    variant('lapack',  default=True,  description='Build with LAPACK support')
+    variant('netcdf',  default=True,  description='Build with NetCDF support')
+    variant('pnetcdf', default=True,  description='Build with pNetCDF support')
+    variant('xerces',  default=True,  description='Build with Xerces support')
+    variant('pio',     default=True,  description='Enable ParallelIO support')
+    variant('debug',   default=False, description='Make a debuggable version of the library')
+
+    # Required dependencies
+    depends_on('mpi', when='+mpi')
+    depends_on('zlib')
+    depends_on('libxml2')
+    # depends_on('perl', type='test')  # TODO: Add a test deptype
+
+    # Optional dependencies
+    depends_on('lapack@3:', when='+lapack')
+    depends_on('netcdf@3.6:', when='+netcdf')
+    depends_on('netcdf-fortran@3.6:', when='+netcdf')
+    depends_on('parallel-netcdf@1.2.0:', when='+pnetcdf')
+    depends_on('xerces-c@3.1.0:', when='+xerces')
+
+    # NOTE: ESMF cannot be installed with GCC 6. It uses constructs that
+    # are no longer valid in GCC 6. GCC 4 is recommended for installation.
+
+    def url_for_version(self, version):
+        return "http://www.earthsystemmodeling.org/esmf_releases/non_public/ESMF_{0}/esmf_{0}_src.tar.gz".format(version.underscored)
+
+    def install(self, spec, prefix):
+        # Installation instructions can be found at:
+        # http://www.earthsystemmodeling.org/esmf_releases/last_built/ESMF_usrdoc/node9.html
+
+        # Unset any environment variables that may influence the installation.
+        for var in os.environ:
+            if var.startswith('ESMF_'):
+                os.environ.pop(var)
+
+        ######################################
+        # Build and Installation Directories #
+        ######################################
+
+        # The environment variable ESMF_DIR must be set to the full pathname
+        # of the top level ESMF directory before building the framework.
+        os.environ['ESMF_DIR'] = os.getcwd()
+
+        # This variable specifies the prefix of the installation path used
+        # with the install target.
+        os.environ['ESMF_INSTALL_PREFIX'] = prefix
+
+        # Installation subdirectories default to:
+        # bin/binO/Linux.gfortran.64.default.default
+        os.environ['ESMF_INSTALL_BINDIR'] = 'bin'
+        os.environ['ESMF_INSTALL_LIBDIR'] = 'lib'
+        os.environ['ESMF_INSTALL_MODDIR'] = 'mod'
+
+        ############
+        # Compiler #
+        ############
+
+        # ESMF_COMPILER must be set to select which Fortran and
+        # C++ compilers are being used to build the ESMF library.
+        if self.compiler.name == 'gcc':
+            os.environ['ESMF_COMPILER'] = 'gfortran'
+        elif self.compiler.name == 'intel':
+            os.environ['ESMF_COMPILER'] = 'intel'
+        elif self.compiler.name == 'clang':
+            os.environ['ESMF_COMPILER'] = 'gfortranclang'
+        elif self.compiler.name == 'nag':
+            os.environ['ESMF_COMPILER'] = 'nag'
+        elif self.compiler.name == 'pgi':
+            os.environ['ESMF_COMPILER'] = 'pgi'
+        else:
+            msg  = "The compiler you are building with, "
+            msg += "'{0}', is not supported by ESMF."
+            raise InstallError(msg.format(self.compiler.name))
+
+        if '+mpi' in spec:
+            os.environ['ESMF_CXX'] = spec['mpi'].mpicxx
+            os.environ['ESMF_F90'] = spec['mpi'].mpifc
+        else:
+            os.environ['ESMF_CXX'] = os.environ['CXX']
+            os.environ['ESMF_F90'] = os.environ['FC']
+
+        # This environment variable controls the build option.
+        if '+debug' in spec:
+            # Build a debuggable version of the library.
+            os.environ['ESMF_BOPT'] = 'g'
+        else:
+            # Build an optimized version of the library.
+            os.environ['ESMF_BOPT'] = 'O'
+
+        #######
+        # MPI #
+        #######
+
+        # ESMF_COMM must be set to indicate which MPI implementation
+        # is used to build the ESMF library.
+        if '+mpi' in spec:
+            if '^mvapich2' in spec:
+                os.environ['ESMF_COMM'] = 'mvapich2'
+            elif '^mpich' in spec:
+                # FIXME: mpich or mpich2?
+                os.environ['ESMF_COMM'] = 'mpich2'
+            elif '^openmpi' in spec:
+                os.environ['ESMF_COMM'] = 'openmpi'
+            elif '^intel-parallel-studio+mpi' in spec:
+                os.environ['ESMF_COMM'] = 'intelmpi'
+        else:
+            # Force use of the single-processor MPI-bypass library.
+            os.environ['ESMF_COMM'] = 'mpiuni'
+
+        ##########
+        # LAPACK #
+        ##########
+
+        if '+lapack' in spec:
+            # A system-dependent external LAPACK/BLAS installation is used
+            # to satisfy the external dependencies of the LAPACK-dependent
+            # ESMF code.
+            os.environ['ESMF_LAPACK'] = 'system'
+
+            # FIXME: determine whether or not we need to set this
+            # Specifies the path where the LAPACK library is located.
+            # os.environ['ESMF_LAPACK_LIBPATH'] = spec['lapack'].prefix.lib
+
+            # Specifies the linker directive needed to link the LAPACK library
+            # to the application.
+            os.environ['ESMF_LAPACK_LIBS'] = spec['lapack'].lapack_libs.link_flags  # noqa
+        else:
+            # Disables LAPACK-dependent code.
+            os.environ['ESMF_LAPACK'] = 'OFF'
+
+        ##########
+        # NetCDF #
+        ##########
+
+        if '+netcdf' in spec:
+            # ESMF provides the ability to read Grid and Mesh data in
+            # NetCDF format.
+            if spec.satisfies('^netcdf@4.2:'):
+                # ESMF_NETCDF_LIBS will be set to "-lnetcdff -lnetcdf".
+                # This option is useful for systems which have the Fortran
+                # and C bindings archived in seperate library files.
+                os.environ['ESMF_NETCDF'] = 'split'
+            else:
+                # ESMF_NETCDF_LIBS will be set to "-lnetcdf".
+                # This option is useful when the Fortran and C bindings
+                # are archived together in the same library file.
+                os.environ['ESMF_NETCDF'] = 'standard'
+
+            # FIXME: determine whether or not we need to set these.
+            # ESMF_NETCDF_INCLUDE
+            # ESMF_NETCDF_LIBPATH
+
+        ###################
+        # Parallel-NetCDF #
+        ###################
+
+        if '+pnetcdf' in spec:
+            # ESMF provides the ability to write Mesh weights
+            # using Parallel-NetCDF.
+
+            # When defined, enables the use of Parallel-NetCDF.
+            # ESMF_PNETCDF_LIBS will be set to "-lpnetcdf".
+            os.environ['ESMF_PNETCDF'] = 'standard'
+
+            # FIXME: determine whether or not we need to set these.
+            # ESMF_PNETCDF_INCLUDE
+            # ESMF_PNETCDF_LIBPATH
+
+        ##############
+        # ParallelIO #
+        ##############
+
+        if '+pio' in spec and '+mpi' in spec:
+            # ESMF provides the ability to read and write data in both binary
+            # and NetCDF formats through ParallelIO (PIO), a third-party IO
+            # software library that is integrated in the ESMF library.
+
+            # PIO-dependent features will be enabled and will use the
+            # PIO library that is included and built with ESMF.
+            os.environ['ESMF_PIO'] = 'internal'
+        else:
+            # Disables PIO-dependent code.
+            os.environ['ESMF_PIO'] = 'OFF'
+
+        ##########
+        # XERCES #
+        ##########
+
+        if '+xerces' in spec:
+            # ESMF provides the ability to read Attribute data in
+            # XML file format via the XERCES C++ library.
+
+            # ESMF_XERCES_LIBS will be set to "-lxerces-c".
+            os.environ['ESMF_XERCES'] = 'standard'
+
+            # FIXME: determine if the following are needed
+            # ESMF_XERCES_INCLUDE
+            # ESMF_XERCES_LIBPATH
+
+        ################
+        # Installation #
+        ################
+
+        make()
+
+        if self.run_tests:
+            make('check', parallel=False)
+
+        make('install')
+
+        if self.run_tests:
+            make('installcheck')