Environment Modules - Revision history

K Siegmund at 08:29, 15 July 2025

2025-07-15T08:29:04Z

← Older revision		Revision as of 10:29, 15 July 2025
Line 1:		Line 1:


			{\|style="background:#deffee; width:100%;"
			\|style="padding:5px; background:#cef2e0; text-align:left"\|
			[[Image:Info.svg\|center\|25px]]
			\|style="padding:5px; background:#cef2e0; text-align:left"\|
			External software search over all bwHPC clusters on our webpage: https://www.bwhpc.de/software.html
			\|}

	Software on the bwHPC Clusters is provided as '''Software Environment Modules''', or short '''Modules'''.		Software on the bwHPC Clusters is provided as '''Software Environment Modules''', or short '''Modules'''.

K Siegmund: /* Display and search available Modules */

2025-03-25T09:23:51Z

Display and search available Modules

← Older revision		Revision as of 11:23, 25 March 2025
Line 41:		Line 41:
	$ module avail compiler/		$ module avail compiler/
	$ module avail compiler/gnu		$ module avail compiler/gnu

			$ module spider compiler/
			$ module spider compiler/gnu

	</pre>		</pre>

K Siegmund: /* Display and search available Modules */

2025-03-25T09:21:21Z

Display and search available Modules

← Older revision		Revision as of 11:21, 25 March 2025
Line 26:		Line 26:

	== Display and search available Modules ==		== Display and search available Modules ==
	~~Available~~ ''Modules'' are modulefiles that can be loaded by the user. A ''Module'' must be loaded before it provides changes to your environment. You can display ~~all~~ available ''Modules'' on the system by executing:		''Modules'' are modulefiles that can be loaded by the user. A ''Module'' must be loaded before it provides changes to your environment. You can display the currently available ''Modules'' on the system by executing:
	<pre>		<pre>
	$ module avail		$ module avail
			</pre>
			Some modules may be hidden and only become visible when compiler versions/libraries they depend on are loaded.

			A complete list of all available modules can be displayed using:
			<pre>
			$ module spider
	</pre>		</pre>

H Winkhardt at 12:33, 17 January 2025

2025-01-17T12:33:14Z

