-
Notifications
You must be signed in to change notification settings - Fork 144
EasyBuild Sprint 2020a toolchains
Starting to use a brand new toolchain is always a challenge, since the limited number of EasyConfigs mean you need to develop a lot yourself. This sprint synchronizes that effort amongst the community, so that together we can kickstart the development of GCCcore-9.3
, foss-2020a
, intel-2020a
based EasyConfigs. Hopefully, this will result in a large number of EasyConfigs being available quickly after the release of the 2020a
toolchains.
The sprint will take place on Tuesday 17th and Thursday 19th of March 2020, 9:00-13:00h CET. During this time, a large number of maintainers will be available for reviewing and accepting PRs.
The idea of having two separate mornings is that straightforward EasyConfigs can go through the full review cycle on the 17th. For more difficult ones, you can get some feedback on the 17th, work on it in the meantime, and try to finalize the PR on the 19th.
- Before the sprint: make sure to prepare your environment so you can participate (see the 'What to prepare before the sprint?' section)
- Check out the wishlist and choose an a software package you want to work on (i.e. make an EasyConfig for). If you want to work on something that is not on the wishlist but that is relevant for your site, just ask one of the maintainers to add it to the wishlist.
- Ask one of the maintainers to add your name to the software package that you will work on. This avoids having two people working on the same EasyConfig at the same time.
- Develop your EasyConfig
- Use
--new-pr
to submit a pull request. In addition, make sure it targets the2020a
branch by adding--pr-target-branch=2020a
- Regularly update your local repository. Do this by changing directory to your local
easybuild-easyconfigs
checkout and runninggit pull github_easybuilders 2020a
- Join the #merge-sprint channel on the EasyBuild Slack
- In addition, we may set up an open Zoom-call. If so, we'll paste a link here.
It is advisable to set up an environment beforehand that
- Runs the development branch of the EasyBuild docs & metapackage repository (https://github.com/easybuilders/easybuild)
- Runs the development branch of the EasyBuild framework (https://github.com/easybuilders/easybuild-framework)
- Runs the development branch of the EasyBlocks (https://github.com/easybuilders/easybuild-easyblocks)
- Runs the 2020a branch of EasyConfigs (https://github.com/easybuilders/easybuild-easyconfigs)
- Already has the 2020a toolchains installed
- Has GitHub integration correctly set up
In order to do create this setup, please take the following steps:
- Make sure you have a GitHub account
- Fork each of the three repositories (https://github.com/easybuilders/easybuild-framework, https://github.com/easybuilders/easybuild-easyblocks, https://github.com/easybuilders/easybuild-easyconfigs)
- Use a the
install-EasyBuild-sprint.sh
script to install the repositories
# pick an installation prefix (adjust as you like)
INSTALL_PREFIX=$(mktemp -d $HOME/EasyBuild-XXXXXX)
# download script
curl -O https://raw.githubusercontent.com/easybuilders/easybuild-framework/develop/easybuild/scripts/install-EasyBuild-sprint.sh
# run downloaded script, specifying *your* GitHub username, the installation prefix and the target easyconfigs-surfsara branch
bash install-EasyBuild-sprint.sh GITHUB_USERNAME $INSTALL_PREFIX 2020a
# update $MODULEPATH via 'module use', and load the module
module use $INSTALL_PREFIX/modules
module load EasyBuild-develop
eb --version ## This should ensure you have a reasonable instance of EasyBuild
In each of the three repositories in your $INSTALL_PREFIX
, you can check that they are set up correctly:
-
git branch
should return* 2020a
(if not: rungit checkout 2020a
) -
git remote -v
should return something like
github_easybuilders [email protected]:easybuilders/easybuild-easyconfigs.git (fetch)
github_easybuilders [email protected]:easybuilders/easybuild-easyconfigs.git (push)
origin [email protected]:${GITHUB_NAME}/easybuild-easyconfigs.git (fetch)
origin [email protected]:${GITHUB_NAME}/easybuild-easyconfigs.git (push)
- For each of the three repositories, do a
git pull github_easybuilders
to make sure all are up to date. You will probably want to do so repeatedly during the sprint (especially in the easybuild-easyconfigs repository, in order to pull in EasyConfigs contributed by others during the sprint)
The above steps have created an installation of a development version of EasyBuild that you will use throughout the sprint. You may however want to mimic (part of) the configuration of your production installation of EasyBuild. One option is to manually modify the installed $INSTALL_PREFIX/modules/EasyBuild-develop
modulefile to export desired EASYBUILD_*
environment variables.
You can check your configuration using
eb --show-config
To set up the GitHub integration, please follow the official EasyBuild documentation on that. You can check it has been set up correctly by trying
eb --check-github
(if you haven't configured a default github user for your EasyBuild installation, don't forget to add --github-user=<username>
)
Depending on what you want to participate in, you may want to install the foss-2020a
or intel-2020a
toolchains. Currently (12 March), the newest toolchain definitions are foss-2020a-rc3
and intel-2020a-rc1
. There may still be slight changes in the toolchain before release, but these are generally not expected to change the functionality of the EasyConfigs.
Since there is no CUDA
version that currently supports GCCcore-9.x
, you do not need to install a newer fosscuda
- development for fosscuda
will likely not happen within this sprint.