Update Documentation authored by Lech Nieroda's avatar Lech Nieroda
......@@ -300,34 +300,6 @@ Basic commands are:
```
For more details on the environment module system, see the section
Ramses offers a wide range of development software (compilers, libraries, debuggers, profilers, etc.) and scientific applications. Many of these programs require to set or change environment variables to work properly, e.g. `PATH`, `LD_LIBRARY_PATH`, or `MANPATH`. Ramses uses the [Environment Modules](http://modules.sourceforge.net) package to take care of these modifications and to access, or switch between, various applications and software versions. The Environment Modules package provides the means to change the environment dynamically by loading, switching, or unloading specific software modules. Module installation is managed by the python framework [EasyBuild](https://easybuild.io/) to automatically resolve software dependencies.
You can select the module(s) you need directly on the command line or in your scripts/jobscripts.
### Overview of important module commands
| Command | Function |
|--------------------------------|----------------------------|
| `module avail` | Show all available modules |
| `module whatis <module>` | Show a short description of all or a specific module |
| `module display/show <module>` | Show environment changes caused by loading the module |
| `module add/load <module>` | Load module `<module>`: sets all necessary variables and loads additional modules if required |
| `module list` | Show all currently loaded modules |
| `module rm/unload <module>` | Remove module `<module>`: removes module-specific environment settings and dependent modules|
| `module purge` | Remove all currently loaded modules |
### Usage notes
A module can be identified either by its name or by a combination of name and version, for example `intel` or `intel/19.0`, respectively. When only a module name is specified, its default version is loaded - as shown by the command `module avail`.
- Loading a module changes the environment of the shell in which it is loaded
- If already loaded modules are in conflict with a module to add, an according error message is displayed and no further changes are made
- If additional modules are required by the module to load, these are loaded recursively and an according message is displayed
- Removing a module reverts the changes in the environment of the shell
- If other modules depend on the module to remove, these are removed recursively and an according message is displayed
## Getting help
#### HPC support
......
......