modulefiles

SBGrid Module Files

Overview

Modulefiles for loading and unloading the sbgrid or biogrids environment are available in /programs/share/modulefiles/x86_64-linux and /programs/share/modulefiles/i386-mac. The module files are Lua format and should work with an existing LMOD installation. Loading the sbgrid/biogrids module initializes the entire sbgrid/biogrids environment and is used instead of the "source" command. If you are using modules then you should remove the source lines, such as "source sbgrid.shrc", from your startup rc files.

Accessing Modules

To access the files you need to update your MODULEPATH environment variable.

in bash

export MODULEPATH=/programs/share/modulefiles/x86_64-linux:"$MODULEPATH"

in tcsh

setenv MODULEPATH /programs/share/modulefiles/x86_64-linux:"$MODULEPATH"

The above command may be added to your shell startup files or your site Administrator may update the system wide path.

Verify

module avail will show you what modules are available for loading. If your MODULEPATH is correct you should see the sbgrid/rc and/or the biogrids/rc module.

$ module avail sbgrid
---------------------- /programs/share/modulefiles/i386-mac --------------------------
sbgrid/rc

Load

Loading the sbgrid/biogrids module initializes the entire environment and not individual applications. The module determines if you are using bash or tcsh and loads the shell appropriate environment using the same command for both tcsh and bash.

$ module load sbgrid
Loading SBGrid
********************************************************************************
              Software Support by SBGrid (www.sbgrid.org)
********************************************************************************
                          SBGrid Announcements
... "remainder of startup message"
$

Unload

You can remove the sbgrid/biogrids environment with the module unload command. This removes any grid specific environment settings. If after loading sbgrid you load additonal modules, these modules will not be removed. To see what modules you have loaded you can use module list.

$ module unload sbgrid
UnLoading SBGrid

Reporting Issues

Please report any issues to bugs@sbgrid.org