Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

No Format
$ module load git
load git 2.20.1 (git_DIR, GIT_VERSION, PATH)


Tip

Note that Lmod knows if it is already loaded, and will actually swap unload the old one and load the new one (swapping them)

No Format
$ module load git/new
unload git 2.20.1 (git_DIR, GIT_VERSION, PATH)
load git 2.25.1 (git_DIR, GIT_VERSION, PATH)

The following have been reloaded with a version change:
  1) git/2.20.1 => git/2.25.1


...

No Format
$ module swap git/new
unload git 2.20.1 (git_DIR, GIT_VERSION, PATH)
load git 2.25.1 (git_DIR, GIT_VERSION, PATH)

The following have been reloaded
The following have been reloaded with a version change:
  1) git/2.20.1 => git/2.25.1

...

No Format
$ module unload git
unload git 2.25.1 (git_DIR, GIT_VERSION, PATH)

module purge

...

module reset

Restore the system default modules. It effectively resets the environment to the system default for a fresh session.

No Format
$ module list

Currently Loaded Modules:
  1) gcc/8.3.1   2) prgenv/gnu   3) git/2.26.0   4) cmake/3.16.5

 

$ module reset
Resetting modules to system default. Reseting $MODULEPATH back to system default. All extra directories will be removed from $MODULEPATH.
$ module list

Currently Loaded Modules:
  1) gcc/8.3.1   2) prgenv/gnu

module purge

Unload all modules.

Note

This will also unload default modules such as prgenv, and you may need to load them again to see a more complete module tree. Use of module reset is normally preferred.


No Format
$ module list

Currently Loaded Modules:
  1) git/2.20.1   2) cmake/3.16.5

$ module purge
unload$ cmake 3.16.5 (CMAKE_DIR, CMAKE_VERSION, PATH
unload git 2.20.1 (git_DIR, GIT_VERSION, PATH)

module list
No modules loaded

Listing and Searching

module list

...

If you want to create a new collection, make sure you start from a clean set with module purge and load only those modules you require before you save them.

No Format
$ module purge
$ module load git cmake
load git 2.20.1 (git_DIR, GIT_VERSION, PATH)
load cmake 3.16.5 (CMAKE_DIR, CMAKE_VERSION, PATH purge
$ module load git cmake
$ module save
Saved current collection of modules to: "default", for system: "tems"

...

And to create a named collection:

No Format
$ module load git
load git 2.20.1 (git_DIR, GIT_VERSION, PATH)
$ module save mycollection
Saved current collection of modules to: "mycollection", for system: "tems"

...

No Format
$ module restore mycollection
Restoring modules from user's mycollection, for system: "tems"
load git 2.20.1 (git_DIR, GIT_VERSION, PATH)

module savelist

See all the collections that are available for the user on this system

...

No Format
$ module describe
Collection "default" contains: 
   1) git    2) cmake    3) modulemgr    4) python3cmake

$ module describe mycollection 
Collection "mycollection" contains: 
   1) git

...

No Format
$ module disable mycollection
Disabling mycollection collection by renaming with a "~"
usxa@at1-11: ~ [2020-03-19 12:31:21 UTC] [0] 
$ module savelist
Named collection list (For LMOD_SYSTEM_NAME = "tems"):
  1) default

...

No Format
$ ml

Currently Loaded Modules:
  1) git/2.20.1
 
$ ml git/new
unload git 2.20.1 (git_DIR, GIT_VERSION, PATH)
load git 2.25.1 (git_DIR, GIT_VERSION, PATH)

The following have been reloaded with a version change:
  1) git/2.20.1 => git/2.25.1

$ ml

Currently Loaded Modules:
  1) git/2.25.1

$ ml -git
$
$ ml whatis git
git/2.25.1          : Git is a free and open source distributed version control system.

...