f95a2c4aba2d1550faef748392fda80b82223043
overrides.md
| ... | ... | @@ -0,0 +1,69 @@ |
| 1 | +====== Overriding Software Versions ====== |
|
| 2 | + |
|
| 3 | +Most of the software titles installed in the SBGrid 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. |
|
| 4 | + |
|
| 5 | +===== Display Available Versions ===== |
|
| 6 | +To list the available versions of a software title, you can use the //sbgrid// utility. Running //sbgrid -l// will list the versions for your current platform. From a Linux machine, a search for CCP4 versions looks like this: |
|
| 7 | + |
|
| 8 | +<code> |
|
| 9 | +$ sbgrid -l ccp4 |
|
| 10 | + Version information for: /programs/x86_64-linux/ccp4 |
|
| 11 | + |
|
| 12 | +Default version: 6.4.0 |
|
| 13 | +In-use version: 6.4.0 |
|
| 14 | +Other available versions: 6.3.0 6.2.0 |
|
| 15 | +Overrides use this shell variable: CCP4_X |
|
| 16 | +</code> |
|
| 17 | + |
|
| 18 | +Running //sbgrid -L// will print the available versions for the three current platforms (OS X PowerPC and Intel, Linux). |
|
| 19 | +<code> |
|
| 20 | +$ sbgrid -L gnuplot |
|
| 21 | + Version information for: /programs/x86_64-linux/gnuplot |
|
| 22 | + |
|
| 23 | +Default version: 4.6.4 |
|
| 24 | +In-use version: 4.6.4 |
|
| 25 | +Other available versions: 4.6.0 4.4.3 4.2.6 |
|
| 26 | +Overrides use this shell variable: GNUPLOT_X |
|
| 27 | + |
|
| 28 | + Version information for: /programs/i386-linux/gnuplot |
|
| 29 | + |
|
| 30 | +Default version: 4.6.0 |
|
| 31 | +Other available versions: 4.4.3 4.2.6 |
|
| 32 | +Overrides use this shell variable: GNUPLOT_L |
|
| 33 | + |
|
| 34 | + Version information for: /programs/i386-mac/gnuplot |
|
| 35 | + |
|
| 36 | +Default version: 4.6.4 |
|
| 37 | +Other available versions: 4.4.3 4.2.6 4.6.0 |
|
| 38 | +Overrides use this shell variable: GNUPLOT_M |
|
| 39 | +</code> |
|
| 40 | + |
|
| 41 | + |
|
| 42 | +===== Overriding Default Versions ===== |
|
| 43 | +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. |
|
| 44 | + |
|
| 45 | +The override file is named .sbgrid.conf 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: |
|
| 46 | + |
|
| 47 | +<code>APPLICATION_X=1.2</code> |
|
| 48 | + |
|
| 49 | +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: |
|
| 50 | + |
|
| 51 | +|Software Directory|Shorthand Initial| |
|
| 52 | +|i386-linux|_L| |
|
| 53 | +|x86_64-linux|_X| |
|
| 54 | +|i386-mac|_M| |
|
| 55 | + |
|
| 56 | +To quickly open the overrides file in your default $EDITOR, you can run //sbgrid-overrides -e//. |
|
| 57 | + |
|
| 58 | +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. |
|
| 59 | + |
|
| 60 | +The example output below shows CCP4 on linux being changed from the default version: |
|
| 61 | + |
|
| 62 | +<code> |
|
| 63 | + Configuration options in effect for this shell: |
|
| 64 | + Variable Setting Configuration |
|
| 65 | + CCP4_M 6.3.0 personal |
|
| 66 | +</code> |
|
| 67 | + |
|
| 68 | +===== Disabling a Software Package ===== |
|
| 69 | +To disable a specific software package, set its version to "disable" in your ~/.sbgrid.conf file. |
|
| ... | ... | \ No newline at end of file |