Utiliser des modules/en: Difference between revisions

{{Command|module help}}

== Sub-command <code>spider</code> (Lmod only) ==

The <code>spider</code> sub-command searches the complete tree of all modules and displays it.

{{Command|module spider}}

If you specify the name of an application, for example with

this will show you a list of all available versions of the application.  

If you specify the name of the application along with a version number, for example with

{{Command|module spider openmpi/1.8.4}}

this will display a list of the modules you must load in order to access this version.

== Sub-command <code>avail</code> ==

{{Command|module list}}

== Sub-command <code>load</code> ==

The sub-command <code>load</code> lets you load a given module. For example,

{{Command|module load gcc/4.8}}

You can load more than one module with a single command. For example,

{{Command|module load gcc/4.8 mpi/openmpi/1.8.4}}

== Sub-command <code>unload</code> ==

After the <code>load</code> sub-command, <code>unload</code> removes a module from your environment. For example,

{{Command|module unload gcc/4.8}}

If you have other modules loaded that depend on this compiler, Lmod will tell you that they have been disabled.

Some modules may be marked "sticky" (permanent) by system administrators. These will not be unloaded.

== Sub-commands <code>show, help</code> and <code>whatis</code> ==

The sub-commands <code>show, help</code> and <code>whatis</code> provide additional information about a given module. The <code>show</code> sub-command displays the entire module, <code>help</code> displays a help message, and <code>whatis</code> shows a description of the module.

== Sub-command <code>apropos</code> or <code>keyword</code> ==

'''We advise against loading modules automatically in your .bashrc.''' Instead we recommend that you load modules only when required, for example in your job scripts. To facilitate the repeated loading of a large number of modules we recommend you use a module collection.  

= Module collections (Lmod only) =

Lmod allows you to create a collection of modules. To do so, first load the desired modules. For example:

{{Command|module load gcc/4.8 openmpi/1.8 mkl}}

Then use the <code>save</code> sub-command to save this collection:

Some modules are hidden. You may ignore them. They are typically modules that you don't have to load manually. They are loaded automatically based on other modules.  

== Module hierarchy ==

Most systems use a flat module structure: All modules are at the same level. This becomes problematic when many combinations of versions of different modules are available on a system. For example, if you need to use the [[FFTW]] library and the module <code>fftw</code> is available in several versions, including a version compiled with GCC 4.8 and Open MPI 1.6, you might see modules named <code>openmpi/1.6_gcc4.8</code> and <code>fftw/3.3_gcc4.8_openmpi1.6</code>. This is neither elegant nor practical. To solve this problem we use a hierarchy of modules. Rather than using the command

you instead use

{{Command|module load gcc/4.8 openmpi/1.6 fftw/3.3}}

The inconvenience of using a module hierarchy is that, since modules can have the same name, only the modules that are compatible with the "parent" modules are displayed by the <code>module avail</code> command. Loading a parent module is therefore a prerequisite to loading some modules. To get complete information, Lmod provides the <code>module spider</code> command. It scans the entire hierarchy and displays all the modules. By specifying a module and a particular version, it is then possible to see which paths in the hierarchy enable the desired module to be loaded.

== Automatic replacement of modules ==

= Creating modules =