Skip to content

Commit 7cf74ef

Browse files
authored
Merge pull request #264 from xdelaruelle/update_tmod_install_doc
Update Environment Modules installation doc
2 parents 0a53da9 + ac99513 commit 7cf74ef

2 files changed

+26
-30
lines changed

docs/installation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -369,13 +369,13 @@ Supported module tools:
369369

370370
Additional notes:
371371

372-
* Tcl(/C) environment-modules requires [Tcl](https://www.tcl.tk/) to be
372+
* Tcl(/C) environment-modules requires [Tcl](https://www.tcl-lang.org/) to be
373373
installed (with header files and development libraries)
374374
* Lmod requires [Lua](https://www.lua.org/) and a couple of non-standard Lua libraries
375375
(`lua-posix`, `lua-filesystem`) to be available
376376
* Tcl (`tclsh`) must also be available for Lmod to support module files in `Tcl` syntax
377377
* a guide to installing Tcl/C environment modules without having root
378-
permissions is available at [Installing environment modules without root permissions][installing_env_mod_c].
378+
permissions is available at [Installing environment modules without root permissions][installing_env_mod].
379379
* a guide to installing Lmod without having root permissions is available at
380380
[Installing Lmod without root permissions][installing_lmod].
381381

docs/installing-environment-modules-without-root-permissions.md

+24-28
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,22 @@
1-
# Installing environment modules without root permissions {: #installing_env_mod_c }
1+
# Installing Environment Modules without root permissions {: #installing_env_mod }
22

3-
This short guide will explain how to install the standard environment
4-
modules Tcl/C software package without root permissions on a Linux or
3+
This short guide will explain how to install the standard Environment
4+
Modules software package without root permissions on a Linux or
55
Mac OS X system, together with Tcl on which it depends.
66

77
## Tcl
88

9-
1. Go to <https://www.tcl.tk> and download the latest Tcl sources. At
10-
the time of writing, the latest available Tcl version was 8.5.15,
9+
1. Go to <https://www.tcl-lang.org> and download the latest Tcl sources. At
10+
the time of writing, the latest available Tcl version was 8.6.14,
1111
which can be downloaded from
12-
[here](https://prdownloads.sourceforge.net/tcl/tcl8.5.15-src.tar.gz).
13-
The remainder of these commands will assume Tcl v8.5.15 is being
14-
installed, you may need to adjust them accordingly. **Note**: Stick
15-
to Tcl v8.5.x, don't consider using the more recent v8.6.x or
16-
higher, since the environment modules package is not compatible with
17-
those Tcl versions.
12+
[here](https://prdownloads.sourceforge.net/tcl/tcl8.6.14-src.tar.gz).
13+
The remainder of these commands will assume Tcl v8.6.14 is being
14+
installed, you may need to adjust them accordingly.
1815

1916
1. Unpack the Tcl source tarball:
2017

2118
``` shell
22-
tar xfvz tcl8.5.15-src.tar.gz
19+
tar xfvz tcl8.6.14-src.tar.gz
2320
```
2421

2522
1. Pick a location where you will install Tcl. It should be a directory
@@ -30,12 +27,12 @@ Mac OS X system, together with Tcl on which it depends.
3027
the `configure` script using the `--prefix` option:
3128

3229
``` shell
33-
cd tcl8.5.15/unix
30+
cd tcl8.6.14/unix
3431
./configure --prefix=$HOME/.local/Tcl
3532
```
3633

37-
If you're building Tcl and environment modules on Mac, you should
38-
run `configure` in the `tcl8.5.15/macosx` directory instead.
34+
If you're building Tcl and Environment Modules on Mac, you should
35+
run `configure` in the `tcl8.6.14/macosx` directory instead.
3936
4037
1. Next, build Tcl using the `make` command. If the system you are
4138
building on has multiple cores, running make in parallel will speed
@@ -54,38 +51,37 @@ Mac OS X system, together with Tcl on which it depends.
5451
make install
5552
```
5653
57-
**All done!** Now you are ready to build the environment modules
54+
**All done!** Now you are ready to build the Environment Modules
5855
package, which requires Tcl.
5956
6057
## Environment Modules
6158
62-
1. Download the latest source tarball for the environment modules tools
59+
1. Download the latest source tarball for the Environment Modules tools
6360
from <https://modules.sourceforge.net>. At the time of writing, the
64-
latest available version is 3.2.10 which can be downloaded [from
65-
here](https://prdownloads.sourceforge.net/modules/modules-3.2.10.tar.gz).
61+
latest available version is 5.4.0 which can be downloaded [from
62+
here](https://prdownloads.sourceforge.net/modules/modules-5.4.0.tar.gz).
6663
6764
1. Unpack the downloaded source tarball:
6865
6966
``` shell
70-
tar xfvz modules-3.2.10.tar.gz
67+
tar xfvz modules-5.4.0.tar.gz
7168
```
7269
7370
1. Configure the build, again use `--prefix` to specify where to
74-
install the environment modules tool in the end. If you needed to
71+
install the Environment Modules tool in the end. If you needed to
7572
install Tcl by hand as outlined in the previous section, you'll also
7673
need to specify where it was installed using the `--with-tcl`
7774
option:
7875

7976
``` shell
80-
cd modules-3.2.10
77+
cd modules-5.4.0
8178
./configure --prefix=$HOME/.local/environment-modules --with-tcl=$HOME/.local/Tcl/lib
8279
```
8380

84-
1. Build with `make`, consider parallel build if your system is recent
85-
enough:
81+
1. Build with `make`:
8682

8783
``` shell
88-
make -j 4
84+
make
8985
```
9086

9187
1. Install:
@@ -98,17 +94,17 @@ Alright, now just one more thing...
9894

9995
## Set up your environment
10096

101-
Because you've installed environment modules and Tcl in a non-default
97+
Because you've installed Environment Modules and Tcl in a non-default
10298
location, you need to make sure your environment is setup up correctly
10399
to use them.
104100
105101
To make a long story short, these are the commands you need to execute:
106102
107103
``` shell
108-
export PATH=$HOME/.local/environment-modules/Modules/3.2.10/bin:$PATH
104+
export PATH=$HOME/.local/environment-modules/bin:$PATH
109105
export LD_LIBRARY_PATH=$HOME/.local/Tcl/lib:$LD_LIBRARY_PATH
110106
# adjust line below if you're using a shell other than bash, check with 'echo $SHELL'
111-
source $HOME/.local/environment-modules/Modules/3.2.10/init/bash
107+
source $HOME/.local/environment-modules/init/bash
112108
```
113109

114110
!!! tip

0 commit comments

Comments
 (0)