modulefiles

SBGrid Module Files

Overview

Modulefiles for loading and unloading SBGrid applications 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 using recent versions of LMOD. We do not include LMOD in the SBGrid collection.

It is also possible to use modules to load the full sbgrid environment 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.

Application modules example, bash

  $ export MODULEPATH=/programs/share/modulefiles/x86_64-linux/sbgrid #:"$MODULEPATH"
  $ ml avail

---------------------- /programs/share/modulefiles/x86_64-linux/sbgrid -----------------------
   2dx/3.3.0                                 fasta/36.3.8d                                    profphd/1.0.38
   2dx/3.4.2                          (D)    fasta/36.3.8g                                    promals/20120412
   3dfsc/3.0                                 fasta/36.3.8h                                    propka/3.4.0
   3dna/2.3                                  fasta/36.3.8i                             (D)    prospect/1.0
   3dna/2.3-20160402                         fastmodelfree/20060221                           proteinmpnn/20220819
   3dna/2.3-20170208                         fdt/0.24.0                                       proteus/3.0
   3dna/2.3.1-20170624                       fdt/0.25.1                                       protomo/1.1.4
   3dna/2.4                                  fdt/0.26.3                                (D)    protomo/2.0.9
   3dna/2.4.4                         (D)    ffmpeg/3.2.4                                     protomo/2.2.0
...

Full SBGrid environment module example, bash

Load

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

$ ml load sbgrid/rc
Loading SBGrid
********************************************************************************
                  Software Support by SBGrid (www.sbgrid.org)
********************************************************************************

 SBGrid was developed with support from its members, Harvard Medical School,
 HHMI, and NSF. If use of SBGrid compiled software was an important element
 in your publication, please include the following reference in your work:

 Software used in the project was installed and configured by SBGrid.
 cite: eLife 2013;2:e01456, Collaboration gets the most out of software.
********************************************************************************
 SBGrid installation last updated: 2024-05-03
 Please submit bug reports and help requests to:       <bugs@sbgrid.org>  or
                                                       <https://sbgrid.org/bugs>
            For additional information visit https://sbgrid.org/wiki
********************************************************************************

or

$ ml load sbgrid/shrc
Loading SBGrid
********************************************************************************
                  Software Support by SBGrid (www.sbgrid.org)
********************************************************************************

 SBGrid was developed with support from its members, Harvard Medical School,
 HHMI, and NSF. If use of SBGrid compiled software was an important element
 in your publication, please include the following reference in your work:

 Software used in the project was installed and configured by SBGrid.
 cite: eLife 2013;2:e01456, Collaboration gets the most out of software.
********************************************************************************
 SBGrid installation last updated: 2024-05-03
 Please submit bug reports and help requests to:       <bugs@sbgrid.org>  or
                                                       <https://sbgrid.org/bugs>
            For additional information visit https://sbgrid.org/wiki
********************************************************************************

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