LOCALMOD_DIR=$HOME/localmod           # *** EDITABLE, set to an empty path ***

mkdir -p ${LOCALMOD_DIR}              # Create the directory if not already exist
cat << Eof >> $HOME/.bashrc           # Define the below "localmod" function in your .bashrc
function localmod(){
  export EASYBUILD_PREFIX=${LOCALMOD_DIR}   
  module use ${EASYBUILD_PREFIX}/modules/all
  export EASYBUILD_OPTARCH=x86-milan
  echo "*** Import modules at ${EASYBUILD_PREFIX} on LANTA ***"
}
Eof

• module use will import extra modules to your Lmod system, i.e., MODULEPATH.

• EASYBUILD_PREFIX variable is for setting default paths when using EasyBuild.

• EASYBUILD_OPTARCH variable must be set to x86-milan to be consistent with LANTA hardware.

LOCALMOD_DIR could be set to any preferred directory. To share your local modules with your project members, you could use a directory in your project path, like LOCALMOD_DIR=/project/ltxxxxxx-yyyyyy/localmod, for example.

By default, only you, the person who create the directory, have permission to install modules in it. However, your project members can access and use your modules by executing module use /project/ltxxxxxx-yyyyyy/localmod/modules/all directly or by setting the localmod command with the same LOCALMOD_DIR as you have done.

• You need to re-login or execute source $HOME/.bashrc for the changes to take effects.

• The above step needs to be done only once.

localmod
module load EasyBuild
eb --show-config

• Employing the CPE toolchain with the same compiler as utilized in the original EasyConfig file should minimize potential issues and changes in Step 3. That is,

  • GCCcore, GCC, foss, gmpich → cpeGNU

  • intel, iccifort, iimpi → cpeIntel

• Use ('<name>', '<version>', '[suffix]', SYSTEM), such as ('binutils', '2.40', '', SYSTEM) and ('Mako', '1.2.4', '-cray-python-3.10.10', SYSTEM), if the module name does not contain cpeXXX.

• For cray-* modules, use ('cray-<name>/<version>', EXTERNAL_MODULE) where <version> should be the default version that the CPE toolchain used. This is to ensure that they are consistent across your module chain. A summary table is provided below.
  Additionally, you have to sort cray-* modules according to its hierarchy as well (see).

• If you want to add extra options/flags at configure, build, or install stages, you could use preconfigopts, configopts, prebuildopts, buildopts, preinstallopts and installopts (see).

• -D :
  Do a short dry run to check EasyConfig hierarchy. No modules will be installed.

• --robot-paths=$(pwd):
  Add all EasyConfig files in the current directory to EasyBuild search path

• -r:
  Robot. Recursively install dependencies prior to the target software.
  Note: you may use -r $(pwd) instead of -r --robot-paths=$(pwd).

• --parallel=N:
  Build the software using N CPU cores, e.g., make -j N

• --trace --tmpdir=$(pwd): (Optional)
  Provide more information on progress and save logs to the current path. Recommend using them together.

• For more information, execute eb --help, eb -a and others in eb --help | grep 'avail'

--parallel=N where N<8 is essential since the default 128 would put a burden on the frontend node, prompting admins to kill your process.

Some software may not support parallel build; therefore, --parallel=1 is recommended.

Don’t forget to enable local module by executing the localmod command defined in Step 0

#!/bin/bash
#SBATCH -p compute              # Partition
#SBATCH -N 1                    # Number of nodes
#SBATCH --ntasks-per-node=128   # Number of MPI processes per node
#SBATCH --cpus-per-task=1       # Number of OpenMP threads per MPI process
#SBATCH -t 5-00:00:00           # Job runtime limit
#SBATCH -J MyJob                # Job name
#SBATCH -A ltxxxxxx             # Account *** {USER EDIT} *** 

source $HOME/.bashrc
localmod

module purge
module load <your-local-module>

export OMP_NUM_THREADS=${SLURM_CPUS_PER_TASK}

srun -c${SLURM_CPUS_PER_TASK} <software-command>