How to use modules

How to use modules

Overview:

The chip cluster is divided up amongst different years of hardware, bought in 2018, 2021, and 2024. For more information:

Cluster Specifications

Only certain modules can be used on certain years of hardware, so it’s important to refer to this page to see what modules can be used on which years of hardware:

Available Software and Packages on chip (Not University-wide)

Load Modules:

Note: You can only load modules on compute nodes, not the login node. This means, if you’re on the “chip” node, you cannot load modules. You know you’re on the chip node when your terminal looks like this:

[USERNAME@chip ~]$

The “chip” denotes that you are on the login node, called “chip”.

Loads a single module and its dependencies.

module load MODULENAME

Example:

module name: intel: 2021a

module load intel/2021a

List Available Modules:

How to see all available modules:

Example:

module avail
image-20250708-133206.png

It will output a list of all available modules, which you can navigate through there. Alternatively, you can see all available modules here: Available Software and Packages on chip (Not University-wide)

How to see all modules:

How to see all modules, not just ones available to you currently.

Example:

module spider
image-20250710-143753.png

It will print all modules, not just available ones.

Search Modules:

How to search for modules, with either module avail or module spider.

Search for a module amongst available modules:

module avail MODULENAME

Search for a module amongst all modules:

module spider MODULENAME

Example:

Module name: intel/2021a

module avail intel/2021a
image-20250710-143949.png

Module name: intel/2021a

module spider intel/2021a
image-20250710-144103.png

How to see what modules you’re currently using:

Lists the modules that you are currently using.

Example:

module list
image-20250708-133631.png

After you load a module, say: intel/2021a from the previous example, module list may look like this:

image-20250708-133754.png

The reason there’s so many more modules after loading just one extra module, is because dependent modules are automatically loaded when loading a new module. You can see intel/2021a in 15).


How to unload a module:

Unloads a single module.

module unload MODULENAME

Example:

module name: intel: 2021a

module unload intel/2021a

module list before:

image-20250708-134556.png

module list after:

image-20250708-134618.png

As you can see, 15) (intel/2021a) was removed, an important thing to note is that it’s dependencies do not get unloaded too, only the specified module.


How to reset modules:

Resets all modules to the default slurm modules.

Example:

Currently loaded module: intel: 2021a and it’s dependencies.

module reset

module list before:

image-20250708-135200.png

module list after:

image-20250708-135212.png

How to unload all modules:

Unloads all modules.

Example:

module purge

module list before:

image-20250708-135200.png

module list after:

image-20250708-135449.png