EESSI-extend-2023.06-easybuild.eb

easyblock = 'Bundle'

name = 'NESSI-extend'
version = '2023.06'
# May have different ways to extend NESSI in the future (manually, other tools,...)
versionsuffix = '-easybuild'

homepage = 'https://documentation.sigma2.no/software/nessi_eessi.html'

description = """
 NESSI is an innovative service to make optimized scientific software
 installations available on any machine anywhere in the world in near
 real-time - without the need to build or install the software. NESSI
 works similarly to popular streaming services for videos and music.

 NESSI is a sibling of EESSI, the European Environment for Scientific
 Software Installations (see https://eessi.io/docs).

 This module allows you to extend NESSI using the same configuration for
 EasyBuild as NESSI itself uses. A number of environment variables control the
 behaviour of the module:
 - NESSI_USER_INSTALL can be set to a location to install modules for use by
   the user only. The location must already exist on the filesystem.
 - NESSI_PROJECT_INSTALL can be set to a location to install modules for use by
   a project. The location must already exist on the filesystem and you should
   ensure that the location has the correct Linux group and the SGID permission
   is set on that directory (`chmod g+s $NESSI_PROJECT_INSTALL`) so that all
   members of the group have permission to read and write installations.
 - NESSI_SITE_INSTALL is either defined or not and cannot be used with another
   environment variable. A site installation is done in a defined location and
   any installations there are (by default) world readable.
 - NESSI_CVMFS_INSTALL is either defined or not and cannot be used with another
   environment variable. A CVMFS installation targets a defined location which
   will be ingested into CVMFS and is only useful for CVMFS administrators.
 - If none of the environment variables above are defined, a NESSI_USER_INSTALL
   is assumed with a value of $HOME/NESSI
 If both NESSI_USER_INSTALL and NESSI_PROJECT_INSTALL are defined, both sets of
 installations are exposed, but new installations are created as user
 installations.
"""

toolchain = SYSTEM

# All the dependencies we filter in NESSI
local_deps_to_filter = "Autoconf,Automake,Autotools,binutils,bzip2,DBus,flex,gettext,gperf,help2man,intltool,libreadline,libtool,M4,makeinfo,ncurses,util-linux,XZ,zlib,PSM2"
local_arch_specific_deps_to_filter = {'aarch64': ',yasm', 'x86_64': ''}
local_deps_to_filter += local_arch_specific_deps_to_filter[ARCH]

# Set the universal EasyBuild variables
modextravars = {
    'EASYBUILD_FILTER_DEPS': local_deps_to_filter,
    'EASYBUILD_IGNORE_OSDEPS': '1',
    'EASYBUILD_DEBUG': '1',
    'EASYBUILD_TRACE': '1',
    'EASYBUILD_ZIP_LOGS': 'bzip2',
    'EASYBUILD_RPATH': '1',
    'EASYBUILD_FILTER_ENV_VARS': 'LD_LIBRARY_PATH',
    'EASYBUILD_READ_ONLY_INSTALLDIR': '1',
    'EASYBUILD_MODULE_EXTENSIONS': '1',
    'EASYBUILD_EXPERIMENTAL': '1',
}

