UsefulModuleFunctions

Useful functions for writing modules in TCL.

To use:

lappend auto_path <full/path/to/UsefulModuleFunctions/dir>
package require modulefunctions 1.0

and then

modulefunctions::createSymlink $newlink $sourcefile

Functions contained and usage

• createSymlink

Create a symlink, printing out an error if it fails to be created. Checks whether it already exists first and uses the existing one if it does. Example usage:

modulefunctions::createSymlink $newlink $sourcefile

• createDir

Create a directory in user space, including parents - does the equivalent of mkdir -p. Returns with no error if the directory exists, returns with an error if you try to overwrite a directory with a file. Note: does not move any existing user directory of the same name. Outputs "$path is configured" to the user. Example usage:

modulefunctions::createDir $path

• copySource

Copies the source file or directory to user space. Informs the user of what is being created. Informs the user if the copy fails and outputs a reminder that the module must be loaded at least once from a login node. If the file or directory exists, tells the user it is using the existing one.

modulefunctions::copySource $sourcefile $copytarget

• isMember

Check if the user is a member of the specified group. Gives an error if the id command fails. If the user isn't in the group, says "You are not currently a member of the reserved application group for this module. Please email rc-support@ucl.ac.uk requesting access to the software."

modulefunctions::isMember $group

• getCluster

Get the name of the current cluster, assuming it is one we know about.

modulefunctions::getCluster

• isCluster

Check if the name of the current cluster matches the given string. Not case sensitive.

if [modulefunctions::isCluster $name] {
    # do stuff
}

• nodeHasDisks

Check if this node has any disks (strictly, connected mounted block devices).

if [modulefunctions::nodeHasDisks] {
    # do stuff
}

• nodeIsLoginNode

Check if this node is a login node.

if [modulefunctions::nodeIsLoginNode] {
    # do stuff
}

• getTmpdirFreeSpace

Get the amount of available space in KiB in the temporary storage (TMPDIR) filesystem. Defaults to /tmp if TMPDIR is not set.

modulefunctions::getTmpdirFreeSpace

• getDirFreeSpace

Get the amount of available space in KiB in the filesystem of an arbitrary directory.

modulefunctions::getDirFreeSpace $targetDir

• isModuleLoad

Check if the user is loading the module. Otherwise the function will be carried out on module unload as well.

if [modulefunctions::isModuleLoad] {
    # do stuff
}

• isTMPDIR

Check if $TMPDIR exists.

if [modulefunctions::isTMPDIR] {
     # do stuff
}

• isJob

Check if this is a job (whether $NHOSTS exists)

if [modulefunctions::isJob] {
    # do stuff
}

• getArch

Get the architecture of the current node, matching against ones we care about. (avx512, avx2, sse2 at time of writing, otherwise "unknown")

modulefunctions::getArch

• hasArch

Check if the "most important" arch of the current node matches the given string. Not case sensitive.

if [modulefunctions::hasArch "avx512"] {
    # do stuff
}