Difference between revisions of "Modules"

Revision as of 15:45, 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 modulefile we have in /apps/lmod/modulefiles to serve as a starting point for your 'mymod/1.0.lua' modulefile. 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.

@@ Line 1: / Line 1: @@
 [[Category:Software]][[Category:Infrastructure]]
 ==Introduction==
-Creating and maintaining a computing environment for a data analysis pipeline that consists of a large number of heterogenous tools, needs to be run by many users as must provide consistent data analysis results over a long time while frequent software upgrades and underlying operating system environment changes happen is not easy. Fortunately, the major points of this problem can be addressed by the use of an environmental modules system that abstracts the computing environment from the immediate data analysis steps. At the UF HPC we have chosen to implement this system using [http://www.tacc.utexas.edu/tacc-projects/mclay/lmod Lmod] software written by Robert McLay at the Texas Advanced Computing Center [http://www.tacc.utexas.edu/home (TACC)].
+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 [http://www.tacc.utexas.edu/home (TACC)] in order to ease the complexity of this process and relieve users of this burden.
-==Upstream Documentation==
-Those who would like to learn as much as possible about lmod can use the [http://www.tacc.utexas.edu/tacc-projects/mclay/lmod documentation written by the Lmod author].
 ==Basic usage==
-See [[Modules Basic Usage]] for a practical introduction to using environment modules at HPC
+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
-==Transition from mpi-selector==
+Note that you can copy any modulefile we have in /apps/lmod/modulefiles to serve as a starting point for your 'mymod/1.0.lua' modulefile. To test/use the new module:
-With the introduction of modules the ''mpi-selector'' command previously used to query and set the MPI implementation on the HPC cluster has been deprecated. Read [[From mpi-selector to module]] for more information.
+* 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 [http://support.hpc.ufl.edu support request] or if necessary please send us an [mailto:om@hpc.ufl.edu email].
+To request help with using modules or installation of new module enabled application please file a [https://support.rc.ufl.edu support request].
+==Upstream Documentation==
+Those who would like to learn as much as possible about lmod can use this [http://lmod.readthedocs.io/en/latest/ documentation].
+There is a well-written article on Lmod in the [http://www.admin-magazine.com/HPC/Articles/Lmod-Alternative-Environment-Modules?utm_source=ADMIN+Newsletter&utm_campaign=HPC_Update_31_Lmod_Alternative_to_Environment_Modules_2013-01-30 HPC Admin Magazine].