diff --git a/docs/using-easybuild.md b/docs/using-easybuild.md index 66322ff40..11bc03f47 100644 --- a/docs/using-easybuild.md +++ b/docs/using-easybuild.md @@ -91,6 +91,10 @@ This is a crucial design aspect, since the dependency resolution mechanism (see in order to redefine the build/install/source path prefix to be used; default value is: `$HOME/.local/easybuild`; see [Configuration][configuring_easybuild] +!!! note + + If you are not familiar with modules (`module` command), see [Overview of basic module commands][module_cmds_overview] + ### Via command line options {: #specifying_easyconfigs_command_line } @@ -721,6 +725,7 @@ a matching `--try-X` command line options is available: * `--try-amend` to try tweaking a different easyconfig parameter * format: `--try-amend==` * only supports string and list-of-strings value types + * example: `--try-amend=sources='[""]'` For example, to build and install BWA and its dependencies with a different toolchain version: @@ -752,3 +757,19 @@ Dry run: printing build status of easyconfigs and dependencies Modifying the software version does **not** trickle down the entire software stack, even when combined with `--robot`, since a software version is tied to a particular software package. + +## Overview of basic module commands {: #module_cmds_overview } + +In case you are not familiar with using modules, here is a simple cheatsheet of most common module commands used in combination with Easybuild: + +*`module avail`* - list the modules that are currently available to load + +*`module load foss/2022a`* - load the module `foss/2022a` + +*`module list`* - list currently loaded modules + +*`module show foss/2022a`* - see contents of the module `foss/2022a` (shows the module functions instead of executing them) + +*`module unload foss/2022a`* - unload the module `foss/2022a` + +*`module purge`* - unload all currently loaded modules