text: # Copyright 2013-2019 Lawrence Livermore National Security, LLC and other
  # Spack Project Developers. See the top-level COPYRIGHT file for details.
  #
  # SPDX-License-Identifier: (Apache-2.0 OR MIT)
  
  from spack import *
  
  import socket
  import os
  
  import llnl.util.tty as tty
  from os import environ as env
  
  
  def cmake_cache_entry(name, value):
      """
      Helper that creates CMake cache entry strings used in
      'host-config' files.
      """
      return 'set({0} "{1}" CACHE PATH "")\n\n'.format(name, value)
  
  
  class Conduit(Package):
      """Conduit is an open source project from Lawrence Livermore National
      Laboratory that provides an intuitive model for describing hierarchical
      scientific data in C++, C, Fortran, and Python. It is used for data
      coupling between packages in-core, serialization, and I/O tasks."""
  
      homepage = "http://software.llnl.gov/conduit"
      url      = "https://github.com/LLNL/conduit/releases/download/v0.3.0/conduit-v0.3.0-src-with-blt.tar.gz"
      git      = "https://github.com/LLNL/conduit.git"
  
      version('master', branch='master', submodules=True)
      version('0.3.1', 'b98d1476199a46bde197220cd9cde042')
      version('0.3.0', '6396f1d1ca16594d7c66d4535d4f898e')
      # note: checksums on github automatic release source tars changed ~9/17
      version('0.2.1', 'ed7358af3463ba03f07eddd6a6e626ff')
      version('0.2.0', 'a7b398d493fd71b881a217993a9a29d4')
  
      maintainers = ['cyrush']
  
      ###########################################################################
      # package variants
      ###########################################################################
  
      variant("shared", default=True, description="Build Conduit as shared libs")
  
      variant("cmake", default=True,
              description="Build CMake (if off, attempt to use cmake from PATH)")
  
      # variants for python support
      variant("python", default=True, description="Build Conduit Python support")
  
      # variants for comm and i/o
      variant("mpi", default=True, description="Build Conduit MPI Support")
      variant("hdf5", default=True, description="Build Conduit HDF5 support")
      variant("silo", default=False, description="Build Conduit Silo support")
  
      # variants for dev-tools (docs, etc)
      variant("doc", default=False, description="Build Conduit's documentation")
      # doxygen support is wip, since doxygen has several dependencies
      # we want folks to explicitly opt in to building doxygen
      variant("doxygen", default=False, description="Build Conduit's Doxygen documentation")
  
      ###########################################################################
      # package dependencies
      ###########################################################################
  
      #######################
      # CMake
      #######################
      # cmake 3.8.2 or newer
      depends_on("cmake@3.8.2:", when="+cmake")
  
      #######################
      # Python
      #######################
      # we need a shared version of python b/c linking with static python lib
      # causes duplicate state issues when running compiled python modules.
      depends_on("python+shared", when="+python")
      extends("python", when="+python")
      depends_on("py-numpy", when="+python", type=('build', 'run'))
  
      #######################
      # I/O Packages
      #######################
      # TODO: cxx variant is disabled due to build issue Cyrus
      # experienced on BGQ. When on, the static build tries
      # to link against shared libs.
      #
      # Use HDF5 1.8, for wider output compatibly
      # variants reflect we are not using hdf5's mpi or fortran features.
      depends_on("hdf5@1.8.19:1.8.999~cxx~mpi~fortran", when="+hdf5+shared")
      depends_on("hdf5@1.8.19:1.8.999~shared~cxx~mpi~fortran", when="+hdf5~shared")
  
      # we are not using silo's fortran features
      depends_on("silo~fortran", when="+silo+shared")
      depends_on("silo~shared~fortran", when="+silo~shared")
  
      #######################
      # MPI
      #######################
      depends_on("mpi", when="+mpi")
  
      #######################
      # Documentation related
      #######################
      depends_on("py-sphinx", when="+python+doc", type='build')
      depends_on("doxygen", when="+doc+doxygen")
  
      def url_for_version(self, version):
          """
          Provide proper url
          """
          v = str(version)
          if v == "0.2.0":
              return "https://github.com/LLNL/conduit/archive/v0.2.0.tar.gz"
          elif v == "0.2.1":
              return "https://github.com/LLNL/conduit/archive/v0.2.1.tar.gz"
          else:
              # starting with v 0.3.0, conduit uses BLT
              # (https://github.com/llnl/blt) as a submodule, since github does
              # not automatically package source from submodules, conduit
              # provides a custom src tarball
              return "https://github.com/LLNL/conduit/releases/download/v{0}/conduit-v{1}-src-with-blt.tar.gz".format(v, v)
          return url
  
      def install(self, spec, prefix):
          """
          Build and install Conduit.
          """
          with working_dir('spack-build', create=True):
              py_site_pkgs_dir = None
              if "+python" in spec:
                  py_site_pkgs_dir = site_packages_dir
  
              host_cfg_fname = self.create_host_config(spec,
                                                       prefix,
                                                       py_site_pkgs_dir)
              cmake_args = []
              # if we have a static build, we need to avoid any of
              # spack's default cmake settings related to rpaths
              # (see: https://github.com/spack/spack/issues/2658)
              if "+shared" in spec:
                  cmake_args.extend(std_cmake_args)
              else:
                  for arg in std_cmake_args:
                      if arg.count("RPATH") == 0:
                          cmake_args.append(arg)
              cmake_args.extend(["-C", host_cfg_fname, "../src"])
              cmake(*cmake_args)
              make()
              make("install")
              # install copy of host config for provenance
              install(host_cfg_fname, prefix)
  
      def create_host_config(self, spec, prefix, py_site_pkgs_dir=None):
          """
          This method creates a 'host-config' file that specifies
          all of the options used to configure and build conduit.
  
          For more details about 'host-config' files see:
              http://software.llnl.gov/conduit/building.html
  
          Note:
            The `py_site_pkgs_dir` arg exists to allow a package that
            subclasses this package provide a specific site packages
            dir when calling this function. `py_site_pkgs_dir` should
            be an absolute path or `None`.
  
            This is necessary because the spack `site_packages_dir`
            var will not exist in the base class. For more details
            on this issue see: https://github.com/spack/spack/issues/6261
          """
  
          #######################
          # Compiler Info
          #######################
          c_compiler = env["SPACK_CC"]
          cpp_compiler = env["SPACK_CXX"]
          f_compiler = None
  
          if self.compiler.fc:
              # even if this is set, it may not exist so do one more sanity check
              if os.path.isfile(env["SPACK_FC"]):
                  f_compiler = env["SPACK_FC"]
  
          #######################################################################
          # By directly fetching the names of the actual compilers we appear
          # to doing something evil here, but this is necessary to create a
          # 'host config' file that works outside of the spack install env.
          #######################################################################
  
          sys_type = spec.architecture
          # if on llnl systems, we can use the SYS_TYPE
          if "SYS_TYPE" in env:
              sys_type = env["SYS_TYPE"]
  
          ##############################################
          # Find and record what CMake is used
          ##############################################
  
          if "+cmake" in spec:
              cmake_exe = spec['cmake'].command.path
          else:
              cmake_exe = which("cmake")
              if cmake_exe is None:
                  msg = 'failed to find CMake (and cmake variant is off)'
                  raise RuntimeError(msg)
              cmake_exe = cmake_exe.path
  
          host_cfg_fname = "%s-%s-%s-conduit.cmake" % (socket.gethostname(),
                                                       sys_type,
                                                       spec.compiler)
  
          cfg = open(host_cfg_fname, "w")
          cfg.write("##################################\n")
          cfg.write("# spack generated host-config\n")
          cfg.write("##################################\n")
          cfg.write("# {0}-{1}\n".format(sys_type, spec.compiler))
          cfg.write("##################################\n\n")
  
          # Include path to cmake for reference
          cfg.write("# cmake from spack \n")
          cfg.write("# cmake executable path: %s\n\n" % cmake_exe)
  
          #######################
          # Compiler Settings
          #######################
  
          cfg.write("#######\n")
          cfg.write("# using %s compiler spec\n" % spec.compiler)
          cfg.write("#######\n\n")
          cfg.write("# c compiler used by spack\n")
          cfg.write(cmake_cache_entry("CMAKE_C_COMPILER", c_compiler))
          cfg.write("# cpp compiler used by spack\n")
          cfg.write(cmake_cache_entry("CMAKE_CXX_COMPILER", cpp_compiler))
  
          cfg.write("# fortran compiler used by spack\n")
          if f_compiler is not None:
              cfg.write(cmake_cache_entry("ENABLE_FORTRAN", "ON"))
              cfg.write(cmake_cache_entry("CMAKE_Fortran_COMPILER", f_compiler))
          else:
              cfg.write("# no fortran compiler found\n\n")
              cfg.write(cmake_cache_entry("ENABLE_FORTRAN", "OFF"))
  
          #######################
          # Python
          #######################
  
          cfg.write("# Python Support\n")
  
          if "+python" in spec:
              cfg.write("# Enable python module builds\n")
              cfg.write(cmake_cache_entry("ENABLE_PYTHON", "ON"))
              cfg.write("# python from spack \n")
              cfg.write(cmake_cache_entry("PYTHON_EXECUTABLE",
                        spec['python'].command.path))
              # only set dest python site packages dir if passed
              if py_site_pkgs_dir:
                  cfg.write(cmake_cache_entry("PYTHON_MODULE_INSTALL_PREFIX",
                                              py_site_pkgs_dir))
          else:
              cfg.write(cmake_cache_entry("ENABLE_PYTHON", "OFF"))
  
          if "+doc" in spec:
              cfg.write(cmake_cache_entry("ENABLE_DOCS", "ON"))
  
              cfg.write("# sphinx from spack \n")
              sphinx_build_exe = join_path(spec['py-sphinx'].prefix.bin,
                                           "sphinx-build")
              cfg.write(cmake_cache_entry("SPHINX_EXECUTABLE", sphinx_build_exe))
              if "+doxygen" in spec:
                  cfg.write("# doxygen from uberenv\n")
                  doxygen_exe = spec['doxygen'].command.path
                  cfg.write(cmake_cache_entry("DOXYGEN_EXECUTABLE", doxygen_exe))
          else:
              cfg.write(cmake_cache_entry("ENABLE_DOCS", "OFF"))
  
          #######################
          # MPI
          #######################
  
          cfg.write("# MPI Support\n")
  
          if "+mpi" in spec:
              cfg.write(cmake_cache_entry("ENABLE_MPI", "ON"))
              cfg.write(cmake_cache_entry("MPI_C_COMPILER", spec['mpi'].mpicc))
              cfg.write(cmake_cache_entry("MPI_CXX_COMPILER",
                                          spec['mpi'].mpicxx))
              cfg.write(cmake_cache_entry("MPI_Fortran_COMPILER",
                                          spec['mpi'].mpifc))
              mpiexe_bin = join_path(spec['mpi'].prefix.bin, 'mpiexec')
              if os.path.isfile(mpiexe_bin):
                  # starting with cmake 3.10, FindMPI expects MPIEXEC_EXECUTABLE
                  # vs the older versions which expect MPIEXEC
                  if self.spec["cmake"].satisfies('@3.10:'):
                      cfg.write(cmake_cache_entry("MPIEXEC_EXECUTABLE",
                                                  mpiexe_bin))
                  else:
                      cfg.write(cmake_cache_entry("MPIEXEC",
                                                  mpiexe_bin))
          else:
              cfg.write(cmake_cache_entry("ENABLE_MPI", "OFF"))
  
          #######################################################################
          # I/O Packages
          #######################################################################
  
          cfg.write("# I/O Packages\n\n")
  
          #######################
          # HDF5
          #######################
  
          cfg.write("# hdf5 from spack \n")
  
          if "+hdf5" in spec:
              cfg.write(cmake_cache_entry("HDF5_DIR", spec['hdf5'].prefix))
          else:
              cfg.write("# hdf5 not built by spack \n")
  
          #######################
          # Silo
          #######################
  
          cfg.write("# silo from spack \n")
  
          if "+silo" in spec:
              cfg.write(cmake_cache_entry("SILO_DIR", spec['silo'].prefix))
          else:
              cfg.write("# silo not built by spack \n")
  
          cfg.write("##################################\n")
          cfg.write("# end spack generated host-config\n")
          cfg.write("##################################\n")
          cfg.close()
  
          host_cfg_fname = os.path.abspath(host_cfg_fname)
          tty.info("spack generated conduit host-config file: " + host_cfg_fname)
          return host_cfg_fname
  