usage/client_CLI_install.md
... ...
@@ -0,0 +1,124 @@
1
+## SBGrid package mangager installation client
2
+
3
+The SBGrid software stack can be installed using our CLI (command line interface) installation client for [Linux (CentOS/RHEL 6 or 7 recommended) or Apple OSX computers running MacOSX v10.9 - 10.12.](operatingsystems)
4
+
5
+The SBGrid installation client requires an individual account. To get started, first, set up an account by registering here : [SBGrid registration](https://sbgrid.org/registration/register/)
6
+
7
+### Pre-installation requirements
8
+
9
+**Admin access required on your computer.**
10
+ The SBGrid installation client will install the software tree to /opt/sbgrid and create a symlink from this directory to /programs. While admin privileges are not required to run the application, you will need admin privileges to create /opt/sbgrid and /programs .
11
+
12
+**Existing SBGrid installations must be renamed or removed.**
13
+ If you have previously installed SBGrid software on your computer at /programs or at /opt/sbgrid, these directories should be removed or renamed. The client will create these on first run.
14
+
15
+**Hard Drive Space**
16
+ Depending on what you install, ensure you have enough free hard drive space on your machine.
17
+
18
+**For large packages (Phenix, Rosetta, CCP4), a wired connection is recommended.**
19
+ Some packages are quite large and can be slow to download, especially over WiFi.
20
+
21
+**pip**
22
+ pip is a package management system used to install and manage software packages written in Python. The software installation client is installable by pip. This may not be on you machine by default, instructions for adding it are included here.
23
+
24
+### pip - Mac Installation
25
+
26
+ On mac, pip is available from [macports](https://www.macports.org/), [homebrew](http://brew.sh/), and [fink](http://finkproject.org/). It also can be added using **easy_install**. easy_install will install pip into your system python.
27
+
28
+ $ sudo easy_install pip
29
+
30
+### pip - Linux Installation
31
+
32
+ On CentOS6, you can install pip from the EPEL repository (yum -y install python-pip) or as [per these directions](https://pip.pypa.io/en/stable/installing/)
33
+
34
+## CLI client - Installation and activation
35
+**1. Download the latest SBGrid installation client from here.**
36
+
37
+[Latest build : 1.0.471, 2017-02-17](downloads/archive/SBGrid_Installer-1.0.471-py2-none-any.whl)
38
+
39
+**2. Install / Upgrade with pip**
40
+
41
+ $ sudo pip install SBGrid_Installer-1.0.461-py2-none-any.whl
42
+
43
+ Which should produce output similar to :
44
+
45
+```
46
+Unpacking ./SBGrid_Installer-1.0.448-py2-none-any.whl
47
+Requirement already satisfied (use --upgrade to upgrade): pyasn1 in /nfs/programs-dev/i386-mac/python/2.7.5/lib/python2.7/site-packages (from SBGrid-Installer==1.0.488)
48
+Downloading/unpacking requests (from SBGrid-Installer==1.0b2.dev412)
49
+ Downloading requests-2.11.1.tar.gz (485kB): 485kB downloaded
50
+ Running setup.py egg_info for package requests
51
+
52
+ warning: no files found matching 'test_requests.py'
53
+Installing collected packages: SBGrid-Installer, requests
54
+ Running setup.py install for requests
55
+
56
+ warning: no files found matching 'test_requests.py'
57
+Successfully installed SBGrid-Installer requests
58
+Cleaning up...
59
+```
60
+
61
+The *sbgrid* command will produce this usage info :
62
+
63
+ $ sbgrid
64
+
65
+```
66
+usage:
67
+sbgrid <command> [<command_args>]
68
+
69
+Available commands are:
70
+ activate Activate new installation
71
+ list List available packages
72
+ info Print package metadata
73
+ install Install single package
74
+ install-all Install all packages from collection
75
+ installed List installed packages
76
+ remove Remove installed package
77
+ resume Resume interrupted installations
78
+ upgrades List available upgrades for installed packages
79
+ upgrade Upgrade package to latest version
80
+ upgrade-all Upgrade all packages to latest version
81
+ version Print package version string
82
+sbgrid: error: too few arguments
83
+
84
+```
85
+
86
+**4. Activate the installation**
87
+Enter your site and key which you should have received these by email.
88
+
89
+ $ sbgrid activate <site name> <user name> <activation key>
90
+
91
+You may be prompted for your sudo password to create /programs and /opt/sbgrid.
92
+
93
+**5. On successful activation, list software titles.**
94
+
95
+ $ sbgrid list
96
+
97
+ If activation continues to fail, you may have an old SBGrid installation at /programs or /opt/sbgrid. These should be removed.
98
+
99
+You may also be blocked from accessing SBGrid servers on port 873 and port 8080 by your institution's firewall. You can check if you can access [port 873 here](http://portquiz.net:873) and [port 8080 here](http://portquiz.net:8080)
100
+
101
+For help, email *bugs@sbgrid.org.*
102
+
103
+### Installation on an external drive or USB key
104
+Currently the installer application installs the software tree in /opt/sbgrid and uses a symlink at /programs. This link is required for the software to work, but in principle the software can be located anywhere and linked to /opt/sbgrid. This functionality is not yet included in the SBGrid application, but can be set up manually with a symlink.
105
+
106
+An installation can be made on an external drive if you first do an install (into /opt/sbgrid), then move it and symlink to the new location.
107
+
108
+**Example:** 128Gb USB 'key' drives are available on Amazon for 30$ or less and are a nice way to supplement the SSDs that come in Mac laptops. To install on an external drive like this, mount it on your computer. For this example, the mount is */Volumes/sbgrid_client_install*. Then, using the SBGrid installer, do an initial installation on the hard drive. To make life easy, just do one application. Then close the installer application.
109
+
110
+Next move */opt/sbgrid* to the USB key at */Volumes/sbgrid_client_install*. You will likely need sudo for this.
111
+
112
+ $ sudo mv /opt/sbgrid /Volumes/sbgrid_client_install/.
113
+
114
+Now we have */Volumes/sbgrid_client_install/sbgrid*. Create a symlink from */opt/sbgrid* to */Volumes/sbgrid_client_install/sbgrid*.
115
+
116
+ $ sudo ln -s /Volumes/sbgrid_client_install/sbgrid /opt/sbgrid
117
+
118
+The symlink at */programs* still points to */opt/sbgrid*, and that is a link that points to the external location. Open the installer and add the desired applications. These will now install to the external drive.
119
+
120
+### Some known issues
121
+
122
+* **rsync required on 873 or 8080**. The application will fail if outbound port 873 and port 8080 are blocked by your institution or are otherwise not available.
123
+
124
+* **Activation Failed**. In some cases the Authorization dialog for admin privileges does not appear during activation. This causes the client activation to fail. This is usually due to a previously existing /programs directory or symlink from a prior installation. This must be removed for activation to be successful. Other users have reported successful activation after a restart.
usage/client_CLI_usage.md
... ...
@@ -0,0 +1,253 @@
1
+## SBGrid installation client - Usage
2
+
3
+**Instructions for installation of the SBGrid software installation client can be found here** --> [Installation Instructions](client_CLI_install).
4
+
5
+All SBGrid software is run from the the terminal.
6
+For information on how to run software from the SBGrid collection and configure your shell, check the [getting started page.](getting_started).
7
+
8
+### General
9
+The SBGrid software installation client is a command line-based installer for the SBGrid software collection. The application allows for selected applications to be installed in the familiar SBGrid environment.
10
+
11
+The client displays software 'Collections' as a list.
12
+
13
+ $ sbgrid list
14
+
15
+```
16
+Crystallography
17
+ 3dna
18
+ adxv
19
+ albula
20
+ autoproc
21
+ ...
22
+
23
+NMR
24
+ aqua
25
+ aria
26
+ cara
27
+ ccpnmr
28
+ ccpnmr-chembuild
29
+ ...
30
+
31
+Electron Microscopy
32
+ 2dx
33
+ ace2
34
+ auto3dem
35
+ bfactor
36
+ bsoft
37
+ burnham-brandeis-helical-package
38
+ chimera
39
+ ...
40
+
41
+Structure Visualization & Analysis
42
+ 3dna
43
+ anaconda
44
+ apbs
45
+ aqua
46
+ bobscript
47
+ caver
48
+ caver-analyst
49
+ ccp4mg
50
+ chimera
51
+ ...
52
+
53
+Computational Chemistry
54
+ ambertools
55
+ apbs
56
+ appion
57
+ autodock
58
+ autodock-vina
59
+ avogadro
60
+ concoord
61
+ dock
62
+ gromacs
63
+ ...
64
+
65
+Other
66
+ a2ps
67
+ abyss
68
+ aline
69
+ amigos-ii
70
+ amps
71
+ assemble2
72
+ bamtools
73
+ ...
74
+```
75
+
76
+Information about each title, including a description and links to documentation can be show with the *sbgrid info <title>* command.
77
+
78
+### Example : Installing Albula
79
+
80
+ $ sbgrid info albula
81
+
82
+```
83
+Package: ALBULA
84
+Name slug: albula
85
+
86
+Available versions:
87
+* 3.2.0-2 (default)
88
+* 3.1.0-13
89
+* 3.0.0-14
90
+* 2.2.12
91
+
92
+Collection(s): Crystallography
93
+
94
+Description:
95
+ consists of the standalone program ALBULA VIEWER, a fast and easy-to-
96
+use program that allows optimal visualization of PILATUS and EIGER data,
97
+and ALBULA API, a Python programming interface for displaying images and
98
+performing operations and calculations. The API enables you to easily
99
+integrate the viewer functionality into your beamline infrastructure or
100
+experimental setup.
101
+
102
+Links:
103
+* Website: https://www.dectris.com/Albula_Overview.html
104
+```
105
+
106
+To install:
107
+
108
+ $ sbgrid install albula
109
+
110
+```
111
+Installing: albula
112
+Updating installation configuration...
113
+Installation was successfull!
114
+```
115
+
116
+To get started, load the SBGrid environment :
117
+
118
+ $ source /programs/sbgrid.shrc
119
+
120
+```
121
+ Software Support by SBGrid (www.sbgrid.org)
122
+********************************************************************************
123
+
124
+...
125
+
126
+SBGrid installation last updated: 2016-10-21
127
+Please submit bug reports and help requests to: <bugs@sbgrid.org> or
128
+ <http://sbgrid.org/bugs>
129
+********************************************************************************
130
+```
131
+
132
+### Example : Removing Albula
133
+
134
+ $ sbgrid remove albula
135
+
136
+results in :
137
+
138
+```
139
+Removing: albula
140
+Updating installation configuration...
141
+Package removed!
142
+```
143
+
144
+### Version selection
145
+
146
+Default versions are installed by default for each application, though individual versions can be selected for each title.
147
+
148
+To do so, include the version after the title followed the version. To see what versions are available, use the *sbgrid info <title>* command. Let;s us the title epmr as an example here:
149
+
150
+ $ sbgrid info epmr
151
+
152
+```
153
+Package: EPMR
154
+Name slug: epmr
155
+
156
+Available versions:
157
+* 16.04 (default)
158
+* 16.01
159
+* 15.12
160
+* 15.04
161
+* 13.07
162
+* 11.02
163
+
164
+Collection(s): Crystallography
165
+
166
+Description:
167
+ a program that finds crystallographic molecular replacement solutions
168
+using an evolutionary search algorithm. The program directly optimizes
169
+three rotational and three positional parameters for the search model with
170
+respect to the correlation coefficient between Fo and Fc.
171
+
172
+Links:
173
+* Website: http://www.epmr.info/
174
+* Manual: http://www.epmr.info/UsersGuide.html
175
+```
176
+
177
+To install version 11.02, add the version string like so:
178
+
179
+ $ sbgrid install epmr 11.02
180
+
181
+which will produce :
182
+
183
+```
184
+Installing: epmr (11.02)
185
+Updating installation configuration...
186
+Installation was successfull!
187
+key@key-mbp [20161021-21:05:56] ~/Downloads
188
+```
189
+
190
+Check which versions are installed with the sbgrid info command again
191
+
192
+ $ sbgrid info epmr
193
+
194
+```
195
+epPackage: EPMR
196
+Name slug: epmr
197
+
198
+Available versions:
199
+* 16.04 (default)
200
+* 16.01
201
+* 15.12
202
+* 15.04
203
+* 13.07
204
+* 11.02 (installed)
205
+
206
+...
207
+
208
+```
209
+
210
+Confirm with the *sbwhich* command
211
+
212
+
213
+ $ sbwhich epmr
214
+```
215
+/programs/i386-mac/epmr/11.02/epmr
216
+```
217
+
218
+Reload the sbgrid shell to use the new version ( or set the environment variable EPMR_M=11.02 ).
219
+
220
+### Software Versions Management in the SBGrid environment
221
+If you have a single version of an application installed, explicit version selection in your environment is not needed.
222
+
223
+In the case of multiple installed versions, the *SBGrid Default* version will be the version available at the terminal when it is installed, unless configured otherwise in *~/.sbgrid.conf*.
224
+
225
+In the case of multiple non-default versions installed, the *latest release* will be version available in your shell. If you would like to have more than one version of a title installed, and prefer to use an older release or the non-default version when a default version is installed, you must set this explicitly in your *~/.sbgrid.conf* file. This is the same as in the standard SBGrid environment.
226
+
227
+**Version priority in the shell**
228
+ 1. *~/.sbgrid.conf*
229
+ 2. Installed single version
230
+ 3. Installed Default version
231
+ 4. Latest installed release
232
+
233
+There is more info on how to do that here --> [SBGrid version overrides](versions)
234
+
235
+### Running SBGrid software
236
+
237
+To use the software at the terminal in bash, open a new terminal and run
238
+
239
+ $ source /programs/sbgrid.shrc
240
+
241
+or in tcsh
242
+
243
+ $ source /programs/sbgrid.cshrc
244
+
245
+### Questions, Problems and Known Issues
246
+For questions or problems, the Help menu will direct to the SBGrid help page. Or just email *bugs@sbgrid.org*.
247
+If relevant, please include a screenshot of the GUI if possible (command + shift + 4) and please include the ~/Library/Application Support/SBGrid/sbgrid.log file with your report.
248
+
249
+**Known issues**
250
+
251
+* The application will fail if outbound port 873 and port 8080 are blocked by your institution or are otherwise not available.
252
+
253
+* In some cases the prompt for admin credentials fails to appear on activation. Be sure there is no prior SBGrid install on your machine at /programs or /opt/sbgrid.
usage/client_install.md
... ...
@@ -0,0 +1,67 @@
1
+## SBGrid installation client
2
+
3
+The SBGrid softare collection can be installed using our graphical installation client for Apple OSX computers running MacOSX v10.9 - 10.12 .
4
+
5
+![](images/client_all.png)
6
+
7
+Looking to get started with the SBGrid installation client? First, set up an account by registering here : [SBGrid registration](https://sbgrid.org/registration/register/)
8
+
9
+A command line version is also available for mac and linux - installation instructions can be found here : [CLI installation](client_CLI_install).
10
+
11
+Usage info for the GUI and command line clients can be found here : [GUI Usage](client_usage) and here : [CLI usage](client_CLI_usage) respectively.
12
+
13
+### Pre-installation
14
+
15
+**1. Admin access required.**
16
+ The SBGrid installation client will install the software tree to */opt/sbgrid* and create a symlink from this directory to */programs*. While admin privileges are not required to run the application, you will need admin privileges to create */opt/sbgrid* and */programs* .
17
+
18
+**2. Existing installations must be renamed or removed.**
19
+ If you have previously installed SBGrid software on your computer at */programs* or at */opt/sbgrid*, these directories should be removed or renamed. The client will create these on first run.
20
+
21
+**3. Hard Drive Space**
22
+ Depending on what you install, ensure that you have enough free hard drive space on your machine.
23
+
24
+**4. For large packages (Phenix, Rosetta, CCP4), a wired connection is recommended.**
25
+ Some packages are quite large and can be slow to download, especially over WiFi.
26
+
27
+### Installation and activation
28
+
29
+**1. Download the latest SBGrid installation client from here.**
30
+
31
+ [Latest build : 1.0.506, 2017-04-21](downloads/SBGrid_Installer-1.0.506.dmg)
32
+
33
+**2. Mount the .dmg disk image on your Mac.** Copy the 'SBGrid installer.app' to a convenient location - it does not need to be in /Applications. The .app bundle can be run directly from the mounted dmg image with no installation if desired.
34
+
35
+**3. Enter your site, user name, and key.** You should have received these by email.
36
+
37
+![activation](images/client_activation.png)
38
+
39
+On activation you will be prompted to provide admin credentials for your mac. This is to create the */opt/sbgrid* directory and */programs* symlink.
40
+
41
+![activation](images/client_permissions.png)
42
+
43
+**4. On successful activation, you should see the client populate with software titles.** If not, please close the application and try again. If activation continues to fail, you may have an old SBGrid installation at */programs* or */opt/sbgrid*. These should be removed. You may also be blocked from accessing SBGrid servers on port 873 and port 8080 by your institution's firewall. You can check if you can access [port 873 here](http://portquiz.net:873) and [port 8080 here](http://portquiz.net:8080)
44
+For help, email *bugs@sbgrid.org.*
45
+
46
+### Installation on an external drive or USB key
47
+Currently the installer application installs the software tree in */opt/sbgrid* and uses a symlink at */programs*. The */programs* link is required for the software to work, but in principle the software can be anywhere by linking */opt/sbgrid* to the desired installation point. This functionality is not yet included in the SBGrid application, but can be set up manually post-install with a symlink. First do an install (into */opt/sbgrid*), then move it to the desired localtion. Then symlink to the new location from */opt/sbgrid*.
48
+
49
+**Example:** 128Gb USB 'key' drives are available on Amazon for 30$ or less and are a nice way to supplement the small SSDs that come in Mac laptops. To install on an external drive in this way, first mount it on your computer. For this example, the mount is */Volumes/sbgrid_client_install*. Then, using the SBGrid installer, do an initial installation on the hard drive. To make life easy, just do one application. Then close the installer application.
50
+
51
+Next move **/opt/sbgrid** to the USB key at */Volumes/sbgrid_client_install*. You will likely need sudo for this.
52
+
53
+ sudo mv */opt/sbgrid* /Volumes/sbgrid_client_install/.
54
+
55
+Now we have */Volumes/sbgrid_client_install/sbgrid*. Create a symlink from **/opt/sbgrid** to */Volumes/sbgrid_client_install/sbgrid*.
56
+
57
+ sudo ln -s /Volumes/sbgrid_client_install/sbgrid */opt/sbgrid*
58
+
59
+The symlink at **/programs** still points to **/opt/sbgrid**, and that is a link that points to the external location. Open the installer and add the desired applications. These will now install to the external drive.
60
+
61
+[SBGrid install client -- Usage info](client_usage)
62
+
63
+### Known issues
64
+
65
+* **rsync required on 873 or 8080**. The application will fail if outbound port 873 and port 8080 are blocked by your institution or are otherwise not available.
66
+
67
+* **Activation Failed**. In some cases the Authorization dialog for admin privileges does not appear during activation. This causes the client activation to fail. This is usually due to a previously existing */programs* directory or symlink from a prior installation. This must be removed for activation to be successful. Other users have reported successful activation after a restart.
usage/client_usage.md
... ...
@@ -0,0 +1,83 @@
1
+## SBGrid installation client - Usage
2
+
3
+**Instructions for installing the SBGrid software installation client can be found here** --> [Installation Instructions](client_install)
4
+
5
+### General
6
+The SBGrid software installation client is a GUI-based installer for the SBGrid software collection. The application allows for selected applications to be installed in the familiar SBGrid environment.
7
+
8
+ ![installed](images/client_install.png)
9
+
10
+The client GUI is displays software 'Collections' on the right panel with folder icons under the 'Packages' heading. These Collections control the list of titles displayed in the center 'main' panel.
11
+
12
+The first of two of these 'Collections' are shortcut meta-collections of the local machine. The first is the currently installed titles. The second icon, Updates, shows updates available from SBGrid. 'Pending' is a collection of pending installs and removals. Below these shortcuts are packages are grouped by primary scientific uses. Installation status is also indicated in theses collections.
13
+
14
+Information about each title, including a description and links to documentation are shown in the upper right panel when that title is selected in the main pane.
15
+
16
+Once packages have been configured for installation and/or removal by selecting their checkbox, clicking the 'Apply Changes' button will perform update the titles, adding pending installations and removing pending deletions.
17
+
18
+### Example : Installing Albula
19
+Check the box to select Albula, then click the 'Apply Changes' button.
20
+Notice the text turns green for pending installations. Pending updates are Orange.
21
+![apply](images/client_apply2.png)
22
+
23
+### Example : Removing Albula
24
+Uncheck the box for Albula. Removals are shown in red text.
25
+![apply](images/client_remove1.png)
26
+
27
+Click apply changes. Albula will be removed.
28
+![apply](images/client_remove2.png)
29
+
30
+### Version selection
31
+
32
+Default versions are installed by default for each application, though individual versions can be selected for each title. To do so, show the version pane by selecting **"Show all package versions"** from the **"View"** menu. Then, in the bottom right, select a desired version with the check boxes. Multiple versions of a given title can be installed and are indicated in the main panel.
33
+
34
+Enable version panel
35
+![all](images/client_versions1.png)
36
+
37
+Check old/non-default versions
38
+![all](images/client_versions2.png)
39
+
40
+
41
+### Versions and the SBGrid environment
42
+If you have a single version of an application installed, explicitly version selection in your environment will not be needed. In the case of multiple installed versions, the *SBGrid Default* version will be the version available at the terminal when installed, unless configured otherwise in *~/.sbgrid.conf*.
43
+
44
+If you have multiple non-default versions installed, the *latest release* will be version available in your shell. If you would like to have more than one version of a title installed, and prefer to use either an older release or the non-default version when a default version is installed, you must set this explicitly in your *~/.sbgrid.conf* file as in the standard SBGrid environment.
45
+
46
+**Version priority in the shell**
47
+ 1. *~/.sbgrid.conf*
48
+ 2. Installed Default version
49
+ 3. Latest installed release
50
+
51
+You can do open the configuration file by selecting the *"Edit Configuration File"* from the *"SBGrid Installer"* menu.
52
+
53
+![all](images/client_config1.png)
54
+
55
+This will open a text editor with a sample configuration file, or your *~/.sbgrid.conf* file if you have one already.
56
+
57
+![all](images/client_config2.png)
58
+
59
+There is more info on how to do that here --> [SBGrid version overrides](versions)
60
+
61
+
62
+### Running the software
63
+
64
+To run the software, you can click the "SBGrid Shell" button for an initialized bash shell.
65
+
66
+You may also run the software from another terminal on your machine.
67
+To use the software at the terminal in bash, open a new terminal and run
68
+
69
+ source /programs/sbgrid.shrc
70
+
71
+or in tcsh
72
+
73
+ source /programs/sbgrid.cshrc
74
+
75
+### Questions, Problems and Known Issues
76
+For questions or problems, the Help menu will direct to the SBGrid help page. Or just email *bugs@sbgrid.org*.
77
+If relevant, please include a screenshot of the GUI if possible (command + shift + 4) and please include the ~/Library/Application Support/SBGrid/sbgrid.log file with your report.
78
+
79
+**Known issues**
80
+
81
+* The application will fail if outbound port 873 and port 8080 are blocked by your institution or are otherwise not available.
82
+
83
+* In some cases the prompt for admin credentials fails to appear on activation. Be sure there is no prior SBGrid install on your machine at /programs or /opt/sbgrid.