← Older revision		Revision as of 14:33, 17 January 2025
Line 117:		Line 117:
	=== Loading conflicts ===		=== Loading conflicts ===
	By default you can not load different versions of same software ''Module'' in same session. Loading for example Intel compiler version X while Intel compiler version Y is loaded results in error message as follows:		By default you can not load different versions of same software ''Module'' in same session. Loading for example Intel compiler version X while Intel compiler version Y is loaded results in error message as follows:
			<pre>
	<source lang="bash">
	Module 'compiler/intel/X' conflicts with the currently loaded module(s) 'compiler/intel/Y'		Module 'compiler/intel/X' conflicts with the currently loaded module(s) 'compiler/intel/Y'
	</~~source~~>		</pre>
	The solution is [[#Unloading Modules\|unloading]] or switching ''Modules''.		The solution is [[#Unloading Modules\|unloading]] or switching ''Modules''.

R Keller: /* Module categories, versions and defaults */

2024-11-12T11:42:41Z

Module categories, versions and defaults

← Older revision		Revision as of 13:42, 12 November 2024
Line 17:		Line 17:

	You can load it in the default version just specifying math/julia or a specific version <code> math/julia/1.11.0 </code>		You can load it in the default version just specifying math/julia or a specific version <code> math/julia/1.11.0 </code>
	Please note, that software may be hidden from default view using a dot in front of the version; i.e.		Please note, that software may be '''hidden''' from default view using a dot in front of the version; i.e.
	the software is still available but not visible in <code>module avail</code> but may still be loaded,		the software is still available but not visible in <code>module avail</code> but may still be loaded,
	e.g. <code> math/julia/.1.10.0 </code>.		e.g. <code> math/julia/.1.10.0 </code>.

R Keller: /* Module categories, versions and defaults */

2024-11-12T11:42:07Z

Module categories, versions and defaults

← Older revision		Revision as of 13:42, 12 November 2024
Line 17:		Line 17:

	You can load it in the default version just specifying math/julia or a specific version <code> math/julia/1.11.0 </code>		You can load it in the default version just specifying math/julia or a specific version <code> math/julia/1.11.0 </code>
			Please note, that software may be hidden from default view using a dot in front of the version; i.e.
			the software is still available but not visible in <code>module avail</code> but may still be loaded,
			e.g. <code> math/julia/.1.10.0 </code>.

	Currently all bwHPC software packages are assigned to the following ''Module'' categories:		Currently all bwHPC software packages are assigned to one of the following ''Module'' categories:

	<code> bio cae chem compiler devel lib math mpi numlib phys system vis </code>		<code> bio cae chem compiler devel lib math mpi numlib phys system vis </code>

K Siegmund at 11:20, 5 November 2024

2024-11-05T11:20:01Z

@@ Line 4: / Line 4: @@
 Modules make it possible to have different versions of a software installed at a the same time.
 The complete environments for the software package, compilers and libraries and  needed by this specific version is then loaded by a single command. This happens usually in the beginning of the jobscript.
 = Basic Usage =
 == Module categories, versions  and defaults ==
@@ Line 23: / Line 14: @@
  category/softwarename/version
-e.g. if julia is installed, it is in the module
+e.g. if julia is installed, it is in the module <code>math/julia</code>.
 Currently all bwHPC software packages are assigned to the following ''Module'' categories:
 <code> bio cae chem compiler devel lib math mpi numlib phys system vis </code>
 == Display and search available Modules ==

K Siegmund: /* Module categories, versions and defaults */

2024-11-05T10:47:14Z

Module categories, versions and defaults

← Older revision		Revision as of 12:47, 5 November 2024
Line 22:		Line 22:

	category/softwarename/version		category/softwarename/version
	For instance the Intel compiler X.Y belongs to the category of compilers, therefore the
	modulefile ''X.Y'' is placed under the category ''compiler'' and ''intel''.
	<br>
	In case of multiple software versions, one version will be always defined as the '''default'''
	version. The ''Module'' of the default can be addressed by simply omitting the version number:
	category/softwarename

	e.g. if ~~mathematica~~ is installed, it is in the module		e.g. if julia is installed, it is in the module

			math/julia

			and you can load it in the default version just specifying math/julia or a specific version

			math/julia/1.11.0

	math/mathematica

	Currently all bwHPC software packages are assigned to the following ''Module'' categories:		Currently all bwHPC software packages are assigned to the following ''Module'' categories:

K Siegmund: /* Loading Modules and Check they are loaded */

2024-11-05T09:51:45Z

Loading Modules and Check they are loaded

← Older revision		Revision as of 11:51, 5 November 2024
Line 77:		Line 77:

	== Loading Modules and Check they are loaded ==		== Loading Modules and Check they are loaded ==

			{\|style="background:#deffee; width:100%;"
			\|style="padding:5px; background:#cef2e0; text-align:left"\|
			[[Image:Attention.svg\|center\|25px]]
			\|style="padding:5px; background:#cef2e0; text-align:left"\|
			Don't use module load in .bashrc → see [[.bashrc Do's and Don'ts]]
			\|}

	To load a software ''Module'' and display all loaded modules:		To load a software ''Module'' and display all loaded modules:
	<pre>		<pre>

K Siegmund: /* Loading Modules and Check they are loaded */

2024-10-08T12:57:12Z

Loading Modules and Check they are loaded

← Older revision		Revision as of 14:57, 8 October 2024
Line 88:		Line 88:


	Modules make software available only in your current shell. Whenever you login in, you have to load the software again. Please do not auto-load modules in ~/.bashrc, this can lead to problems with other modules you may load later.		Modules make software available only in your current shell. Whenever you login in, you have to load the software again. Please do not auto-load modules in ~/.bashrc, this can lead to problems with system software or other modules you may load later.

	== Software job examples ==		== Software job examples ==