Skip to content

Add settings for EasyBuild 5+ to EESSI-extend #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 5, 2025
Merged

Add settings for EasyBuild 5+ to EESSI-extend #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c7d8371
Add settings for EasyBuild 5+ to EESSI-extend
ocaisa Jul 30, 2025
988975c
Fix typo
ocaisa Jul 30, 2025
bfe4704
Copy/paste error
ocaisa Jul 30, 2025
7625ff4
Make style consistent
ocaisa Jul 30, 2025
fd7ed92
Remove setting for env shebang, default is good enough for us as it r…
ocaisa Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/tests_eessi_extend_module.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,19 @@ jobs:
# check some specific ones
check_env_var "EASYBUILD_INSTALLPATH" "$EESSI_SOFTWARE_PATH"
check_env_var "EASYBUILD_UMASK" "022"
# Check some things that are EasyBuild 5+ (available in all EESSI versions so should exist)
check_env_var "EASYBUILD_STRICT_RPATH_SANITY_CHECK" "1"
check_env_var "EASYBUILD_CUDA_SANITY_CHECK_ERROR_ON_FAILED_CHECKS" "1"
check_env_var "EASYBUILD_FAIL_ON_MOD_FILES_GCCCORE" "1"
check_env_var "EASYBUILD_LOCAL_VAR_NAMING_CHECK" "error"
# Check some EESSI version specific settings
if [[ "${{ matrix.EESSI_VERSION }}" != "2023.06" ]]; then
check_env_var "EASYBUILD_PREFER_PYTHON_SEARCH_PATH" "EBPYTHONPREFIXES"
check_env_var "EASYBUILD_MODULE_SEARCH_PATH_HEADERS" "include_paths"
check_env_var "EASYBUILD_SEARCH_PATH_CPP_HEADERS" "include_paths"
fi
# verify the configuration is actually valid
eb --show-config
# unload and check the environment is clean again
module unload EESSI-extend
check_disallowed_env_prefix EASYBUILD_
Expand All @@ -96,6 +109,8 @@ jobs:
# check some specific envvars
check_env_var "EASYBUILD_INSTALLPATH" "$EESSI_SITE_SOFTWARE_PATH"
check_env_var "EASYBUILD_UMASK" "022"
# verify the configuration is actually valid
eb --show-config
# unload and check the environment is clean again
module unload EESSI-extend
check_disallowed_env_prefix EASYBUILD_
Expand All @@ -109,6 +124,8 @@ jobs:
check_env_var "EASYBUILD_INSTALLPATH" "$EXPECTED_INSTALLATION_PATH"
check_env_var "EASYBUILD_UMASK" "002"
check_env_var "EASYBUILD_GROUP_WRITABLE_INSTALLDIR" "1"
# verify the configuration is actually valid
eb --show-config
# unload and check the environment is clean again
module unload EESSI-extend
check_disallowed_env_prefix EASYBUILD_
Expand All @@ -122,6 +139,8 @@ jobs:
export EXPECTED_INSTALLATION_PATH="$MY_INSTALLATION_PATH/$USER/versions/$EESSI_VERSION/software/linux/$EESSI_SOFTWARE_SUBDIR"
check_env_var "EASYBUILD_INSTALLPATH" "$EXPECTED_INSTALLATION_PATH"
check_env_var "EASYBUILD_UMASK" "077"
# verify the configuration is actually valid
eb --show-config
# unload and check the environment is clean again
module unload EESSI-extend
check_disallowed_env_prefix EASYBUILD_
Expand Down
64 changes: 44 additions & 20 deletions EESSI-extend-easybuild.eb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,21 +98,26 @@ if (eessi_accelerator_target ~= nil) then
end
end

-- Some environment variables affect behaviour, let's gather them once
local eessi_cvmfs_install = os.getenv("EESSI_CVMFS_INSTALL") ~= nil
local eessi_site_install = os.getenv("EESSI_SITE_INSTALL") ~= nil
local eessi_project_install = os.getenv("EESSI_PROJECT_INSTALL") ~= nil
local eessi_user_install = os.getenv("EESSI_USER_INSTALL") ~= nil

