HPC Home‎ > ‎User Support‎ > ‎

HPC Module

Simply stated, a module is a packaging of definitions of environment variables into a script. In general, there is a module defined for each application, and that module defines the environment appropriately for that application. To use the application, you need to load the module first using the module command:

module load <software-module>

For an example, if the software-module is "matlab", it becomes "module load matlab".

If there are more versions, let's say matlab/R2017b, then it becomes:

module load matlab/R2017b

Important module commands:To see the modules of the available software in the Cluster
module avail

Some of the Software such as cmake has dependency module to be loaded first. So, you may want to use "module spider" command to see the details.
 module spider cmake
output:
--------------------------------------------------------------------------------------------------------------------------------------------------------------------
  cmake: cmake/3.2.2
--------------------------------------------------------------------------------------------------------------------------------------------------------------------

    This module can only be loaded through the following modules:

      depends

Now, you need to load the cmake modue as:
module load depends
module load cmake

If you want to check the versions of the particular software such as matlab, then type:
module avail matlab
output:
...
matlab/R2014b          matlab/R2015b(default)

To get the version, path of executable and libraries, and other information about the software-module (e.g. matlab):
module display <software-module>
For matlab, the output looks like:
-------------------------------------------------------------------
/usr/local/share/modulefiles/matlab/r2012b:

module-whatis    loads the MATLAB package 
setenv           MATLAB /usr/local/r2012b 
setenv           MATLAB_COMM native 
prepend-path     PATH /usr/local/r2012b/bin 
prepend-path     LD_LIBRARY_PATH /usr/local/r2012b/runtime/glnxa64:/usr/local/r2012b/bin/glnxa64:/usr/local/r2012b/sys/os/glnxa64:/usr/local/r2012b/sys/java/jre/glnxa64/jre/lib/amd64/native_threads:/usr/local/r2012b/sys/java/jre/glnxa64/jre/lib/amd64/server:/usr/local/r2012b/sys/java/jre/glnxa64/jre/lib/amd64/client:/usr/local/r2012b/sys/java/jre/glnxa64/jre/lib/amd64 
-------------------------------------------------------------------
Here, the binary path for matlabr2012b is /usr/local/r2012b/bin and there are many library paths for MATLAB compilation.

To load the sotware-module, use the command:
module load <software-module>

To unload it, use:
module unload <software-module>

To see which modules you have loaded, use:
module list


Comments
Anonymous
Anonymous
Cancel
You do not have permission to add comments.