Go to the U of M home page
School of Physics & Astronomy
School of Physics and Astronomy Wiki

User Tools


computing:department:unix:software:modules

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
computing:department:unix:software:modules [2015/08/13 18:34] – Document moved from computing:department:unix:modules allancomputing:department:unix:software:modules [2015/09/09 19:25] (current) allan
Line 1: Line 1:
 ====== Environment Modules ====== ====== Environment Modules ======
  
-Environment Modules is a framework to manage what software is loaded into a user'environment. Its functionality includes the ability to list all software packages currently available in the Environment Modules system, list all software packages loaded into a user's environment, load new software package into a user'environment, and unload a software package from a user's environment.+Environment Modules is a system to manage what software is loaded into your environment. 
 + 
 +It includes the ability to list all software packages currently available in the Modules system, load new software package into your environment, list all loaded software packages, and unload packages.
  
 We use this system, rather than simply including all software in your default PATH, as it permits us to offer alternate versions of the same software, or to provide packages which might normally interfere with each other. We use this system, rather than simply including all software in your default PATH, as it permits us to offer alternate versions of the same software, or to provide packages which might normally interfere with each other.
Line 22: Line 24:
 fastx/1.0-39    intelcce/12.1.3    mathematica/8.0   matlab/2015a       skype/4.3          tecplot/2015r2 fastx/1.0-39    intelcce/12.1.3    mathematica/8.0   matlab/2015a       skype/4.3          tecplot/2015r2
 idl/8.1         mathematica/10.0.2 mathematica/9.0   scisoft/7.5        sm/2.4.36          texlive/2013 idl/8.1         mathematica/10.0.2 mathematica/9.0   scisoft/7.5        sm/2.4.36          texlive/2013
 +
 +</code>
  
 Or (perhaps more useful): Or (perhaps more useful):
Line 58: Line 62:
 </code> </code>
  
-To see what packages are currently loaded into your environment, the command is ''module list''+The command for loading a package into your environment is ''module load <package name>''. This loads the most recent version of the package. For example 
 +  module load idl 
 + 
 +If a specific version of a package is desired, the command can be expanded to module load ''<package name>/<package version>''. For example: 
 +  module load mathematica/9.0 
 + 
 +To see what packages are currently loaded, the command is ''module list''
 <code> <code>
 abcd@lemming> module list abcd@lemming> module list
Line 65: Line 75:
 </code> </code>
  
-The command for loading a package into a user's environment is ''module load <package name>''. This loads the most recent version of ''<package name>''. 
- 
-If a specific version of a package is desired, the command can be expanded to module load ''<package name>/<package version>'', for example: 
-  module load mathematica/8.0 
  
 The command to unload a package is ''module unload <package name>''. This command will also remove any prerequisites for the package being removed. The command to unload a package is ''module unload <package name>''. This command will also remove any prerequisites for the package being removed.
 +
 +===== Adding modules to your login scripts =====
 +
 +The previous changes will allow you to manage your environment in the current shell environment, but will not affect other shells, or new shells.  Thus running something like mpirun may not capture these settings, since the new shells spawned by mpirun may not get the same environment as the original shell.
 +
 +To manage your default environment through modules, begin by adding to the end of your ~/.bashrc or ~/.cshrc startup script the line
 +  module load null
 +  
 +The "null" module actually does nothing in and of itself; it merely provides a placeholder for the following commands to operate on.
 +
 +Next, to add a module to your default environment, use the command
 +  module initadd [module name]
 +
 +This will alter the "module load" line in your startup script to load this module at each shell invocation. In this way you can manage your default environment through the modules package without editing your startup scripts.
 +
 +To disable a default module, use "initrm"
 +  module initrm [module name]
 +
 +This removes that module from the module line in your startup script.
computing/department/unix/software/modules.1439508847.txt.gz · Last modified: 2015/08/13 18:34 by allan