version_management.md
... ...
@@ -0,0 +1,63 @@
1
+# Version Management for Software Titles
2
+
3
+Documenting versions of software used in workflows is critical for reproducibility.
4
+
5
+BioGrids provides several versions for most software titles. The version in use can be set explicitly using a version override variable. See [Overriding Software Versions](https://biogrids.org/wiki/versions) for details.
6
+
7
+Below we provide details for automatic version logging and restoring or activating previous versions.
8
+
9
+## Automatic Logging
10
+
11
+BioGrids provides an environment variable for logging all BioGrids executable activity.
12
+
13
+The environment variable “SBCAP_METRICS” can be set to:
14
+
15
+ FILE | FILE:path/to/file
16
+
17
+ or
18
+
19
+ BOTH|BOTH:path
20
+
21
+When set to FILE (either form) logging is written to a FILE.
22
+
23
+If no path to file is given then the default is $(HOME)/${GRID}_capsule_log_${HOSTNAME}.
24
+
25
+If set
26
+
27
+If se
28
+(first) or to BOTH a FILE and AWS (second). Is this making sense??
29
+
30
+
31
+Entries in the log file have this form:
32
+
33
+jjv5 MB-Broken BIOGRIDS osx-10.13.6 biogrid-production_1.0.695 newrc_sh CA5BBF5F-F41E-4CFA-8AA4-37182C9DD366 /programs/i386-mac/samtools/1.10/bin/samtools 0 0
34
+jjv5 MB-Broken BIOGRIDS osx-10.13.6 biogrid-production_1.0.695 newrc_sh 3355483F-A04B-4575-868F-88D22173C957 /programs/i386-mac/python/3.6.5/bin/python 0 0
35
+
36
+
37
+
38
+$ biogrids-info -l samtools
39
+
40
+Version information for: /programs/x86_64-linux/samtools
41
+
42
+Default version: 1.10
43
+
44
+In-use version: 1.10
45
+
46
+Installed versions: 1.10 1.9 1.8 1.7 1.6 1.5 1.4.1 1.3.1 1.3 0.1.19
47
+
48
+Other available versions: 1.9 1.8 1.7 1.6 1.5 1.4.1 1.3.1 1.3 0.1.19
49
+
50
+Overrides use this shell variable: SAMTOOLS_X
51
+
52
+[ch199734@e2 ~]$
53
+
54
+
55
+## Activating Older Versions
56
+
57
+If you need to use a non-default version of a title you can specify this version with an override variable ( [Overriding Software Versions](https://biogrids.org/wiki/versions) for details).
58
+
59
+If the version of a title is not available on your platform you can install that version by specifying it either in the BioGrids GUI Installer or on the command line:
60
+
61
+./biogrids install samtools@1.7
62
+
63
+BioGrids versions are retained for every title. We do not delete or remove versions of any title. If you are unable to find th eversion you need or have difficulty installing, please send a note to help@biogrids.org.