"Author: [Jens Henrik Göbbert](mailto:j.goebbert@fz-juelich.de)\n",
"------------------------------------"
]
},
{
"cell_type": "markdown",
"metadata": {
"toc-hr-collapsed": false
},
"source": [
"# How to install User Software using EasyBuild\n",
"\n",
"[EasyBuild](https://www.easybuild.io) is a software build and installation framework that allows you to manage (scientific) software on High Performance Computing (HPC) systems in an efficient way. \n",
"All software modules you can load with `module load` on the supercomputers at the Jülich Supercomputing Centre (JSC) was installed using EasyBuild.\n",
"\n",
"There are multiple reasons for a build & installation framework like [EasyBuild](https://easybuild.io). \n",
"And some reasons are not only convincing for HPC centers but also for HPC users: \n",
"- fully automates software builds\n",
"- allows for easily reproducing previous builds\n",
"- keep the software build recipes/specifications simple and human-readable\n",
"- supports co-existence of versions/builds via dedicated installation prefix and module files\n",
"- automagic dependency resolution\n",
"- ...\n",
" \n",
"<div class=\"alert alert-block alert-info\">\n",
"<b>UserInstallations</b></br>\n",
"allow you to easily install software for your own use or for everyone in your compute-time project.</br> \n",
"</div>\n",
"This notebook shows you how to make and load your own first software module.\n",
"\n",
"-------------------------"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Introduction\n",
"\n",
"Whenever you want to load a certain software module you call `module load <software>` . \n",
"This command searches all paths in `$MODULEPATH` for a matching configuration file.\n",
"\n",
"In general you start loading first a software stage, then a compiler and after that a MPI. \n",
Author: [Jens Henrik Göbbert](mailto:j.goebbert@fz-juelich.de)
------------------------------------
%% Cell type:markdown id: tags:
# How to install User Software using EasyBuild
[EasyBuild](https://www.easybuild.io) is a software build and installation framework that allows you to manage (scientific) software on High Performance Computing (HPC) systems in an efficient way.
All software modules you can load with `module load` on the supercomputers at the Jülich Supercomputing Centre (JSC) was installed using EasyBuild.
There are multiple reasons for a build & installation framework like [EasyBuild](https://easybuild.io).
And some reasons are not only convincing for HPC centers but also for HPC users:
- fully automates software builds
- allows for easily reproducing previous builds
- keep the software build recipes/specifications simple and human-readable
- supports co-existence of versions/builds via dedicated installation prefix and module files
- automagic dependency resolution
- ...
<divclass="alert alert-block alert-info">
<b>UserInstallations</b></br>
allow you to easily install software for your own use or for everyone in your compute-time project.</br>
</div>
This notebook shows you how to make and load your own first software module.
-------------------------
%% Cell type:markdown id: tags:
## Introduction
Whenever you want to load a certain software module you call `module load <software>` .
This command searches all paths in `$MODULEPATH` for a matching configuration file.
In general you start loading first a software stage, then a compiler and after that a MPI.
e.g. `module load Stages/2020 GCC/10.3.0 ParaStationMPI`
These special modules (stages, compilers, MPIs) additionally extend the module paths in `$MODULEPATH` .
It ensures that you can load further modules, which fit to the loaded stage, compiler and MPI.
Now, if compatible private or project software modules are installed (by yourself or someone in your project)
the module paths is **additionally extended** by the special modules (compilers, MPIs) with ...
<divclass="alert alert-block alert-info">
<b>User-specific module paths</b></br>
<ul>
<li>\$HOME/easybuild</li>
<li>\$PROJECT/easybuild</li>
</ul>
</div>
The hierarchy of preference is `$HOME/easybuild` highest, then `$PROJECT/easybuild`, then the system installation:
