|
|
\[\[_TOC_\]\]
|
|
|
|
|
|
# The module command
|
|
|
The `module` command allows users to manage the versions of softwares and libraries they want to use. More precisely, it enhances the environment variables corresponding to the tool one wish to use.
|
|
|
|
|
|
The `module help` provides a description of all the module sub-commands.
|
|
|
|
|
|
Some of the most common module commands are:
|
|
|
|
|
|
* `module avail`: list of available softwares and libraries on the cluster
|
|
|
```
|
|
|
root@pyrene-login01 ~ # module avail
|
|
|
|
|
|
----------------------------------------------- /softs/contrib/modules -----------------------------------------------
|
|
|
anaconda/3 clFFT/2.12.2 git/2.19.2 hysop/devel mpfr/4.0.2
|
|
|
boost/1.70.0 cuda/10.0 gmp/6.1.2 llvm-clang/8.0.0 opentelemac/v7p2r1
|
|
|
cgal/4.13.1 fftw/3.3.8 hdf5-mpi/1.10.5 mpc/1.1.0 paraview/5.6.1-mpi
|
|
|
|
|
|
--------------------------------------------------- /softs/modules ---------------------------------------------------
|
|
|
cmake/3.14.4 gaussview/6.0 intel/2019.3 openmpi/3.1.4/gcc/8.3.0
|
|
|
gaussian/g09-d01 gcc/7.3.0 intel/2019.4 python/3
|
|
|
gaussian/g16-b01 gcc/8.3.0 MATLAB/2019a
|
|
|
gaussview/5.0 gcc/9.1.0 openmpi/1.10.7/gcc/4.8.5
|
|
|
```
|
|
|
|
|
|
* `module load gcc/7.3.0`: loads the 7.3.0 version of gcc
|
|
|
* `module list`: lists the currently loaded modules of my session
|
|
|
```
|
|
|
root@pyrene-login01 ~ # module load gcc/7.3.0
|
|
|
root@pyrene-login01 ~ # module list
|
|
|
Currently Loaded Modulefiles:
|
|
|
1) gcc/7.3.0
|
|
|
```
|
|
|
|
|
|
* `module unload gcc/7.3.0`: unloads the 7.3.0 version of gcc
|
|
|
```
|
|
|
root@pyrene-login01 ~ # module unload gcc/7.3.0
|
|
|
root@pyrene-login01 ~ # module list
|
|
|
No Modulefiles Currently Loaded.
|
|
|
```
|
|
|
|
|
|
* `module purge`: unloads all the currently loaded modules of my session
|
|
|
```
|
|
|
root@pyrene-login01 ~ # module load gcc/7.3.0 anaconda/3
|
|
|
root@pyrene-login01 ~ # module list
|
|
|
Currently Loaded Modulefiles:
|
|
|
1) gcc/7.3.0 2) anaconda/3
|
|
|
root@pyrene-login01 ~ # module purge
|
|
|
root@pyrene-login01 ~ # module list
|
|
|
No Modulefiles Currently Loaded.
|
|
|
```
|
|
|
* `module whatis gcc/7.3.0` and `module show gcc/7.3.0`: displays information on the gcc/7.3.0 module
|
|
|
```
|
|
|
root@pyrene-login01 ~ # module whatis gcc/7.3.0
|
|
|
gcc/7.3.0 : adds GNU Cross Compilers to your environment variables
|
|
|
|
|
|
root@pyrene-login01 ~ # module show gcc/7.3.0
|
|
|
-------------------------------------------------------------------
|
|
|
/softs/modules/gcc/7.3.0:
|
|
|
|
|
|
module-whatis adds GNU Cross Compilers to your environment variables
|
|
|
prepend-path PATH /softs/apps/gcc/7.3.0/bin
|
|
|
prepend-path LD_LIBRARY_PATH /softs/apps/gcc/7.3.0/lib:/softs/apps/gcc/7.3.0/lib64
|
|
|
prepend-path MANPATH /softs/apps/gcc/7.3.0/share/man
|
|
|
prepend-path INFOPATH /softs/apps/gcc/7.3.0/share/info
|
|
|
-------------------------------------------------------------------
|
|
|
```
|
|
|
|
|
|
# Regular modules
|
|
|
Modules installed by the cluster administrators are located in the /softs/modules directory. The corresponding applications are located in the /softs/apps directory.
|
|
|
|
|
|
|
|
|
# "Contrib" modules
|
|
|
Some softwares and their associated modules can be installed by users in the /softs/contrib directory:
|
|
|
* The software of version x.y.z must be installed in the directory /softs/contrib/apps/softwareName/x.y.z
|
|
|
* The corresponding module file must be named /softs/contrib/modules/softwareName/x.y.z |
|
|
\ No newline at end of file |