42 ,ˆl–Ým_J¥4Ò‚™P.Ü 7ò˜´oÊ „m÷ž_‡I|¥ŠèªÀÈ?÷Installing Modules on Unix ************************** This document is an overview of building and installing Modules on a Unix system. Requirements ============ Modules consists of one Tcl script so to run it from a user shell the only requirement is to have a working version of "tclsh" (version 8.5 or later) available on your system. "tclsh" is a part of Tcl (http://www.tcl-lang.org/software/tcltk/). To install Modules from a distribution tarball or a clone of the git repository, a build step is there to tailor the "modulecmd.tcl" and the initialization scripts to the chosen installation configuration and create the documentation files. This build step requires the tools to be found on your system: * bash * make * sed * runtest When also installing Modules Tcl extension library (enabled by default), these additional tools are needed: * grep * gcc * tcl-devel >= 8.5 When installing from a distribution tarball, documentation is pre- built and scripts to configure Modules Tcl extension library build are already generated. Thus no additional software is required. When installing from a clone of the git repository or from a git archive export, documentation and scripts to prepare for compilation have to be built and the following tools are required: * autoconf * automake * autopoint * python * sphinx >= 1.0 Get Modules =========== Modules can usually be installed with the package manager of your Unix system. It it is available by default on most Linux distributions, on OS X and FreeBSD either under the name of "modules" or "environment- modules". If you want to install Modules from sources, tarballs from all Modules' releases can be retrieved from one of the following link: * https://github.com/cea-hpc/modules/releases/ * https://sourceforge.net/projects/modules/files/Modules/ For instance to download then unpack the last release of Modules: $ curl -LJO https://github.com/cea-hpc/modules/releases/download/v5.3.0/modules-5.3.0.tar.gz $ tar xfz modules-5.3.0.tar.gz Installation instructions ========================= The simplest way to build and install Modules is: $ ./configure $ make $ make install Some explanation, step by step: 1. "cd" to the directory containing the package's source code. Your system must have the above requirements installed to properly build scripts, and documentation if build occurs from a clone of the git repository. 2. Type "./configure" to 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) 3. Type "make" to adapt scripts to the configuration, build Tcl extension library if enabled and build documentation if working from git repository. 4. Optionally, type "make test" to run the test suite. 5. Type "make install" to install modulecmd.tcl, initialization scripts and documentation. 6. Optionally, type "make testinstall" to run the installation test suite. 7. You can remove the built files from the source code directory by typing "make clean". To also remove the files that "configure" created, type "make distclean". A default installation process like described above will install Modules under "/usr/local/Modules". You can change this with the "-- prefix" option. By default, "/usr/local/Modules/modulefiles" will be setup as the default directory containing modulefiles. "-- modulefilesdir" option 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 "./configure" option available. Note: GNU Make is excepted to be used for this build and installation process. On non-Linux systems, the "gmake" should be called instead of "make". Configuration ============= Once installed you sho