text
stringlengths
1
93.6k
def add(modulefile, flags=''):
"""Load modulefile(s) into the shell environment."""
return module('load {0} {1}'.format(modulefile, flags))
def unload(modulefile, flags=''):
"""Remove modulefile(s) from the shell environment."""
return module('unload {0} {1}'.format(modulefile, flags))
def rm(modulefile, flags=''):
"""Remove modulefile(s) from the shell environment."""
return module('unload {0} {1}'.format(modulefile, flags))
def swap(modulefile1, modulefile2):
"""
Switch loaded modulefile1 with modulefile2. If modulefile1
is not specified, then it is assumed to be the currently
loaded module with the same root name as modulefile2.
return module('swap {0} {1}'.format(modulefile1, modulefile2))
"""
return module('swap {0} {1}'.format(modulefile1, modulefile2))
def switch(modulefile1, modulefile2):
"""
Switch loaded modulefile1 with modulefile2. If modulefile1
is not specified, then it is assumed to be the currently
loaded module with the same root name as modulefile2.
return module('swap {0} {1}'.format(modulefile1, modulefile2))
"""
return module('swap {0} {1}'.format(modulefile1, modulefile2))
def show(modulefile, flags=''):
"""
Display information about one or more modulefiles. The
display sub-command will list the full path of the modulefile(s) and
all (or most) of the environment changes the modulefile(s)
will make if loaded. (It will not display any environment changes
found within conditional statements.)
"""
return module('show {0} {1}'.format(modulefile, flags))
def display(modulefile, flags=''):
"""
Display information about one or more modulefiles. The
display sub-command will list the full path of the modulefile(s) and
all (or most) of the environment changes the modulefile(s)
will make if loaded. (It will not display any environment changes
found within conditional statements.)
"""
return module('show {0} {1}'.format(modulefile, flags))
def ls(flags='-t'):
"""List loaded modules."""
return module('list {0}'.format(flags))
def avail(path, flags=''):
"""
List all available modulefiles in the current
MODULEPATH, where the sorting order is given by
the LC_COLLATE locale environment variable.
All directories in the MODULEPATH are recursively
searched for files containing the modulefile
magic cookie.
If an argument is given, then each directory in
the MODULEPATH is searched for modulefiles whose
pathname match the argument.
Multiple versions of an application can be
supported by creating a subdirectory for the
application containing modulefiles for each
version.
"""
return module('avail {0} {1}'.format(path, flags))
def use(directory, flags=''):
"""
Prepend one or more directories to the MODULEPATH
environment variable. The --append flag will
append the directory to MODULEPATH.
"""
return module('use {0} {1}'.format(directory, flags))
def unuse(directory):
"""
Remove one or more directories from the
MODULEPATH environment variable.
"""
return module('unuse {0} {1}'.format(directory))