mkmod: Makes modulefile for Installed Software Package¶
PURPOSE¶
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.
OVERVIEW¶
The mkmod utility was designed to allow users, who install their own package,
to automatically create and install a basic modulefile for their installed package.
Requirements are: Tcl/Lua Environment Module System (EMS).
If mkmod is not available on the system, installation in user-space is simple,
requiring only a make execution.
A basic modulefile is automatically generated for an installed package
from appropriate values set in the NAME, VER and TOPDIR environment variables.
Mkmod has advanced features, accessible by setting other environment variables--
to accommodate the more sophisticated needs of some package environments.
Mkmod installs the generated modulefile in a modulefiles directory. It includes the
module use $HOME/modulefiles command in appropriate startup files, directing
EMS to be aware of the mkmod-installed modulefiles.
Other capabilities are available for developers who want to provide a modulefile for automatic installation, or at least provide help and whatis components of a modulefile for users and site managers to include in their modulefile installation.
Guide for HPC Users¶
The easiest way to get started is to follow one of the use cases, using,
for practice, a package that is already installed. For cleanup, just
remove the modulefile from your modulefiles directory.
Advanced Features¶
Installation¶
To Be Included Later¶
- Overview of mkmod code
- Logic Flow in mkmod code
- PKGCONFIG_LIST