Kent Milfeld (mailto:milfeld@tacc.utexas.edu include mkmod in subject)
- Read the Doc: https://mkmod.readthedocs.org
- Github: https://github.com/TACC/mkmod
- TACC Homepage: https://www.tacc.utexas.edu/research-development/tacc-projects/mkmod
Automatically creates and installs a basic modulefile for an installed package,
given the package name, version and directory location set by the user in the
NAME, VER, and TOPDIR
environment variables. Other environment variables can be used to customize the
environment and operation of the modulefile for complex environments.
To get access to the mkmod source code clone this repository:
git clone https://github.com/tacc/mkmod
Users can easily install mkmod in their user space. Just get mkmod from the
TACC repo with a git command, set INSTALL_DIR to an install directory and
execute make user. The makefile uses the installed mkmod to create and install
a my_mkmod modulefile.
Setting INSTALL_DIR is optional, default installation is the present working directory.
See the INSTALL text in the mkmod directory for the specifics of the install commands.
Any user-owned build and install directory are fine. Directories build and apps are
used below in this example of installation commands::
$ mkdir $HOME/build $HOME/apps
$ cd $HOME/build
$ git clone https://github.com/tacc/mkmod
$ cd mkmod user
$ export INSTALL_DIR=$HOME/apps
$ make #uses itself to install & create a my_mkmod modulefile
$ module load my_mkmod #do after logout and login,
#to execute startup scriptsFor site installations, it will be necessary to turn off the component of mkmod that installs
module use <dir> in startup scripts; and it will be necessary to specify where the modulefile is to
be installed. Otherwise, every thing is quite similar to how a user would install mkmod::
Get mkmod from the TACC repo with a "git" command.
Set INSTALL_DIR to an install directory.
Set INSTALL_SITE to your site name (e.g. TACC, PSC, NERSC, etc.).
Execute make.
The makefile installs mkmod and uses it to create and install a mkmod modulefile.
When the INSTALL_SITE variable is set, it turns off the insertion
of module use <dir> command in startup scripts, and eliminates appending a prefix
to the modulefile name (by internally setting PREFIX to "").
See the INSTALL text in the mkmod directory for the specifics of the install commands.
The folowing example site installation commands intall mkmod and a mkmod modulefile::
git clone https://github.com/tacc/mkmod
cd mkmod
export INSTALL_DIR=/opt/apps/mkmod
export MODULEFILES_DIR=/opt/apps/modulefiles
export INSTALL_SITE=TACC
make site #uses itself to install and create a mkmod modulefileFeatures: 1 Makefile now requires user or site target on cmd line. 2019_04_12 Also sets MODE env. var. to either user or site.
2 Permission is requested to install module use command 2019_03_29
in startup scripts.
Bug Fixes: 1 Not listed, see git log.
Features: 1 If arguments are not understood, print help and exit. 2018_12_
2 for PATHS (e.g. TOPDIR_PATH_LIST, TOPDIR_LD_LIBRARY_PATH_LIST) 2018_12_20
require a colon (:) separated list (changed from space separated list)
3 PKG_CONFIG_PATH added to list of auto PATH-types 2018_12_23
4 Documentation in reST and put in readthedocs.org 2018_12_25
5 Revised README.md file (now Markdown): Only basic Info 2018_12_16
Bug Fixes: 1 Not listed, see git log.
Features:
1 reset env vars list; all set env vars used by mkmod 2018_06_21
mkmod reset|-r|--reset
mkmod reset unsets any set vars for any shell
2 "module use $HOME/mkmodfiles" insertions now works 2018_06_21
for all these shells: tcsh|csh, bash and zsh.
3 Use STARTUP_FILE_SUFFIX if startups need suffix. 2018_06_24
SITE and SITE_STARTUP_FILE_SUFFIX lists (e.g. NERSC)
provide site suffixes.
4 Pseudo Unit Tests. Allows setting lmod|tmod flavor, 2018_07_07
and site, login shell (bash|tcsh|csh|zsh) for checking
flavors, and startup shells, respectively.
Bug Fixes: 1 Not listed, see git log.
Features: 1 Explicitly defined prereqs support. 2018_01_29 2 TMOD support (by FLAVOR: lmod or tmod ) 2018_02_29 (automatically determined ) 3 WHATIS_FILE support 2018_03_29 4 makefile, to install mkmod and make its module. 2018_03_05 5 New mkmod_utils for env. var substitution. 2018_04_04 6 Remove /tmp temporary files after use. 2018_04_05 7 Use $BASH_SOURCE directory for mkmod_utils. 2018_04_17 "module use" in startup files supported. 8 Startups work for bash, csh,tcsh and zsh shells. 2018_04_18 9 Allow none for WHATIS|HELP_FILE to avoid search. 2018_04_18
Bug Fixes: 1 Not listed, see git log.
(C) 2018 University of Texas at Austin
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.