Installing Software
Using the BioGrids Environment
Getting Help
Support for Site Administrators
Hardware Support Notes
Most of the software titles installed in the BioGrids software collection have several versions available. We try to provide at least three versions of each software package, although very old or very new applications may have fewer versions.
To list the available versions of a software title, you can use the biogrids-info utility. Running biogrids-info -l will list the versions for your current platform. From a Linux machine, a search for samtools versions looks like this:
$ biogrids-info -l samtools
Version information for: /programs/x86_64-linux/samtools
Default version: 1.13
In-use version: 1.13
Installed versions: 1.13 1.12 1.10 1.9 1.8 1.7 1.6 1.5 1.4.1 1.3.1 1.3 0.1.19
Other available versions: 1.12 1.10 1.9 1.8 1.7 1.6 1.5 1.4.1 1.3.1 1.3 0.1.19
Overrides use this shell variable: SAMTOOLS_X
Running biogrids-info -L will print the available versions for the current platforms, OS X and Linux.
$ biogrids-info -L samtools
Version information for: /programs/x86_64-linux/samtools
Default version: 1.13
In-use version: 1.13
Installed versions: 1.13 1.12 1.10 1.9 1.8 1.7 1.6 1.5 1.4.1 1.3.1 1.3 0.1.19
Other available versions: 1.12 1.10 1.9 1.8 1.7 1.6 1.5 1.4.1 1.3.1 1.3 0.1.19
Overrides use this shell variable: SAMTOOLS_X
No program directory by that name found in /programs/i386-linux.
Version information for: /programs/i386-mac/samtools
Default version: 1.13
Installed versions: 1.13 1.12 1.10 1.9 1.8 1.7 1.6 1.5 1.4.1 1.3.1 1.3 0.1.19 1.13 1.12 1.10 1.9 1.8 1.7 1.6 1.5 1.4.1 1.3.1 1.3 0.1.19
Other available versions: 1.12 1.10 1.9 1.8 1.7 1.6 1.5 1.4.1 1.3.1 1.3 0.1.19
Overrides use this shell variable: SAMTOOLS_X
No program directory by that name found in /programs/powermac.
To override the default version of a software title, you need to create an override file. The shell configuration scripts will read this file and override the default version.
The override file is named .sbgrid.conf (begins with a dot) and should be placed in your $HOME directory. The syntax for overrides is a simple key=value pair. E.g. it should look like this:
APPLICATION_X=1.2
APPLICATION_X is the name of the application followed by an underscore and the shorthand initial for the architecture. The last field on the line is the software version number you want to use. The initials for each software branch are:
Architecture | Shorthand Initial |
---|---|
Linux | _X |
Mac | _M |
To quickly open the overrides file in your default $EDITOR, you can run sbgrid-overrides -e.
When you open a new shell, you will see a message about the overridden version. Note that a site administrator can create sitewide or machine-specific overrides as well.
The example output below shows several packages on linux being changed from the default version:
*********************************************************************
This BioGrids installation last updated: 2018-09-18
Please submit bug reports and help requests to: help@biogrids.org.
*********************************************************************
Configuration options in effect for this shell:
Variable Setting Configuration
TRINITYRNASEQ_X 2.6.6 personal
R_X 3.4.1 personal
PICARD_X 2.5.0 personal
SAMTOOLS_X 1.7 personal
To disable a specific software package, set its version to "disable" in your ~/.sbgrid.conf file.