Installing Modules on Unix¶
This document is an overview of building and installing Modules on a Unix system.
Modules consists of one Tcl script so to run it from a user shell the
only requirement is to have a working version of
8.4 or later) available on your system.
tclsh is a part of Tcl
To install Modules from a distribution tarball or a clone of the git repository, a build step is there to adapt the initialization scripts to your configuration and create the documentation files. This build step requires the tools to be found on your system:
When also installing the bundled compatibility version of Modules (enabled by default), these additional tools are needed:
- tcl-devel >= 8.4
When installing from a distribution tarball, documentation is pre-built and does not require additional software. When installing from a clone of the git repository, document has to be built and the following tools are required:
- sphinx >= 1.0
The simplest way to build and install Modules is:
$ ./configure $ make $ make install
Some explanation, step by step:
cdto the directory containing the package’s source code. Your system must have the above requirements installed to properly build scripts, compatibility version of Modules if enabled, and documentation if build occurs from a clone of the git repository.
./configureto adapt the installation for your system. At this step you can choose the installation paths and the features you want to enable in the initialization scripts (see Build and installation options section below for a complete overview of the available options)
maketo adapt scripts to the configuration, build compatibility version if enabled and build documentation if working from git repository.
- Optionally, type
make testto run the test suite.
make installto install modulecmd.tcl, initialization scripts, compatibility version if built and documentation.
- Optionally, type
make testinstallto run the installation test suite.
- You can remove the built files from the source code directory by typing
make clean. To also remove the files that
A default installation process like described above will install Modules
/usr/local/Modules. You can change this with the
option. By default,
/usr/local/Modules/modulefiles will be setup as
the default directory containing modulefiles.
enables to change this directory location. For example:
$ ./configure --prefix=/usr/share/Modules \ --modulefilesdir=/etc/modulefiles
See Build and installation options section to discover all
Once installed you should review and adapt the configuration to make it fit your needs. The following steps are provided for example. They are not necessarily mandatory as it depends of the kind of setup you want to achieve.
Tune the initialization scripts. Review of these scripts is highly encouraged as you may add or adapt specific stuff to get Modules initialized the way you want.
Enable Modules initialization at shell startup. An easy way to get module function defined and its associated configuration setup at shell startup is to make the initialization scripts part of the system-wide environment setup in
/etc/profile.d. To do so, make a link in this directory to the profile scripts that can be found in your Modules installation init directory:
$ ln -s PREFIX/init/profile.sh /etc/profile.d/modules.sh $ ln -s PREFIX/init/profile.csh /etc/profile.d/modules.csh
These profile scripts will automatically adapt to the kind of
cshshell you are running.
Another approach may be to get the Modules initialization script sourced from the shell configuration startup file. For instance following line could be added to the end of the
~/.bashrcfile if running Bash shell:
Beware that shells have multiple ways to initialize depending if they are a login shell or not and if they are launched in interactive mode or not.
Define module paths to enable by default. Edit
modulercconfiguration file or
.modulespathif you have chosen
--enable-dotmodulespathat configure time. Add there all the modulefile directories you want to activate by default at Modules initialization time.
If you use
.modulespathconfiguration file, add one line mentioning each modulefile directory:
If you use
modulercconfiguration file, add one line mentioning each modulefile directory prefixed by the
module use /path/to/regular/modulefiles module use /path/to/other/modulefiles
Define modulefiles to load by default. Edit
modulercconfiguration file (modulefiles to load cannot be specified in
.modulespathfile). Add there all the modulefiles you want to load by default at Modules initialization time.
Add one line mentioning each modulefile to load prefixed by the
module load foo module load bar
In fact you can add to the
modulercconfiguration file any kind of supported module command.
If you go through the above steps you should have a valid setup tuned to your
needs. After that you still have to write modulefiles to get something to
load and unload in your newly configured Modules setup. Please have a look
doc/example.txt that explains how the user environment is setup
with Modules at the University of Minnesota computer science department.
Build and installation options¶
Options available at the
./configure installation step are described
below. These options enable to choose the installation paths and the
features to enable or disable. You can also get a description of these
options by typing
Fine tuning of the installation directories (the default value for each option is displayed within brakets):
|Installation root directory [|
|--bindir=DIR||Directory for executables reachable by users
|Directory for executables called by other executables
like modulecmd.tcl [|
|--etcdir=DIR||Directory for the executable configuration scripts
|--initdir=DIR||Directory for the per-shell environment initialization
|Base directory to set the man and doc directories
|--mandir=DIR||Directory to host man pages [|
|--docdir=DIR||Directory to host documentation other than man
pages like README, license file, etc
|Directory or main modulefiles also called system
Optional Features (the default for each option is displayed within
parenthesis, to disable an option replace
|Prepend man page directory defined by the |
|Prepend binary directory defined by the |
|Set the module paths defined by |
|Install the documentation files in the documentation
directory defined with the |
|Install some modulefiles provided as example in the
system modulefiles directory defined with the
|Build and install the Modules compatibility (C) version
in addition to the main released version. This feature
also enables switching capabilities from initialization
script between the two installed version of Modules (by
setting-up the |
|Append Modules version to installation prefix and deploy
Optional Packages (the default for each option is displayed within
parenthesis, to disable an option replace
|Name or full path of Tcl interpreter shell
|Name or full path of default pager program to use to
paginate informational message output (can be superseded
at run-time by environment variable)
|Settings to apply to default pager program
|Default path list to setup as the default modulepaths.
Each path in this list should be separated by |
|Default modulefiles to load at Modules initialization
time. Each modulefile in this list should be separated
|Environment variables to put in quarantine when running the module command to ensure it a sane execution environment (each variable should be separated by space character). A value can eventually be set to a quarantine variable instead of emptying it. (default=no)|