capsules.md
... ...
@@ -8,6 +8,7 @@
8 8
- [Managing Duplicate executables](#usage-capsule-environment-for-sbgrid_managing-duplicate-executables)
9 9
- [EXAMPLES:](#usage-capsule-environment-for-sbgrid_examples)
10 10
11
+<a name="overview"></a>
11 12
## Overview
12 13
13 14
SBGrid is has a new software environment which is significantly faster than the older 'monolithic' shell environment.
... ...
@@ -17,6 +18,7 @@ Old scripts should run unaltered and no new commands are required.
17 18
18 19
**Check out Carol Herre's [presentation on Capsules on SBGrid TV](https://www.youtube.com/watch?v=baexe9R128A)**
19 20
21
+<a name="getting-started"></a>
20 22
## Getting started
21 23
22 24
You can switch from the legacy SBGrid environment to the new with the *sbcap* command. *sbcap on* will enable the capsule environment.
... ...
@@ -24,27 +26,35 @@ You can always return to the legacy configuration with the *sbcap off* command.
24 26
25 27
The sbcap setting is persistent across shells - You don't need to do this for every shell.
26 28
29
+<a name="getting-started_sbcap-example"></a>
27 30
### sbcap - Example
28 31
```
29 32
user@linux ~
30 33
$ sbcap on
31 34
```
32 35
You will see a notice that you are using the new environment
33
-```
34
- SBGrid: NEWS
35
-********************************************************************************
36
- You are using SBGrid capsules.
37
-Capsules provide a simpler, faster, more powerful command line environment with
38
-the same software and commands as the previous SBGrid configuration.
39
-You should not need to change your existing workflow.
40 36
41
-If you experience any issues, please notify us at bugs@sbgrid.org.
42
- For additional information visit https://sbgrid.org/wiki/capsules
37
+```
43 38
********************************************************************************
44 39
Software Support by SBGrid (www.sbgrid.org)
45 40
********************************************************************************
41
+ SBGrid Announcements
46 42
...
43
+********************************************************************************
44
+ Capsule Status: Active
45
+ For additional information visit https://sbgrid.org/wiki/capsules
46
+********************************************************************************
47
+$
47 48
```
49
+
50
+You can check your capsule status with **sbcap status**.
51
+
52
+```
53
+$ sbcap status
54
+Active
55
+```
56
+
57
+<a name="usage-capsule-environment-for-sbgrid"></a>
48 58
## Usage - Capsule Environment for SBGrid
49 59
```
50 60
Usage: sbgrid-exectable [ --sbwhich | --sbenv | --sbman | --sbapp:[adlshrH] | --sbcitation | --sbticket | --sbhelp ]
... ...
@@ -64,6 +74,7 @@ Usage: sbgrid-exectable [ --sbwhich | --sbenv | --sbman | --sbapp:[adlshrH] | -
64 74
sbhelp this message
65 75
```
66 76
77
+<a name="usage-capsule-environment-for-sbgrid_overrides-managing-versions"></a>
67 78
### Overrides - managing versions :
68 79
69 80
Version overrides may be defined in the ~/.sbgrid.conf file, which will be used each time the sbgrid.[sh|csh] file are sourced. A version override can also be instantiated by simply defining the APP_M prior to capsule execution.
... ...
@@ -85,7 +96,8 @@ We can change this by setting the variable BUSTER_X to 20151214 and calling sbwh
85 96
```
86 97
This can also be accomplished by simply setting BUSTER_X=20151214 in the shell or adding the line BUSTER_X=20151214 to your ~/.sbgrid.conf file as [described here](overrides).
87 98
88
-### Managing Duplicate executables
99
+<a name="usage-capsule-environment-for-sbgrid_managing-duplicate-executables"></a>
100
+### Managing Duplicate Executables
89 101
In some cases an executable may exist in multiple applications, i.e. the program *fft* exists in CCP4 **and** Tigris. A default application is already defined based on what executable would be used in the legacy environment, but the user can choose to override this selectively or permanently.
90 102
91 103
You can override the default in 4 ways. They are
... ...
@@ -100,6 +112,7 @@ You can override the default in 4 ways. They are
100 112
101 113
4. A localsite file in */programs/local/capsule/${SB_ARCH}/defaults/execname*
102 114
115
+<a name="usage-capsule-environment-for-sbgrid_examples"></a>
103 116
### EXAMPLES:
104 117
Which executable am I using?
105 118
modulefiles.md
... ...
@@ -8,12 +8,12 @@
8 8
- [Issues](#issues)
9 9
10 10
<a name="overview"></a>
11
-**Overview**
11
+## Overview
12 12
13 13
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 designed to work with an existing module/lmod setup. 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.
14 14
15 15
<a name="access"></a>
16
-**Accessing Modules**
16
+## Accessing Modules
17 17
18 18
To access the files you need to update your **MODULEPATH** environment variable.
19 19
... ...
@@ -28,7 +28,7 @@ in tcsh
28 28
The above command may be added to your shell startup files or your site Administrator may update the system wide path.
29 29
30 30
<a name="verify"></a>
31
-**Verify**
31
+## Verify
32 32
33 33
***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.
34 34
... ...
@@ -38,7 +38,7 @@ The above command may be added to your shell startup files or your site Administ
38 38
39 39
40 40
<a name="load"></a>
41
-**Load**
41
+## Load
42 42
43 43
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.
44 44
... ...
@@ -53,7 +53,7 @@ Loading the sbgrid/biogrids module initializes the entire environment and not in
53 53
54 54
55 55
<a name="unload"></a>
56
-**Unload**
56
+## Unload
57 57
58 58
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***.
59 59
... ...
@@ -61,7 +61,7 @@ You can remove the sbgrid/biogrids environment with the ***module unload*** comm
61 61
UnLoading SBGrid
62 62
63 63
<a name="issues"></a>
64
-**Issues**
64
+## Issues
65 65
66 66
Please report any issues to bugs@sbgrid.org
67 67