From f7ded72fc034894a8580b1e88b3cf1eec6c3880a Mon Sep 17 00:00:00 2001 From: ocaisa Date: Fri, 4 Feb 2022 11:22:24 +0100 Subject: [PATCH 1/3] Update installation instruction for Lmod --- ...stalling-Lmod-without-root-permissions.rst | 37 +++++++++++++------ 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/docs/Installing-Lmod-without-root-permissions.rst b/docs/Installing-Lmod-without-root-permissions.rst index 66c6562f..e887f569 100644 --- a/docs/Installing-Lmod-without-root-permissions.rst +++ b/docs/Installing-Lmod-without-root-permissions.rst @@ -7,18 +7,25 @@ Installing Lmod without root permissions This short guide will show how to install Lmod (and Lua, on which it depends) on Linux, without requiring root permissions. +For full instructions on installing Lmod and its prerequisites check +the `Lmod documentation`_. + Lua ~~~ -Dependencies: Installing Lua using the steps below requires rsync, make and gcc +Dependencies: Installing Lua using the steps below requires bzip2, rsync, make and gcc Build and install Lua using the source tarball available in the Lmod -SourceForge repository (`http://sourceforge.net/projects/lmod/files/`_). +SourceForge repository (`https://sourceforge.net/projects/lmod/files/`_). This version is a lot easier to build, and already includes the required extra Lua modules. At the time of writing this relates to the -``lua-5.1.4.8.tar.gz`` tarball. +``lua-5.1.4.9.tar.bz2`` tarball. + +**Step 1**: Download and unpack Lua: -**Step 1**: Download and unpack `lua-5.1.4.8.tar.gz`_. +.. code:: bash + wget https://sourceforge.net/projects/lmod/files/lua-5.1.4.9.tar.bz2 + tar xvfj lua-5.1.4.9.tar.bz2 && cd lua-5.1.4.9 **Step 2**: Configure the Lua build, provide a custom installation prefix (e.g. ``$HOME/lua``) and specify to statically link libraries @@ -55,7 +62,8 @@ Lmod Dependencies: building Lmod using the steps below requires tcl, tcl-dev(el), make and bzip2 **Step 1**: Download and unpack the latest available Lmod version, -`Lmod-8.4.tar.bz2`_ at the time of writing. +`Lmod-8.4.tar.bz2`_ at the time of writing, from the `Lmod GitHub releases page +`_. .. code:: bash @@ -67,18 +75,24 @@ Dependencies: building Lmod using the steps below requires tcl, tcl-dev(el), mak ./configure --prefix=$HOME && make install -**Step 3**: Update ``$PATH`` so ``lmod`` is available (put this in your -``.bashrc``): +**Step 3**: Update the ``$LMOD_CMD`` to point to the Lmod executable +(put this in your ``.bashrc``): + +.. code:: bash + export LMOD_CMD=$HOME/lmod/8.4/libexec/lmod + +Note that you can also use the specific version as above but the ``lmod`` +directory symlink allows updates without needing to change this export: .. code:: bash - export PATH=$HOME/lmod/8.4/libexec:$PATH + export LMOD_CMD=$HOME/lmod/lmod/libexec/lmod Optionally, give it a spin: .. code:: bash - $ lmod --version + $ $LMOD_CMD --version Modules based on Lua: Version 8.4 2020-07-31 12:25 -05:00 by Robert McLay mclay@tacc.utexas.edu @@ -89,9 +103,8 @@ with EasyBuild): .. code:: bash source $HOME/lmod/8.4/init/bash - export LMOD_CMD=$HOME/lmod/8.4/libexec/lmod -.. _`http://sourceforge.net/projects/lmod/files/`: http://sourceforge.net/projects/lmod/files/ -.. _lua-5.1.4.8.tar.gz: https://sourceforge.net/projects/lmod/files/lua-5.1.4.8.tar.gz/download +.. _`https://sourceforge.net/projects/lmod/files/`: https://sourceforge.net/projects/lmod/files/ +.. _lua-5.1.4.9.tar.bz2: https://sourceforge.net/projects/lmod/files/lua-5.1.4.9.tar.bz2/download .. _Lmod-8.4.tar.bz2: https://sourceforge.net/projects/lmod/files/Lmod-8.4.tar.bz2/download From ec2a7d20895c7b5058189ce6be21c9cb18cc9a7c Mon Sep 17 00:00:00 2001 From: ocaisa Date: Fri, 4 Feb 2022 11:26:23 +0100 Subject: [PATCH 2/3] Update Installing-Lmod-without-root-permissions.rst --- docs/Installing-Lmod-without-root-permissions.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/Installing-Lmod-without-root-permissions.rst b/docs/Installing-Lmod-without-root-permissions.rst index e887f569..7e7531cd 100644 --- a/docs/Installing-Lmod-without-root-permissions.rst +++ b/docs/Installing-Lmod-without-root-permissions.rst @@ -81,8 +81,9 @@ Dependencies: building Lmod using the steps below requires tcl, tcl-dev(el), mak .. code:: bash export LMOD_CMD=$HOME/lmod/8.4/libexec/lmod -Note that you can also use the specific version as above but the ``lmod`` -directory symlink allows updates without needing to change this export: +Note that you can use the specific version as above but the ``lmod`` +directory symlink allows updates without needing to change this export +(and so is usually preferred): .. code:: bash From 3bf858d500d33dfbfb754f1817709e1e843fe888 Mon Sep 17 00:00:00 2001 From: ocaisa Date: Fri, 4 Feb 2022 11:27:33 +0100 Subject: [PATCH 3/3] Update Installing-Lmod-without-root-permissions.rst --- docs/Installing-Lmod-without-root-permissions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Installing-Lmod-without-root-permissions.rst b/docs/Installing-Lmod-without-root-permissions.rst index 7e7531cd..58888002 100644 --- a/docs/Installing-Lmod-without-root-permissions.rst +++ b/docs/Installing-Lmod-without-root-permissions.rst @@ -103,7 +103,7 @@ with EasyBuild): .. code:: bash - source $HOME/lmod/8.4/init/bash + source $HOME/lmod/lmod/init/bash .. _`https://sourceforge.net/projects/lmod/files/`: https://sourceforge.net/projects/lmod/files/ .. _lua-5.1.4.9.tar.bz2: https://sourceforge.net/projects/lmod/files/lua-5.1.4.9.tar.bz2/download