Using modules to load software

A large number of software packages are installed on the ALICE system, this software can be loaded into your environment using the modules command.

You can view the modules that are available on ALICE using the command:

module avail

This will produce a list of the modules installed on the base system, for example:

---------------------------------------------------------- /cm/shared/spack/share/spack/lmod/linux-rocky9-x86_64/openmpi/4.1.5-fzc7xdf/gcc/12.3.0 ----------------------------------------------------------
   amdscalapack/4.0-pzkqop6        hdf5/1.14.1-2-ko74fhe (D)    hpl/2.3-izhja5g      netcdf-c/4.9.2-takdh6y    netcdf-fortran/4.6.0-k324wun      openfoam/2206-u3p6inz
   fftw/3.3.10-7vv67hw      (D)    hdfview/3.3.0-2as7u6p        ior/3.3.0-5bv5cun    netcdf-cxx/4.2-i3wudts    netlib-scalapack/2.2.0-omfw4yo    paraview/5.10.1-ylkl7uy

--------------------------------------------------------------------- /cm/shared/spack/share/spack/lmod/linux-rocky9-x86_64/gcc/12.3.0 ---------------------------------------------------------------------
   amdblis/4.0-76sw54l        cfitsio/4.2.0-ce37fwm    hdf5/1.14.1-2-icepdni                iozone/3_506-i4hfj4d       openmpi/4.1.5-fzc7xdf (L)    py-matplotlib/3.7.1-puvwf2t    python/3.10.12-tggsi7t
   amdlibflame/4.0-4mkvff4    fftw/3.3.10-kalcry7      intel-oneapi-mkl/2023.1.0-y4d37ym    libffi/3.4.4-zn24wvl       perl/5.36.0-c6rh2fh          py-numpy/1.25.0-dv7bfyd
   aocl-sparse/4.0-6p236n5    gnuplot/5.4.3-mrtpgde    intel-oneapi-tbb/2021.9.0-vsbsei3    openblas/0.3.23-nlx367r    proj/6.3.2-wjwbyit           py-scipy/1.11.1-pl7kezx

------------------------------------------------------------------------ /cm/shared/spack/share/spack/lmod/linux-rocky9-x86_64/Core ------------------------------------------------------------------------
   aocc/4.0.0-zvknyyf    gcc/12.3.0-yxgv2bl (L,D)    intel-oneapi-compilers/2023.1.0-2lityth

------------------------------------------------------------------------------------------ /cm/local/modulefiles -------------------------------------------------------------------------------------------
   boost/1.77.0         cm-bios-tools        cmjob        freeipmi/1.6.8    ipmitool/1.8.18    luajit          module-git     null        python3     shared
   cluster-tools/9.2    cmd           (L)    dot   (L)    gcc/11.2.0        lua/5.4.6          mariadb-libs    module-info    openldap    python39

------------------------------------------------------------------------------------------ /cm/shared/modulefiles ------------------------------------------------------------------------------------------
   cuda11.8/blas/11.8.0      cuda11.8/profiler/11.8.0    cuda12.1/fft/12.1.0         cuda12.1/toolkit/12.1.0       default-environment (L)    ucx/1.10.1
   cuda11.8/fft/11.8.0       cuda11.8/toolkit/11.8.0     cuda12.1/nsight/12.1.0      cudnn8.5-cuda11.8/8.5.0.96    hdf5/1.12.1
   cuda11.8/nsight/11.8.0    cuda12.1/blas/12.1.0        cuda12.1/profiler/12.1.0    cudnn8.9-cuda12.1/8.9.1.23    hdf5_18/1.8.21

------------------------------------------------------------------------------------------ /usr/share/modulefiles ------------------------------------------------------------------------------------------
   StdEnv (L)

  Where:
   L:  Module is loaded
   D:  Default Module

Use "module spider" to find all possible modules and extensions.
Use "module keyword key1 key2 ..." to search for all possible modules matching any of the "keys".

A number of modules in the list have an (L) by their name - these are modules that are loaded into your environment. To get a list of modules that are loaded - run:

module list

This will show what modules you have loaded for use in your environment. A basic default set of modules is loaded for you when you first log in:

  1) cmd   2) StdEnv   3) dot   4) gcc/12.3.0-yxgv2bl   5) openmpi/4.1.5-fzc7xdf   6) default-environment

You can also use module avail to search modules by name, for example, to list all modules with "intel" in their name:

module av intel


--------------------------------------------------------------------- /cm/shared/spack/share/spack/lmod/linux-rocky9-x86_64/gcc/12.3.0 ---------------------------------------------------------------------
   intel-oneapi-mkl/2023.1.0-y4d37ym    intel-oneapi-tbb/2021.9.0-vsbsei3

------------------------------------------------------------------------ /cm/shared/spack/share/spack/lmod/linux-rocky9-x86_64/Core ------------------------------------------------------------------------
   intel-oneapi-compilers/2023.1.0-2lityth

Use "module spider" to find all possible modules and extensions.
Use "module keyword key1 key2 ..." to search for all possible modules matching any of the "keys".

The gcc/12.3.0 and openmpi/4.1.5 modules load the default compiler and openmpi library respectively - other compilers and mpi variants are available, however changing these modules will change what other modules are available to you (see compiler toolchains and MPI heirarchy below.

To load a module, use the mpi load command - for example - to load the cfitsio library:

module load cfitsio/4.2.0

to remove the module from your environment run:

module load cfitsio/4.2.0

more information on what a module provides can be found with:

module show cfitsio/4.2.0

You can unload all loaded modules (including the default ones) by running:

module purge