Bright:Modules Enviroment - Revision history

K mouza: /* Default environment */

2014-11-06T17:33:16Z

Default environment

K mouza: /* Meta Modules */

2014-10-30T10:03:43Z

Meta Modules

K mouza at 09:56, 30 October 2014

2014-10-30T09:56:06Z

K mouza: /* Creating a New Module */

2014-10-30T09:53:06Z

Creating a New Module

K mouza: /* Creating a New Module */

2014-10-29T17:49:17Z

Creating a New Module

K mouza: /* Meta Modules */

2014-10-29T17:48:19Z

Meta Modules

K mouza: /* Default environment */

2014-10-29T17:40:52Z

Default environment

K mouza: /* Default environment */

2014-10-29T17:33:24Z

Default environment

K mouza: /* Default environment */

2014-10-29T17:05:53Z

Default environment

K mouza: /* Auto Loading Modules */

2014-10-29T17:03:11Z

Auto Loading Modules

@@ Line 62: / Line 62: @@
 <syntaxhighlight>
-module initadd <module name> #Automatically load the desired modules, on boot:
+module initadd <module name> #Automatically load the desired modules, on boot
-module initrm <module name> #Remove a module from the initial state:
+module initrm <module name> #Remove a module from the initial state
-module initlist #List all modules loaded initially:
+module initlist #List all modules loaded initially
-module initclear #Clear all modules from the default initial state:
+module initclear #Clear all modules from the default initial state
 </syntaxhighlight>
@@ Line 74: / Line 74: @@
 #Appending <tt>module load</tt> commands in the <tt>/etc/profile.d/userdefaultmodules.sh</tt> file,
-#Set the desired modules to be loaded in the <tt>default-environment</tt> modulefile (located in <tt>/cm/shared/modulefiles/</tt>) and then load the <tt>default-environment</tt> module in the <tt>userdefaultmodules.sh</tt> file.
+#Setting the desired modules to be loaded in the <tt>default-environment</tt> modulefile (located in <tt>/cm/shared/modulefiles/</tt>) and then load the <tt>default-environment</tt> module in the <tt>userdefaultmodules.sh</tt> file.
 == Creating a New Module ==

← Older revision		Revision as of 10:03, 30 October 2014
Line 127:		Line 127:

	The administrator and users have the flexibility of deciding the modules that should be loaded in undecided cases via module dependencies. Dependencies can be defined using the <tt>prereq</tt> and <tt>conflict</tt> commands.		The administrator and users have the flexibility of deciding the modules that should be loaded in undecided cases via module dependencies. Dependencies can be defined using the <tt>prereq</tt> and <tt>conflict</tt> commands.
		+
		+	*The <tt>prereq</tt> command lists modulefiles which must have been previously loaded before the current modulefile will be loaded. If an argument for <tt>prereq</tt> is a directory and any modulefile from the directory has been loaded, then the prerequisite is met.
		+	*Similarly, the <tt>conflict</tt> command lists modulefiles which conflict with the current modulefile. If an argument for <tt>conflict</tt> is a directory and any other modulefile from that directory has been loaded, then a conflict will occur.
		+
	The man page for <tt>modulefile</tt> gives details on configuring the loading of modules with these commands.		The man page for <tt>modulefile</tt> gives details on configuring the loading of modules with these commands.

@@ Line 75: / Line 75: @@
 #Appending <tt>module load</tt> commands in the <tt>/etc/profile.d/userdefaultmodules.sh</tt> file,
 #Set the desired modules to be loaded in the <tt>default-environment</tt> modulefile (located in <tt>/cm/shared/modulefiles/</tt>) and then load the <tt>default-environment</tt> module in the <tt>userdefaultmodules.sh</tt> file.
 == Creating a New Module ==
@@ Line 128: / Line 121: @@
 </syntaxhighlight>

← Older revision		Revision as of 09:53, 30 October 2014
Line 88:		Line 88:

	Cluster administrators can use the existing modules files as a guide to creating and installing their own modules for module environments, and can copy and modify a file for their own software if there is no environment provided for it already by Bright Cluster Manager.		Cluster administrators can use the existing modules files as a guide to creating and installing their own modules for module environments, and can copy and modify a file for their own software if there is no environment provided for it already by Bright Cluster Manager.
		+
		+	To create a new module:
		+
		+	<syntaxhighlight>
		+	cd /cm/shared/modulefiles # go to the modulefiles directory
		+
		+	mkdir new-module # create a new folder that will contain the module. Folders help keeping modules organised
		+
		+	vim module-name-version # create the actual module
		+	</syntaxhighlight>
		+
		+	For example, the following code sample creates and loads a new module, which enables the GCC compiler:
		+
		+	<syntaxhighlight>
		+	cd /cm/shared/modulefiles
		+	mkdir gcc
		+	vim 4.8.2
		+	module load gcc/4.8.2
		+	</syntaxhighlight>
		+
		+	Tha actual <tt>gcc/4.8.2</tt> module would be the following:
		+
		+	<syntaxhighlight>
		+
		+	#%Module -- tcl --
		+	##
		+	## modulefile
		+	##
		+	proc ModulesHelp { } {
		+
		+	puts stderr "\tAdds GNU Cross Compilers to your environment variables,"
		+	}
		+
		+	module-whatis "adds GNU Cross Compilers to your environment variables"
		+
		+	set root /cm/shared/apps/gcc/4.8.2
		+	prepend-path PATH $root/bin
		+	prepend-path LD_LIBRARY_PATH $root/lib:$root/lib64
		+
		+	</syntaxhighlight>

@@ Line 85: / Line 85: @@
 == Creating a New Module ==
-All module files are located in the /cm/local/modulefiles and /cm/shared/modulefiles trees. A module file is a TCL script in which special commands are used to define functionality. The modulefile(1) man page has more on this.
+All module files are located in the <tt>/cm/local/modulefiles</tt> and <tt>/cm/shared/modulefiles</tt> trees. A module file is a TCL script in which special commands are used to define functionality. The <tt>modulefile(1)</tt> man page has more on this.
 Cluster administrators can use the existing modules files as a guide to creating and installing their own modules for module environments, and can copy and modify a file for their own software if there is no environment provided for it already by Bright Cluster Manager.

@@ Line 78: / Line 78: @@
 === Meta Modules ===
-Modules can be combined in meta-modules. By default, the default-environment meta-module exists, which allows the loading of several modules at once by a user. Cluster administrators are encouraged to customize the default-environment metamodule to set up a recommended environment for their users. The default-environment meta-module is empty by default.
+Modules can be combined in meta-modules. By default, the <tt>default-environment</tt> meta-module exists, which allows the loading of several modules at once by a user. Cluster administrators are encouraged to customize the default-environment meta-module to set up a recommended environment for their users. The <tt>default-environment</tt> meta-module is empty by default.
-The administrator and users have the flexibility of deciding the modules that should be loaded in undecided cases via module dependencies. Dependencies can be defined using the prereq and conflict commands.
+The administrator and users have the flexibility of deciding the modules that should be loaded in undecided cases via module dependencies. Dependencies can be defined using the <tt>prereq</tt> and <tt>conflict</tt> commands.
-The man page for modulefile gives details on configuring the loading of modules with these commands.
+The man page for <tt>modulefile</tt> gives details on configuring the loading of modules with these commands.
 == Creating a New Module ==

@@ Line 57: / Line 57: @@
 </syntaxhighlight>
-=== Auto Loading Modules ===
+=== Default environment ===
-To automatically load the desired modules on boot
+The initial state of modules in the user environment can be set as a default using the <tt>module init*</tt> subcommands.
 <syntaxhighlight>