From aa2ebf73c11ecc4496b9e535aab955fcb6ec7d89 Mon Sep 17 00:00:00 2001 From: Premas Date: Fri, 5 Apr 2024 09:51:16 -0500 Subject: [PATCH 1/3] add section module save --- docs/cheaha/software/modules.md | 36 +++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/cheaha/software/modules.md b/docs/cheaha/software/modules.md index 629a84b7..2319d7c3 100644 --- a/docs/cheaha/software/modules.md +++ b/docs/cheaha/software/modules.md @@ -52,6 +52,42 @@ If you want to revert to the default modules, you can use: module reset ``` +## Saving Modules using Collections + +To save time in typing in long list of modules everytime you work on a project, you can save the desired list of modules using module collection. To acheive this first load the desired modules, and save it using a collection name as below, + +```bash +module load module 1 module 2 ... + +module save collection_name +``` + +Here, the `collection_name` can be something relevant to your project and easy to remember. + +To load the desired modules using the saved collection use, + +``` bash +module restore collection_name +``` + +To delete a collection use the below command, + +``` bash +module disable collection_name +``` + +To list the save list of module collection use, + +``` bash +module savelist +``` + + +!!! warning + + Using `module save` command without a collection name saves the desired modules in the name `default` to the location $HOME/.lmod.d/default, and causes issue in launching [Open On Demand (OOD) HPC desktop job](../../cheaha/open_ondemand/hpc_desktop.md). The user gets a VNC error such as, `Unable to contact settings server` and/or `Unable to load a failsafe session`. To address this issue, it is recommended to follow the instructions outlined in the [FAQ entry](https://ask.cyberinfrastructure.org/t/why-do-i-get-an-error-when-launching-an-open-ondemand-hpc-interactive-session/2496). + + ## Best Practice for Loading Modules To reduce unexpected behavior and/or to get rid of Lmod errors, From 36808498bea54403a73823563c224c289ada4b0f Mon Sep 17 00:00:00 2001 From: Premas Date: Mon, 8 Apr 2024 11:07:33 -0500 Subject: [PATCH 2/3] added underscores --- docs/cheaha/software/modules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cheaha/software/modules.md b/docs/cheaha/software/modules.md index 2319d7c3..3d887f3e 100644 --- a/docs/cheaha/software/modules.md +++ b/docs/cheaha/software/modules.md @@ -57,7 +57,7 @@ module reset To save time in typing in long list of modules everytime you work on a project, you can save the desired list of modules using module collection. To acheive this first load the desired modules, and save it using a collection name as below, ```bash -module load module 1 module 2 ... +module load module_1 module_2 ... module save collection_name ``` From 21c6a5532679ece9425d71f6c6295730d1d069a2 Mon Sep 17 00:00:00 2001 From: Premas Date: Mon, 8 Apr 2024 11:15:26 -0500 Subject: [PATCH 3/3] added changes --- docs/cheaha/software/modules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cheaha/software/modules.md b/docs/cheaha/software/modules.md index 3d887f3e..1cd9ebb6 100644 --- a/docs/cheaha/software/modules.md +++ b/docs/cheaha/software/modules.md @@ -54,7 +54,7 @@ module reset ## Saving Modules using Collections -To save time in typing in long list of modules everytime you work on a project, you can save the desired list of modules using module collection. To acheive this first load the desired modules, and save it using a collection name as below, +To save time in typing in long list of modules everytime you work on a project, you can save the desired list of modules using module collection. To acheive this, load the desired modules and save them to a collection using a module collection name, as shown below. ```bash module load module_1 module_2 ...