# Need a few other variables, but they are more dynamic
# EASYBUILD_SYSROOT=${EPREFIX}
# EASYBUILD_PREFIX=${WORKDIR}/easybuild
# EASYBUILD_HOOKS=${EESSI_PREFIX}/init/easybuild/eb_hooks.py
# EASYBUILD_INSTALLPATH=${EESSI_PREFIX}/software/${EESSI_OS_TYPE}/${EESSI_SOFTWARE_SUBDIR}
# EASYBUILD_SOURCEPATH=${WORKDIR}/easybuild/sources:${EESSI_SOURCEPATH}
#
# And also some optional ones based on the kind of installation
# EASYBUILD_SET_GID_BIT
# EASYBUILD_GROUP_WRITABLE_INSTALLDIR
# EASYBUILD_UMASK
# EASYBUILD_STICKY_BIT
modluafooter = """
if (mode() == "load") then
  -- Use a working directory for temporary build files
  if (os.getenv("WORKING_DIR") == nil) then
    LmodMessage("-- Using /tmp/$USER as a temporary working directory for installations, you can override this by setting the environment variable WORKING_DIR and reloading the module (e.g., /dev/shm is a common option)")
  end
end
working_dir = os.getenv("WORKING_DIR") or pathJoin("/tmp", os.getenv("USER"))
-- Gather the EPREFIX to use as a sysroot
sysroot = os.getenv("EESSI_EPREFIX")
-- Use an installation prefix that we _should_ have write access to
if (os.getenv("NESSI_CVMFS_INSTALL") ~= nil) then
  -- Make sure no other NESSI install environment variables are set
  if ((os.getenv("NESSI_SITE_INSTALL") ~= nil) or (os.getenv("NESSI_PROJECT_INSTALL") ~= nil) or (os.getenv("NESSI_USER_INSTALL") ~= nil)) then
    LmodError("You cannot use NESSI_CVMFS_INSTALL in combination with any other NESSI_*_INSTALL environment variables")
  end
  eessi_cvmfs_install = true
  easybuild_installpath = os.getenv("EESSI_SOFTWARE_PATH")
elseif (os.getenv("NESSI_SITE_INSTALL") ~= nil) then
  -- Make sure no other NESSI install environment variables are set
  if ((os.getenv("NESSI_PROJECT_INSTALL") ~= nil) or (os.getenv("NESSI_USER_INSTALL") ~= nil)) then
    LmodError("You cannot use NESSI_SITE_INSTALL in combination with any other NESSI_*_INSTALL environment variables")
  end
  easybuild_installpath = string.gsub(os.getenv("EESSI_SOFTWARE_PATH"), 'versions', 'host_injections')
else
  -- Deal with user and project installs
  project_install = os.getenv("NESSI_PROJECT_INSTALL")
  project_modulepath = nil
  if (project_install ~= nil) then
    -- Check the folder exists
    if not isDir(project_install) then
      LmodError("The location of NESSI_PROJECT_INSTALL (" .. project_install .. ") does not exist or is not a folder")
    end
    if (mode() == "load") then
      LmodMessage("Configuring for use of NESSI_PROJECT_INSTALL under " .. project_install)
    end
    easybuild_installpath = string.gsub(os.getenv("EESSI_SOFTWARE_PATH"), os.getenv("EESSI_CVMFS_REPO"), project_install)
    project_modulepath = pathJoin(easybuild_installpath, 'modules', 'all')
  end
  user_install = os.getenv("NESSI_USER_INSTALL")
  user_modulepath = nil
  if (user_install ~= nil) then
    -- Check the folder exists
    if not isDir(user_install) then
      LmodError("The location of NESSI_USER_INSTALL (" .. user_install .. ") does not exist or is not a folder")
    end
  elseif (user_install == nil) and (project_install == nil) then
    -- No need to check for existence when we use a HOME subdir
    user_install = pathJoin(os.getenv("HOME"), "nessi")
  end
  if (user_install ~= nil) then
    if (mode() == "load") then
      LmodMessage("Configuring for use of NESSI_USER_INSTALL under " .. user_install)
    end
    easybuild_installpath = string.gsub(os.getenv("EESSI_SOFTWARE_PATH"), os.getenv("EESSI_CVMFS_REPO"), user_install)
    user_modulepath = pathJoin(easybuild_installpath, 'modules', 'all')
  end
end
if (mode() == "load") then
  LmodMessage("-- To create installations for NESSI, you _must_ have write permissions to " .. easybuild_installpath)
  -- Advise them to reuse sources
  if (os.getenv("EASYBUILD_SOURCEPATH") == nil) then
    LmodMessage("-- You may wish to configure a sources directory for EasyBuild (for example, via setting the environment variable EASYBUILD_SOURCEPATH) to allow you to reuse existing sources for packages.")
  end
end
-- Set the relevant universal environment variables for EasyBuild
setenv ("EASYBUILD_SYSROOT", sysroot)
setenv ("EASYBUILD_PREFIX", pathJoin(working_dir, "easybuild"))
setenv ("EASYBUILD_INSTALLPATH", easybuild_installpath)
setenv ("EASYBUILD_HOOKS", pathJoin(os.getenv("EESSI_PREFIX"), "init", "easybuild", "eb_hooks.py"))
setenv ("EASYBUILD_UMASK", "002")

-- Set all related environment variables if we have project or user installations (including extending MODULEPATH)
if (user_modulepath ~= nil) then
  -- Use a more restrictive umask for this case
  setenv ("EASYBUILD_UMASK", "022")
  setenv ("EASYBUILD_STICKY_BIT", "1")
  -- configure MODULEPATH
  if (project_modulepath ~= nil) then
    prepend_path("MODULEPATH", project_modulepath)
  end
  prepend_path("MODULEPATH", user_modulepath)
elseif (project_modulepath ~= nil) then
  setenv ("EASYBUILD_SET_GID_BIT", "1")
  setenv ("EASYBUILD_GROUP_WRITABLE_INSTALLDIR", "1")
  setenv ("EASYBUILD_STICKY_BIT", "0")
  -- configure MODULEPATH
  prepend_path("MODULEPATH", project_modulepath)
end
-- Make sure EasyBuild itself is loaded
if not ( isloaded("EasyBuild") ) then
    load("EasyBuild")
end
"""

moduleclass = 'devel'