Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add module cheatsheet + minor tweaks to using-easybuild page #132

Merged
merged 11 commits into from
Apr 21, 2023
21 changes: 21 additions & 0 deletions docs/using-easybuild.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 }

Expand Down Expand Up @@ -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=<param>=<value>`
* only supports string and list-of-strings value types
* example: `--try-amend=sources='["<source_url>"]'`

For example, to build and install BWA and its dependencies with a different toolchain version:

Expand Down Expand Up @@ -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
ocaisa marked this conversation as resolved.
Show resolved Hide resolved