Difference between revisions of "Modules"

From UFRC
Jump to navigation Jump to search
Line 8: Line 8:
  
 
==Personal modules==
 
==Personal modules==
You can write and use your own modulefiles. The procedure for making them available is very simple. Load the ''"personal"'' module to have a ''"$HOME/.modules"'' directory automatically created and the environment set up for using it to house your personal modulefile sub-directories. For example, once the ''"personal"'' module is loaded you can create a ''"myapp"'' sub-directory under ''"$HOME/.modules"'' and put a modulefile named version.lua, like ''"1.0.lua"'' for instance, into that directory to make the ''"myapp/1.0"'' module available.
+
You can write and use your own modulefiles. The procedure for making them available is very simple. For example, if you'd like to create version 1.0 of the module 'mymod' pick any directory you own, say ~/modules:
 +
* Create a personal module directory
 +
mkdir ~/modules
 +
* Add a 'mymod' module directory
 +
mkdir ~/modules/mymod
 +
* Add a modulefile
 +
touch ~/modules/mymod/1.0.lua
 +
 
 +
Note that you can copy any environment module we have in /apps/lmod/modulefiles to serve as a starting point for your 'mymod/1.0.lua' module. To test/use the new module:
 +
* Run the following command or add it to your ~/.bashrc file
 +
module use ~/modules
 +
 
 +
The ''"myapp/1.0"'' module should be available for your use.
  
 
==Support==
 
==Support==

Revision as of 15:35, 31 May 2018


Introduction

Setting and maintaining your environment while running a large number of diverse software applications with different requirements can be a daunting task. The Research Computing is adopting the modules system developed by Robert McLay at the Texas Advanced Computing Center (TACC) in order to ease the complexity of this process and relieve users of this burden.

Basic usage

See Modules Basic Usage for a short practical introduction to using modules.

Personal modules

You can write and use your own modulefiles. The procedure for making them available is very simple. For example, if you'd like to create version 1.0 of the module 'mymod' pick any directory you own, say ~/modules:

  • Create a personal module directory
mkdir ~/modules
  • Add a 'mymod' module directory
mkdir ~/modules/mymod
  • Add a modulefile
touch ~/modules/mymod/1.0.lua

Note that you can copy any environment module we have in /apps/lmod/modulefiles to serve as a starting point for your 'mymod/1.0.lua' module. To test/use the new module:

  • Run the following command or add it to your ~/.bashrc file
module use ~/modules

The "myapp/1.0" module should be available for your use.

Support

To request help with using modules or installation of new module enabled application please file a support request.

Upstream Documentation

Those who would like to learn as much as possible about lmod can use this documentation.

There is a well-written article on Lmod in the HPC Admin Magazine.