Please see our Software Guide for setting up your software to be used in batch or interactively.
Note that our software uses the lmod package manager to allow for multiple versions of similar software due to research needs. The basic commands you will want to know to get started are:
The modules software provides the module
command, an easy mechanism for changing the environment as you need to add or remove software packages from your environment. A module is a collection of environment variable settings that can be loaded or unloaded. When you first log in, a set of modules is loaded by default. To see which modules are currently loaded, you can use the command
$ module list
To see what modules are available, or to see which versions of a particular package (Matlab in the example) are available, you can use (respectively) the commands
Loading a software package’s module will set up the environment variables needed for that package to run.
If you want to use matlab, you sould type the command
$ module load matlab
the version labeled (default)
will be loaded. If there is no default version set, then the one with the highest version number will be loaded.
This module load is another part of what you add to the script you create to run your job.
Searching by name
To search for all installed software by module name, regardless whether it is currently available or not, you should use the spider
subcommand. The following example shows the output from searching for fftw
, which shows version 3.3.7 is installed and that the module fftw-mpi
is a ‘near miss’.
$ module spider fftw ---------------------------------------------------------------------------- fftw: ---------------------------------------------------------------------------- Description: Libraries for computation of discrete Fourier transform. Versions: fftw/3.3.7 Other possible modules matches: fftw-mpi ---------------------------------------------------------------------------- To find other possible module matches execute: $ module -r spider '.*fftw.*' ---------------------------------------------------------------------------- For detailed information about a specific "fftw" module (including how to load the modules) use the module's full name. For example: $ module spider fftw/3.3.7 ----------------------------------------------------------------------------
Note that wildcard matches use the .*
to match zero or more characters, not a plain *
character.
The last line shows you the command to run to find out how you can load fftw. Running that command shows the following command.
$ module spider fftw/3.3.7 ---------------------------------------------------------------------------- fftw: fftw/3.3.7 ---------------------------------------------------------------------------- Description: Libraries for computation of discrete Fourier transform. You will need to load all module(s) on any one of the lines below before the "fftw/3.3.7" module is available to load. gcc/4.8.5 intel/18.0.0
From that, you will see that you must load one of the modules gcc/4.8.5
or intel/18.0.0
first, after which the fftw
software that matches the loaded compiler will then be available to load.