ARCHIVED: For an XSEDE digital service at NICS, where can I find information about using Modules to modify my user environment?

This content has been archived, and is no longer maintained by Indiana University. Information here may no longer be accurate, and links may no longer be available or reliable.

All Extreme Science and Engineering Discovery Environment (XSEDE) digital services automatically enable the Modules environment management package. The Modules package employs "modulefiles" that contain information that set shell environment variables, letting you dynamically modify your user environment.

On an XSEDE digital service hosted by the National Institute for Computational Sciences (NICS), to find information on Modules, at the command prompt, enter:

  module help

Note: Ignore the module init* commands. They modify a .modulerc file that is incompatible with the way Modules is configured on NICS digital services. If you encounter a problem, remove any .modulerc files, log out, and then log in again. If a problem persists, contact the XSEDE Help Desk.

Some common Modules commands include:

Command Action
module avail List all software packages available on the system.
module avail package List all versions of package available on the system; for example:

  module avail openmpi
module list List all packages currently added to your user environment.
module load package Add the default version of the package to your user environment; for example:

  module load intel
module load package/version Add the specified version of the package to your user environment; for example:

  module load intel/11.1
module unload package Remove the specified package from your user environment.
module swap package_A package_B Swap the loaded package (package_A) with another package (package_B). This is synonymous with:

  module switch package_A package_B
module show package Show the changes loading the specified package makes to your user environment (e.g., environment variables set, library paths added). This is synonymous with:

  module display package

For more about using Modules on NICS digital services, see the NICS Modules page. For more about Modules on XSEDE, see the XSEDE Computing Environments page.

This document was developed with support from National Science Foundation (NSF) grants 1053575 and 1548562. Any opinions, findings, conclusions, or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the NSF.

This is document bcvb in the Knowledge Base.
Last modified on 2018-01-18 17:28:43.