modulefiles.md
... ...
@@ -0,0 +1,65 @@
1
+#SBGrid/BioGrids Module Files
2
+
3
+- [Overview](#overview)
4
+- [Accessing Modules](#accessing-modules)
5
+- [Verify](#verify)
6
+- [Load](#load)
7
+- [Unload](#unload)
8
+- [Issues](#issues)
9
+
10
+**Overview**
11
+
12
+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. Loading the environment as a module replaces the "source" command. If you are using modules then you should remove the source lines, such as "source sbrid.shrc", from your startup rc files.
13
+
14
+**Accessing Modules**
15
+
16
+To access the files you need to update your **MODULEPATH** environment variable.
17
+
18
+in bash
19
+
20
+ export MODULEPATH=/programs/share/modulefiles/x86_64-linux:"$MODULEPATH"
21
+
22
+in tcsh
23
+
24
+ setenv MODULEPATH /programs/share/modulefiles/x86_64-linux:"$MODULEPATH"
25
+
26
+The above command may be added to your shell startup files or your site Administrator may update the system wide path.
27
+
28
+**Verify**
29
+
30
+***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.
31
+
32
+ $ module avail sbgrid
33
+ ---------------------- /programs/share/modulefiles/i386-mac --------------------------
34
+ sbgrid/rc
35
+
36
+
37
+**Load**
38
+
39
+The module determines if you are using bash or tcsh and loads the appropriae environment. You use the same command in tcsh and bash to load the module.
40
+
41
+ $ module load sbgrid
42
+ Loading SBGrid
43
+ ********************************************************************************
44
+ Software Support by SBGrid (www.sbgrid.org)
45
+ ********************************************************************************
46
+ SBGrid Announcements
47
+ ... "remainder of startup message"
48
+ $
49
+
50
+
51
+**Unload**
52
+
53
+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***.
54
+
55
+ $ module unload sbgrid
56
+ UnLoading SBGrid
57
+
58
+**Issues**
59
+
60
+Please report any issues to bugs@sbgrid.org
61
+
62
+
63
+
64
+
65
+