Update config scripts.

This commit enhances our config/profile scripts to support:

1. A place to put building software manually without easybuild. These
builds will be referred to as "banalbuild".  The manual builds will be
located in $CCR_PREFIX/banalbuild. Banal == devoid of freshness or
originality :)

2. Allow users to override the default CCR_VERSION so they can pin their
profile to a specific version of our software stack.

3. Start to standardize a way for custom user/group modules and how they
dispaly in `module avail`.

Author: aebruno

config/easybuild/eb_hooks.py

@@ -48,7 +48,7 @@ def get_ccr_envvar(ccr_envvar):
     return ccr_envvar_value
 
 def set_modluafooter(ec):
-    software_path = get_ccr_envvar('CCR_SOFTWARE_PATH')
+    software_path = get_ccr_envvar('CCR_EASYBUILD_PATH')
     ccr_version = get_ccr_envvar('CCR_VERSION')
     eprefix = get_ccr_envvar('EPREFIX')
     moduleclass = ec.get('moduleclass','')
@@ -78,8 +78,8 @@ def pre_module_hook(self, *args, **kwargs):
     self.cfg.enhance_sanity_check = True
 
 def get_rpath_override_dirs(software_name):
-    # determine path to installations in software layer via $CCR_SOFTWARE_PATH
-    ccr_software_path = get_ccr_envvar('CCR_SOFTWARE_PATH')
+    # determine path to installations in software layer via $CCR_EASYBUILD_PATH
+    ccr_software_path = get_ccr_envvar('CCR_EASYBUILD_PATH')
     ccr_version = get_ccr_envvar('CCR_VERSION')
 
     # construct the rpath override directory stub

config/easybuild/init.sh

@@ -35,7 +35,7 @@ export EASYBUILD_MODULE_NAMING_SCHEME=CCRHierarchicalMNS
 
 export EASYBUILD_ALLOW_LOADED_MODULES=StdEnv,gentoo,easybuild
 export EASYBUILD_PREFIX=${WORKDIR}/easybuild
-export EASYBUILD_INSTALLPATH=${CCR_SOFTWARE_PATH}
+export EASYBUILD_INSTALLPATH=${CCR_EASYBUILD_PATH}
 export EASYBUILD_SUFFIX_MODULES_PATH=""
 export EASYBUILD_SOURCEPATH=${WORKDIR}/easybuild/sources:${CCR_SOURCEPATH}
 

config/lmod/SitePackage.lua

@@ -119,14 +119,17 @@ function dofile (filename)
     return f()
 end
 
-local ccr_soft_path = os.getenv("CCR_SOFTWARE_PATH")
+local ccr_version =os.getenv("CCR_VERSION")
 local ccr_prefix = os.getenv("CCR_PREFIX")
+
+-- NOTE: this matches CCR_PREFIX/easybuild and CCR_PREFIX/banalbuild
+local ccr_soft_path = pathJoin(ccr_prefix, ".*build")
+
 local lmod_package_path = os.getenv("LMOD_PACKAGE_PATH")
 dofile(pathJoin(lmod_package_path,"SitePackage_logging.lua"))
 dofile(pathJoin(lmod_package_path,"SitePackage_licenses.lua"))
 dofile(pathJoin(lmod_package_path,"SitePackage_families.lua"))
 dofile(pathJoin(lmod_package_path,"SitePackage_properties.lua"))
-dofile(pathJoin(lmod_package_path,"SitePackage_localpaths.lua"))
 
 sandbox_registration{ loadfile = loadfile, assert = assert, loaded_modules = loaded_modules, serializeTbl = serializeTbl, clearWarningFlag = clearWarningFlag  }
 
@@ -233,20 +236,17 @@ sandbox_registration{ get_installed_cuda_driver_version = get_installed_cuda_dri
 
 local function unload_hook(t)
         set_family(t)
-        set_local_paths(t)
 end
 
 local function load_hook(t)
 	local valid = validate_license(t)
         set_props(t)
         set_family(t)
-	log_module_load(t,true)
-        set_local_paths(t)
+        log_module_load(t,true)
 end
 
 local function spider_hook(t)
         set_props(t)
-        set_local_paths(t)
 end
 
 hook.register("unload",           unload_hook)
@@ -257,7 +257,7 @@ hook.register("load_spider",    spider_hook)
 local mapT =
 {
    grouped = {
-      [ccr_soft_path .. '/modules/Core.*']     = "Core Modules",
+      [ccr_soft_path .. '/modules/Core.*']     = "Core modules",
       [ccr_soft_path .. '/modules/CUDA.*'] = "Cuda-dependent modules",
       [ccr_soft_path .. '/modules/avx512/Core.*'] = "Core avx512 modules",
       [ccr_soft_path .. '/modules/avx512/Compiler.*'] = "Compiler-dependent avx512 modules",
@@ -271,10 +271,11 @@ local mapT =
       [ccr_soft_path .. '/modules/sse3/Core.*'] = "Core sse modules",
       [ccr_soft_path .. '/modules/sse3/Compiler.*'] = "Compiler-dependent sse3 modules",
       [ccr_soft_path .. '/modules/sse3/MPI.*'] = "MPI-dependent sse3 modules",
-      [ccr_prefix .. '/config/modulefiles$'] = "Custom CCR modules",
-      ['/srv/software.*layer/config/modulefiles$'] = "Custom CCR modules",
-      ['/project/.*'] = "Your groups' modules",
-      ['/user/.*'] = "Your personal modules",
+      [ccr_prefix .. '/config/modulefiles$'] = "Core modules",
+      ['/srv/software.*layer/config/modulefiles$'] = "Core modules",
+      ['/projects/.*'] = "Your groups' modules",
+      ['/user/.*/modules/.*'] = "Your personal modules",
+      ['/home/.*/modules/.*'] = "Your personal modules",
    },
 }
 
@@ -284,13 +285,24 @@ function avail_hook(t)
    if (not availStyle or availStyle == "system" or styleT == nil) then
       return
    end
-   local localModulePaths = os.getenv("CCR_LOCAL_MODULEPATHS") or nil
-   if localModulePaths ~= nil then
-    for localModulePathRoot in localModulePaths:split(":") do
-       styleT[localModulePathRoot .. "/.*/Core.*"] = "Cluster specific Core modules"
-       styleT[localModulePathRoot .. "/.*/CUDA.*"] = "Cluster specific Cuda-dependent modules"
-       styleT[localModulePathRoot .. "/.*/Compiler.*"] = "Cluster specific Compiler-dependent modules"
-       styleT[localModulePathRoot .. "/.*/MPI.*"] = "Cluster specific MPI-dependent modules"
+   local customBuildPaths = os.getenv("CCR_CUSTOM_BUILD_PATHS") or nil
+   if customBuildPaths ~= nil then
+    for customPath in customBuildPaths:split(":") do
+       local customModulePathRoot = pathJoin(customPath, ccr_version)
+       styleT[customModulePathRoot .. "/modules/Core.*"] = "Your Core modules"
+       styleT[customModulePathRoot .. "/modules/CUDA.*"] = "Your Cuda-dependent modules"
+       styleT[customModulePathRoot .. "/modules/avx512/Core.*"] = "Your avx512 modules"
+       styleT[customModulePathRoot .. "/modules/avx512/Compiler.*"] = "Your Compiler-dependent avx512 modules"
+       styleT[customModulePathRoot .. "/modules/avx512/MPI.*"] = "Your MPI-dependent avx512 modules"
+       styleT[customModulePathRoot .. "/modules/avx2/Core.*"] = "Your avx2 modules"
+       styleT[customModulePathRoot .. "/modules/avx2/Compiler.*"] = "Your Compiler-dependent avx2 modules"
+       styleT[customModulePathRoot .. "/modules/avx2/MPI.*"] = "Your MPI-dependent avx2 modules"
+       styleT[customModulePathRoot .. "/modules/avx/Core.*"] = "Your avx modules"
+       styleT[customModulePathRoot .. "/modules/avx/Compiler.*"] = "Your Compiler-dependent avx modules"
+       styleT[customModulePathRoot .. "/modules/avx/MPI.*"] = "Your MPI-dependent avx modules"
+       styleT[customModulePathRoot .. "/modules/sse3/Core.*"] = "Your sse3 modules"
+       styleT[customModulePathRoot .. "/modules/sse3/Compiler.*"] = "Your Compiler-dependent sse3 modules"
+       styleT[customModulePathRoot .. "/modules/sse3/MPI.*"] = "Your MPI-dependent sse3 modules"
     end
    end
    for k,v in pairs(t) do

config/lmod/SitePackage_localpaths.lua

@@ -5,8 +5,18 @@ whatis("Gentoo prefix is Gentoo Linux installed in a prefix - Homepage: https://
 
 add_property(   "lmod", "sticky")
 
-local root = os.getenv("EPREFIX")
-local ccr_soft_path = os.getenv("CCR_SOFTWARE_PATH")
+local ccr_version ="2022.05"
+local ccr_repo_path = os.getenv("CCR_CVMFS_REPO")
+local ccr_prefix = pathJoin(ccr_repo_path, "versions", ccr_version)
+local ccr_easybuild_path = pathJoin(ccr_prefix, "easybuild")
+local ccr_banalbuild_path = pathJoin(ccr_prefix, "banalbuild")
+local root = pathJoin(ccr_prefix, "compat")
+
+setenv("CCR_VERSION", ccr_version)
+setenv("CCR_PREFIX", ccr_prefix)
+setenv("CCR_EASYBUILD_PATH", ccr_easybuild_path)
+setenv("CCR_BANALBUILD_PATH", ccr_banalbuild_path)
+setenv("EPREFIX", root)
 
 prepend_path("PATH", pathJoin(root, "bin"))
 prepend_path("PATH", pathJoin(root, "sbin"))
@@ -18,6 +28,20 @@ prepend_path("MANPATH", pathJoin(root, "usr/share/binutils-data/x86_64-pc-linux-
 prepend_path("MANPATH", pathJoin(root, "usr/share/gcc-data/x86_64-pc-linux-gnu/9.3.0/man"))
 
 if (mode() ~= "spider") then
-        prepend_path("MODULEPATH", pathJoin(ccr_soft_path, "modules/Core"))
-        prepend_path("MODULEPATH", pathJoin(ccr_soft_path, "modules", arch, "Core"))
+    prepend_path("MODULEPATH", pathJoin(ccr_easybuild_path, "modules/Core"))
+    prepend_path("MODULEPATH", pathJoin(ccr_easybuild_path, "modules", arch, "Core"))
+    prepend_path("MODULEPATH", pathJoin(ccr_banalbuild_path, "modules/Core"))
+    prepend_path("MODULEPATH", pathJoin(ccr_banalbuild_path, "modules", arch, "Core"))
+    local customBuildPaths = os.getenv("CCR_CUSTOM_BUILD_PATHS") or nil
+    if customBuildPaths ~= nil then
+        for customPath in customBuildPaths:split(":") do
+            if isDir(pathJoin(customPath, ccr_version, "modules")) then
+                prepend_path("MODULEPATH", pathJoin(customPath, ccr_version, "modules/Core"))
+                prepend_path("MODULEPATH", pathJoin(customPath, ccr_version, "modules", arch, "Core"))
+            end
+        end
+    end
+    if isDir(pathJoin(os.getenv("HOME"), "modules", ccr_version)) then
+        prepend_path("MODULEPATH", pathJoin(os.getenv("HOME"), "modules", ccr_version))
+    end
 end

config/modulefiles/gentoo/2022.05.lua.core

@@ -5,13 +5,17 @@ whatis("Gentoo prefix is Gentoo Linux installed in a prefix - Homepage: https://
 
 add_property(   "lmod", "sticky")
 
+local ccr_version ="2023.01"
 local ccr_repo_path = os.getenv("CCR_CVMFS_REPO")
-local ccr_prefix = pathJoin(ccr_repo_path, "versions/2023.01")
-local ccr_soft_path = pathJoin(ccr_prefix, "easybuild")
+local ccr_prefix = pathJoin(ccr_repo_path, "versions", ccr_version)
+local ccr_easybuild_path = pathJoin(ccr_prefix, "easybuild")
+local ccr_banalbuild_path = pathJoin(ccr_prefix, "banalbuild")
 local root = pathJoin(ccr_prefix, "compat")
 
+setenv("CCR_VERSION", ccr_version)
 setenv("CCR_PREFIX", ccr_prefix)
-setenv("CCR_SOFTWARE_PATH", ccr_soft_path)
+setenv("CCR_EASYBUILD_PATH", ccr_easybuild_path)
+setenv("CCR_BANALBUILD_PATH", ccr_banalbuild_path)
 setenv("EPREFIX", root)
 
 prepend_path("PATH", pathJoin(root, "bin"))
@@ -25,6 +29,20 @@ prepend_path("MANPATH", pathJoin(root, "usr/share/binutils-data/x86_64-pc-linux-
 prepend_path("MANPATH", pathJoin(root, "usr/share/gcc-data/x86_64-pc-linux-gnu/11.3.0/man"))
 
 if (mode() ~= "spider") then
-        prepend_path("MODULEPATH", pathJoin(ccr_soft_path, "modules/Core"))
-        prepend_path("MODULEPATH", pathJoin(ccr_soft_path, "modules", arch, "Core"))
+    prepend_path("MODULEPATH", pathJoin(ccr_easybuild_path, "modules/Core"))
+    prepend_path("MODULEPATH", pathJoin(ccr_easybuild_path, "modules", arch, "Core"))
+    prepend_path("MODULEPATH", pathJoin(ccr_banalbuild_path, "modules/Core"))
+    prepend_path("MODULEPATH", pathJoin(ccr_banalbuild_path, "modules", arch, "Core"))
+    local customBuildPaths = os.getenv("CCR_CUSTOM_BUILD_PATHS") or nil
+    if customBuildPaths ~= nil then
+        for customPath in customBuildPaths:split(":") do
+            if isDir(pathJoin(customPath, ccr_version, "modules")) then
+                prepend_path("MODULEPATH", pathJoin(customPath, ccr_version, "modules/Core"))
+                prepend_path("MODULEPATH", pathJoin(customPath, ccr_version, "modules", arch, "Core"))
+            end
+        end
+    end
+    if isDir(pathJoin(os.getenv("HOME"), "modules", ccr_version)) then
+        prepend_path("MODULEPATH", pathJoin(os.getenv("HOME"), "modules", ccr_version))
+    end
 end

config/modulefiles/gentoo/2023.01.lua.core

@@ -1,5 +1,26 @@
+CCR_CVMFS_REPO="/cvmfs/soft.ccr.buffalo.edu"
+CCR_VERSION="2023.01"
 CCR_INIT_DIR=$(dirname "$(dirname "$(readlink -f "$BASH_SOURCE")")")
+
+# Allow users to override CCR_VERSION
+if [ -f ${HOME}/.ccrversion ]; then
+    read -r ccrver<${HOME}/.ccrversion
+
+    if echo "${ccrver}" | egrep -q '^20[0-9][0-9]\.(0[0-9]|1[0-2])$'; then
+        if [ -d $CCR_CVMFS_REPO/versions/$ccrver ]; then
+	        CCR_VERSION="${ccrver}"
+	        CCR_INIT_DIR="${CCR_CVMFS_REPO}/versions/${ccrver}/config"
+        fi
+    fi
+fi
+
+# Defines base CCR environment variables. These will be used by everything
 export CCR_INIT_DIR
+export CCR_VERSION
+export CCR_CVMFS_REPO
+export CCR_PREFIX=$CCR_CVMFS_REPO/versions/$CCR_VERSION
+export CCR_EASYBUILD_PATH=$CCR_PREFIX/easybuild
+export CCR_BANALBUILD_PATH=$CCR_PREFIX/banalbuild
 
 if [[ $UID -ge 1000 ]]; then
     for file in ${CCR_INIT_DIR}/profile/profile.d/*.sh; do

config/profile/bash.sh

@@ -1,10 +1,3 @@
-# Defines base CCR environment variables. These will be used by everything
-  
-export CCR_CVMFS_REPO="/cvmfs/soft.ccr.buffalo.edu"
-export CCR_VERSION="2023.01"
-export CCR_PREFIX=$CCR_CVMFS_REPO/versions/$CCR_VERSION
-export CCR_SOFTWARE_PATH=$CCR_PREFIX/easybuild
-
 # Set custom prompt
 # export PS1="(CCRv${CCR_VERSION}) [\u@\h:\w]$ "
 

config/profile/profile.d/z-000-init.sh

@@ -8,26 +8,22 @@ export LMOD_RC=${LMOD_PACKAGE_PATH}/lmodrc.lua
 export LMOD_SHORT_TIME=3600
 
 if [[ -z "$__Init_Default_Modules" ]]; then
-        NEWMODULERCFILE=${LMOD_PACKAGE_PATH}/modulerc.lua
-        if [[ ! -z "$CCR_CLUSTER" && -f ${LMOD_PACKAGE_PATH}/modulerc_${CCR_CLUSTER}.lua ]]; then
-                NEWMODULERCFILE=${LMOD_PACKAGE_PATH}/modulerc_${CCR_CLUSTER}.lua:${NEWMODULERCFILE}
-        fi
-        export MODULERCFILE=${MODULERCFILE:+:$MODULERCFILE}:${NEWMODULERCFILE}
-        unset NEWMODULERCFILE
-        export MODULEPATH=${CCR_INIT_DIR}/modulefiles
-        __Init_Default_Modules=1; export __Init_Default_Modules;
-        if [[ -z "$LMOD_SYSTEM_DEFAULT_MODULES" ]]; then
-                export LMOD_SYSTEM_DEFAULT_MODULES="StdEnv"
-        fi
-        if [[ $- == *i* ]]; then
-                module --initial_load restore
-        else
-                module -q --initial_load restore
-        fi
+    NEWMODULERCFILE=${LMOD_PACKAGE_PATH}/modulerc.lua
+    if [[ ! -z "$CCR_CLUSTER" && -f ${LMOD_PACKAGE_PATH}/modulerc_${CCR_CLUSTER}.lua ]]; then
+        NEWMODULERCFILE=${LMOD_PACKAGE_PATH}/modulerc_${CCR_CLUSTER}.lua:${NEWMODULERCFILE}
+    fi
+    export MODULERCFILE=${MODULERCFILE:+:$MODULERCFILE}:${NEWMODULERCFILE}
+    unset NEWMODULERCFILE
+    export MODULEPATH=${CCR_INIT_DIR}/modulefiles
+    __Init_Default_Modules=1; export __Init_Default_Modules;
+    if [[ -z "$LMOD_SYSTEM_DEFAULT_MODULES" ]]; then
+        export LMOD_SYSTEM_DEFAULT_MODULES="StdEnv"
+    fi
+    if [[ $- == *i* ]]; then
+        module --initial_load restore
+    else
+        module -q --initial_load restore
+    fi
 else
-        module refresh
-fi
-
-if [[ -d $HOME/modulefiles ]]; then
-        module -q use --priority 100 ${HOME}/modulefiles
+    module refresh
 fi