-- Use an installation prefix that we _should_ have write access to
if (os.getenv("EESSI_CVMFS_INSTALL") ~= nil) then
if eessi_cvmfs_install then
-- Make sure no other EESSI install environment variables are set
if ((os.getenv("EESSI_SITE_INSTALL") ~= nil) or (os.getenv("EESSI_PROJECT_INSTALL") ~= nil) or (os.getenv("EESSI_USER_INSTALL") ~= nil)) then
if (eessi_site_install or eessi_project_install or eessi_user_install) then
LmodError("You cannot use EESSI_CVMFS_INSTALL in combination with any other EESSI_*_INSTALL environment variables")
end
eessi_cvmfs_install = true
easybuild_installpath = os.getenv("EESSI_SOFTWARE_PATH")
-- enforce accelerator subdirectory usage for CVMFS installs (only if an accelerator install is requested)
if (eessi_accelerator_target ~= nil) and (cuda_compute_capability ~= nil) and (os.getenv("EESSI_ACCELERATOR_INSTALL") ~= nil) then
easybuild_installpath = pathJoin(easybuild_installpath, eessi_accelerator_target)
end
elseif (os.getenv("EESSI_SITE_INSTALL") ~= nil) then
elseif eessi_site_install then
-- Make sure no other EESSI install environment variables are set
if ((os.getenv("EESSI_PROJECT_INSTALL") ~= nil) or (os.getenv("EESSI_USER_INSTALL") ~= nil)) then
if (eessi_project_install or eessi_user_install) then
LmodError("You cannot use EESSI_SITE_INSTALL in combination with any other EESSI_*_INSTALL environment variables")
end
easybuild_installpath = os.getenv("EESSI_SITE_SOFTWARE_PATH")
Expand All @@ -122,35 +127,35 @@ elseif (os.getenv("EESSI_SITE_INSTALL") ~= nil) then
end
else
-- Deal with user and project installs
project_install = os.getenv("EESSI_PROJECT_INSTALL")
project_install_dir = os.getenv("EESSI_PROJECT_INSTALL")
project_modulepath = nil
if (project_install ~= nil) then
if eessi_project_install then
-- Check the folder exists
if not isDir(project_install) then
LmodError("The location of EESSI_PROJECT_INSTALL (" .. project_install .. ") does not exist or is not a folder")
if not isDir(project_install_dir) then
LmodError("The location of EESSI_PROJECT_INSTALL (" .. project_install_dir .. ") does not exist or is not a folder")
end
if (mode() == "load") then
LmodMessage("Configuring for use of EESSI_PROJECT_INSTALL under " .. project_install)
LmodMessage("Configuring for use of EESSI_PROJECT_INSTALL under " .. project_install_dir)
end
easybuild_installpath = string.gsub(os.getenv("EESSI_SOFTWARE_PATH"), os.getenv("EESSI_CVMFS_REPO"), project_install)
easybuild_installpath = string.gsub(os.getenv("EESSI_SOFTWARE_PATH"), os.getenv("EESSI_CVMFS_REPO"), project_install_dir)
project_modulepath = pathJoin(easybuild_installpath, 'modules', 'all')
end
user_install = os.getenv("EESSI_USER_INSTALL")
user_install_dir = os.getenv("EESSI_USER_INSTALL")
user_modulepath = nil
if (user_install ~= nil) then
if eessi_user_install then
-- Check the folder exists
if not isDir(user_install) then
LmodError("The location of EESSI_USER_INSTALL (" .. user_install .. ") does not exist or is not a folder")
if not isDir(user_install_dir) then
LmodError("The location of EESSI_USER_INSTALL (" .. user_install_dir .. ") does not exist or is not a folder")
end
elseif (user_install == nil) and (project_install == nil) then
elseif (user_install_dir == nil) and (project_install_dir == nil) then
-- No need to check for existence when we use a HOME subdir
user_install = pathJoin(os.getenv("HOME"), "eessi")
user_install_dir = pathJoin(os.getenv("HOME"), "eessi")
end
if (user_install ~= nil) then
if (user_install_dir ~= nil) then
if (mode() == "load") then
LmodMessage("Configuring for use of EESSI_USER_INSTALL under " .. user_install)
LmodMessage("Configuring for use of EESSI_USER_INSTALL under " .. user_install_dir)
end
easybuild_installpath = string.gsub(os.getenv("EESSI_SOFTWARE_PATH"), os.getenv("EESSI_CVMFS_REPO"), user_install)
easybuild_installpath = string.gsub(os.getenv("EESSI_SOFTWARE_PATH"), os.getenv("EESSI_CVMFS_REPO"), user_install_dir)
user_modulepath = pathJoin(easybuild_installpath, 'modules', 'all')
end
end
Expand Down Expand Up @@ -196,10 +201,29 @@ elseif (project_modulepath ~= nil) then
-- configure MODULEPATH
prepend_path("MODULEPATH", project_modulepath)
end

-- Make sure EasyBuild itself is loaded
-- need to also handle the unload behaviour where the version is defined only before we unload
easybuild_version = os.getenv("EBVERSIONEASYBUILD")
if not ( isloaded("EasyBuild") ) then
load(latest("EasyBuild"))
end
easybuild_version = os.getenv("EBVERSIONEASYBUILD") or easybuild_version
eessi_version = os.getenv("EESSI_VERSION") or "2023.06"

-- Set environment variables that are EasyBuild version specific
if convertToCanonical(easybuild_version) > convertToCanonical("4") then
setenv ("EASYBUILD_STRICT_RPATH_SANITY_CHECK", "1")
setenv ("EASYBUILD_CUDA_SANITY_CHECK_ERROR_ON_FAILED_CHECKS", "1")
setenv ("EASYBUILD_FAIL_ON_MOD_FILES_GCCCORE", "1")
setenv ("EASYBUILD_LOCAL_VAR_NAMING_CHECK", "error")
-- Set environment variables that are EESSI version specific
if convertToCanonical(eessi_version) > convertToCanonical("2023.06") then
setenv ("EASYBUILD_PREFER_PYTHON_SEARCH_PATH", "EBPYTHONPREFIXES")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have strong feelings about this, and I do see the appeal to use $EBPYTHONPREFIXES rather than $PYTHONPATH (works better when using Python virtual environments), but this is in some sense also uncharted territory, so we're bound to run into surprises/problems because we're using this.

Also, not relying on the standard mechanism ($PYTHONPATH) is no doubt going to confuse end users at some point.

So, we should clearly motivate why we're going down this road, since we can't change our mind in the middle, this is an all-or-nothing choice...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The motivation is exactly that, better venv behaviour, but I agree with the main concern about how hard it is to roll back. I was actually hoping you would be the one to sooth me.

End users can still use PYTHONPATH, but we wouldn't. Or are you more concerned about those using EESSI-extend?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm all for EBPYTHONPREFIXES. We have yet to find issues and it allows using venvs which is essential at least to our users.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm mostly concerned about people being confused as to how Python packages can be imported from non-standard locations while we're not using $PYTHONPATH.

The $EBPYTHONPREFIXES approach seems robust, but it's very custom.

That said, I'm not opposing it, just making sure we're aware that we're (yet again) taking a non-standard route here, and there may be dragons along that route...

We should probably add some documentation on the different ways in which we divert from default EasyBuild configuration, and explain the motivation behind those settings => EESSI/docs#519

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EBPYTHONPREFIXES isn't the default? I thought we would change that for EB 5

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not, we kept $PYTHONPATH as default search path (pretty much for the same concerns as I raised here):

    --prefer-python-search-path=PREFER-PYTHON-SEARCH-PATH
                        Prefer using specified environment variable when
                        possible to specify where Python packages were
                        installed; see also https://docs.easybuild.io/python-
                        search-path (type choice; default: PYTHONPATH)
                        (choices: PYTHONPATH, EBPYTHONPREFIXES)

That option is there so you can opt-in to using it though

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After discussing this: let's go through with EBPYTHONPREFIXES.

Although painful, we can actually change our mind later (by patching the module files), but hopefully it won't come to that.

setenv ("EASYBUILD_MODULE_SEARCH_PATH_HEADERS", "include_paths")
setenv ("EASYBUILD_SEARCH_PATH_CPP_HEADERS", "include_paths")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Somewhat similar, why don't we just stick to the default (using $CPATH) here, is the case strong enough to go non-standard here by using $C_INCLUDE_PATH & co instead of $CPATH?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this one is a motivated change IIRC, something related to the DPC++ compiler...will need to dig it out

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue and resolution is in easybuilders/easybuild-framework#3331 (comment) , but that doesn't really help me to be any clearer on what we should do.

@Flamefire You were involved in that discussion, what do you think? Is it enough to only change EASYBUILD_MODULE_SEARCH_PATH_HEADERS?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have seen issues fixed with the new EASYBUILD_MODULE_SEARCH_PATH_HEADERS but am not aware of the same for EASYBUILD_SEARCH_PATH_CPP_HEADERS but it seems sensible and I don't expect issues

I'd say this one is less problematic. If stuff really does break we can unset/change EASYBUILD_SEARCH_PATH_CPP_HEADERS because it isn't ingrained in module files except if the build did pick up wrong includes but I don't see how

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, not opposing it, just making sure we understand the potential implications (which includes confusing users by using a not-so-common approach to specifying the paths to where header files can be found).

It's also worth being aware that $CPATH has precedence over the -isystem compiler option (which sometimes appears in Makefiles), while $C_INCLUDE_PATH do not (so it opens us up potential trouble/surprises in case something like -isystem /usr/include is used).

In this case, we can actually divert from it relatively easy where needed I think...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(see https://github.com/easybuilders/easybuild-framework/pull/4655/files)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm confused. So does that mean that irrespective of this setting, in the modulefile EasyBuild will always set CPATH?

The variables used in module files are changed with EASYBUILD_MODULE_SEARCH_PATH_HEADERS
EASYBUILD_SEARCH_PATH_CPP_HEADERS governs how toolchain paths are set. I'm not fully sure what this actually means as everything should be done by the modules making up the components of the toolchain but seems there are some paths that get set additionally.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, so @Flamefire 's earlier comment that this is more easily revertable

If stuff really does break we can unset/change EASYBUILD_SEARCH_PATH_CPP_HEADERS because it isn't ingrained in module files except if the build did pick up wrong includes but I don't see how

applies to EASYBUILD_SEARCH_PATH_CPP_HEADERS, but changing EASYBUILD_MODULE_SEARCH_PATH_HEADERS is not (as easily) revertible, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, like EASYBUILD_PREFER_PYTHON_SEARCH_PATH it will be burned into the module files

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, worst case we can actually back out later by patching or re-generating the module files, but it likely won't come to that.

To let's move forward by configuring EasyBuild so it doesn't fiddle with $CPATH

end
end
"""

moduleclass = 'devel'