Software stacks¶
The LUMI software stacks are made available through the LMOD module environment.
Overview¶
On LUMI, two types of software stacks are currently offered:
-
CrayEnv offers the Cray Programming Environment (PE) and allows one to use it completely in the way intended by HPE-Cray. The environment also offers a limited selection of additional tools, often in updated versions compared to what SUSE Linux, the basis of the Cray Linux environment, offers. If you need a richer environment, you should use our other software stacks.
-
LUMI is an extensible software stack that is mostly managed through EasyBuild. Each version of the LUMI software stack is based on the version of the Cray Programming Environment with the same version number.
A deliberate choice was made to only offer a limited number of software packages in the globally installed stack as the setup of redundancy on LUMI makes it difficult to update the stack in a way that is guaranteed to not affect running jobs and as a large central stack is also hard to manage. However, the EasyBuild setup is such that users can easily install additional software in their home or project directory using EasyBuild build recipes that we provide or they develop, and that software will fully integrate in the central stack (even the corresponding modules will be made available automatically). In that way, users can create their own project environment in a way that is not harder than using tools like conda or Python virtual environments, while building a software installation that is fully tuned to the hardware of LUMI.
Using Python and R
Software on LUMI is installed on parallel file systems. These file systems are meant for storing large files and not for accessing thousands of small files. As Python and R store their packages precisely that way, performance (and certainly installation performance) can be very poor on systems like LUMI.
For Python we offer Container Wrapper (module
lumi-container-wrapper
) which can be used to install packages on top of
the cray-python
module using pip
, or to create a Conda installation.
Note that packages that pip
or conda install from binaries may not be properly
optimized for the hardware of LUMI, and it is rather likely that MPI
libraries installed that way will not function well on LUMI, certainly
when they use MPI.
Installing software with Conda
Installing software through Conda should be the method of last resort on LUMI. Conda installations suffer from the same problem as Python and R installations when it comes to the number of files. Moreover, they are not guaranteed to be compatible with the Linux environment on LUMI. Problems can be expected with MPI as Conda will usually install its own MPI that is likely incompatible with the Slingshot 11 interconnect of LUMI or doesn't recognize its performance features and uses it only in the much slower TCP/IP mode. Moreover, many Conda-provided binaries are only compiled for a generic 64-bit x86 processor and don't use any of the newer instructions or don't contain other processor-specific optimisations.
We do recognize, however, that sometimes there are no other options.
Therefore we offer Container Wrapper (module
lumi-container-wrapper
) to pack a Conda installation in a way that
is more friendly to the parallel file system of LUMI while maintaining
easy access to the tools installed in the Conda environment.
Selecting the software stack¶
Running module avail
on a fresh shell will show a list like:
$ module avail
... some lines removed here
-------------------------- HPE-Cray PE modules ----------------------------
PrgEnv-aocc/8.0.0 (D) cray-openshmemx/11.3.2
PrgEnv-aocc/8.1.0 cray-pals/1.0.14
... some lines removed here
----------------------------- Software stacks -----------------------------
CrayEnv (S) LUMI/21.08 (S,D) LUMI/21.12 (S)
--------------------- Modify the module display style ---------------------
ModuleColour/off (S) ModuleLabel/system (S)
ModuleColour/on (S,D) ModulePowerUser/LUMI (S)
ModuleLabel/label (S,D) ModuleStyle/default
ModuleLabel/PEhierarchy (S) ModuleStyle/reset (D)
-------------------------- System initialisation --------------------------
init-lumi/0.1 (S,L)
------------------------- Non-PE HPE-Cray modules -------------------------
... some lines removed here
------------------- This is a list of module extensions -------------------
Autoconf (E) GPP (E) Yasm (E) libtool (E)
Autoconf-archive (E) M4 (E) byacc (E) make (E)
Automake (E) Meson (E) flex (E) patchelf (E)
Bison (E) NASM (E) gperf (E) re2c (E)
CMake (E) Ninja (E) help2man (E) sec (E)
Doxygen (E) SCons (E) htop (E) tree (E)
The first block(s) in the output are the modules available through the default software stack.
The Software stacks block in the output shows the available software stacks:
CrayEnv
, LUMI/21.08
and LUMI/21.12
in this example.
The (S)
besides the name shows that these are sticky modules
that won't be removed by default by module purge
. This is done to enable you
to quickly clean your environment without having to re-initialise from scratch.
In the future we may mark some stacks also with LTS
next to their name
which would then denote that this is a release that we will try
to support long-term (ideally two years), but currently the system is
changing too rapidly (as some of the hardware is new and not an evolution of
previous hardware) so we cannot guarantee any level of longevity for any
of the software stacks.
The next block, titled Modify the module display style, contains several modules that can be used to change the way the module tree is displayed:
ModuleColour
: these modules can be used to turn the colour on or off in the module display.ModuleLabel
: change the way the modules are subdivided in blocks and the way those blocks are presented.ModuleLabel/label
is the default and will collapse related groups of modules in single blocks, including the Cray PE modules.ModuleLabel/PEhierarchy
: will still use the user-friendly style of labeling but will show the complete hierarchy in the modules of the Cray PE.ModuleLabel/system
: does not use the user-friendly label texts, but shows the path of the module directory instead.ModulePowerUser
: will also reveal several hidden modules, most of which are only important to sysadmins or users who really want to do EasyBuild development in a clone of the software stack.
CrayEnv¶
Loading CrayEnv
will essentially give you the default Cray environment
enriched with several additional tools. The CrayEnv
module will try to
detect the node type of LUMI it is running on and load an appropriate set of
target architecture modules to configure the Cray PE (see the documentation
page on the programming environment in the Development section).
Executing a module purge
while working in the CrayEnv
environment will
automatically reload that module and restore the target architecture modules
to a set suitable for the node type you are working on.
LUMI¶
LUMI
is our main software stack, managed mostly with EasyBuild.
It contains software build with the system compiler and the PrgEnv-gnu
,
PrgEnv-cray
and PrgEnv-aocc
programming environments, which includes Cray
MPI and the Cray scientific libraries. As mixing compiler versions and library
versions is dangerous, the stack is organised in versions that correspond to the
version of the Cray PE used to compile the software. Some versions may have the
extension .dev
which denotes that they are highly experimental and under
development, and may completely change or disappear at some point.
The LUMI software stack is activated by loading the desired version of the LUMI module, e.g.,
The LUMI
module will try to detect the node type it is running on and will
automatically select the software stack for the node type by automatically
loading a partition
module. However, that choice can always be overwritten by
loading another partition
module, and this can even be done in a single
command, e.g.,
will load the software stack for the login nodes (which in fact will also work on the compute nodes and data analysis and visualisation nodes).
Only partition/L and partition/C are supported
Note that in the initial version of the software stack, only partition/L
and partition/C
are supported. Software in partition/L
can be used on
the compute nodes also and there is even some MPI-based software already
installed in that partition. However, from the LUMI/21.12
stack on,
software compiled in partition/C
may offer better performance on the
compute nodes of LUMI-C as that software is not optimised for the specific
architecture of the CPUs in those nodes.
Running MPI programs is not supported on the login nodes, but those modules may still contain useful pre- or postprocessing software that can be used on the login nodes.
Once loaded you will be presented with a lot of modules in a flat naming scheme. This means that all software available in that version of the LUMI software stack will be shown by module avail (except for hidden modules for software that we deem most users may not directly load). However, not any combination of modules can be loaded together. In particular, software compiled with different programming environments cannot be used together. There are five types of modules:
-
The module version contains
cpeGNU-yy.mm
(withyy.mm
the version of the LUMI stack): The package is compiled with thePrgEnv-gnu
programming environment. -
The module version contains
cpeCray-yy.mm
: The package is compiled with thePrgEnv-cray
programming environment. -
The module version contains
cpeAOCC-yy.mm
: The package is compiled with thePrgEnv-aocc
programming environment, the AMD compilers for CPU-only work (hence available only on LUMI-C, LUMI-D and the login nodes) -
The module version contains
cpeAMD-yy.mm
: The package is compiled with thePrgEnv-AMD
programming environment, the Cray wrapper around the AMD ROCm compilers. This environment will only be offered on LUMI-G. -
The name contains neither of those: The package is compiled with the system gcc compiler, something that is only done for software that is not performance-critical like some build tools and workflow tools.
In EasyBuild, cpeGNU
, cpeCray
, cpeAOCC
and cpeAMD
are called toolchains, a set of
compatible compilers, MPI and mathematical libraries. Software compiled with the
system compiler is also called software compiled with the system toolchain,
which is a restricted toolchain that only contains the compiler. Software
compiled with different cpe*
toolchains cannot be loaded at the same time but
can be loaded together with software compiled with the SYSTEM toolchain. The
module system currently does not protect you against making such mistakes!
However, software may fail to work properly.
Issue: cpeAOCC not in 21.08
In LUMI/21.08
, cpeAOCC
can not work as the AMD compiler is not properly
installed. Hence the cpeAOCC
toolchain is only offered from the21.12
stack
on.
Adding additional software to the LUMI software stack¶
The LUMI
software stack itself cannot offer all software to all users as that
would be both confusing (certainly as sometimes customisations are expected) and
impossible to maintain (as it would not be clear when software can be removed
and no longer needs to be updated). Therefore, the LUMI
software stack can be
extended with software installed in the user's space through EasyBuild in a way
that is 100% compatible with the system stack. That software will be
automatically visible when loading the LUMI
module.
The default location for user-installed software in $HOME/EasyBuild
. However,
we advise to install software in the /project
directory of the project
instead so that a single software installation can be used by all members of the
project. This is done by pointing the environment variable EBU_USER_PREFIX
to
the software installation directory, e.g.,
It is a good idea to do this in your .profile
or .bashrc
file. This will
enable the LUMI
modules to also find the software installed in that directory.
Loading the EasyBuild-user
module will enable installing software with
EasyBuild for the current version of the LUMI
software stack and current node
type (partition
module).
More information can be found on our page of managing software with EasyBuild (to be written). Technical documentation is available in the documentation directory of the LUMI software stack repository on GitHub.