laptopinstall.md
... ...
@@ -1,67 +1,71 @@
1
-====== Copying the Software Installation ======
1
+## Copying the Software Installation
2
+
2 3
If you run a machine that is frequently disconnected from the network, like a laptop, or don't want to set up an NFS-shared software installation, it is possible to install the software to the hard disk on your local machine.
3 4
4 5
There are two scripts in the programs tree that can be used to create a copy of the software on your local hard disk. The ''sbgrid-laptop'' script allows you to select individual applications from the software distribution for installation on your laptop. By default only the latest version of the selected applications will be installed. The ''localsync'' script allows you to copy an entire operating system software branch to your local machine. This script can be used on laptops, but each branch is quite large in terms of disk space usage.
5 6
6
-======= Laptop Script ======
7
+### Laptop Script
7 8
You can create a customized local installation of the software using the ''sbgrid-laptop'' script located at ''/programs/share/bin/sbgrid-laptop''. This script requires you to have an SSH login to a computer that has access to an SBGrid software installation and will let you specify which packages you want to install.
8 9
9
-<code>
10
-sbgrid-laptop: a tool for creating a local installation of the
11
- SBGrid software on a laptop.
10
+```
11
+ sbgrid-laptop: a tool for creating a local installation of the
12
+ SBGrid software on a laptop.
13
+
14
+ Usage: sbgrid-laptop [-ituv] [-e list|config]
12 15
13
-Usage: sbgrid-laptop [-ituv] [-e list|config]
16
+ -d Debug mode creates a log file for troubleshooting purposes.
17
+ -e [list|config]
18
+ Edit the software download list.
19
+ -i Initial set up and installation of the SBGrid software.
20
+ -s Re-run SSH key set up process.
21
+ -t Test your current configuration.
22
+ -u Update an existing installation using the current
23
+ configuration.
24
+ -v Verbose option for the file transfer.
25
+```
14 26
15
- -d Debug mode creates a log file for troubleshooting purposes.
16
- -e [list|config]
17
- Edit the software download list.
18
- -i Initial set up and installation of the SBGrid software.
19
- -s Re-run SSH key set up process.
20
- -t Test your current configuration.
21
- -u Update an existing installation using the current
22
- configuration.
23
- -v Verbose option for the file transfer.
27
+ You need an SSH login to a machine with the SBGrid software installed
28
+ to use this script. The script will create an SSH key and run an SSH
29
+ agent process to handle authentication for the file transfers.
24 30
25
-You need an SSH login to a machine with the SBGrid software installed
26
-to use this script. The script will create an SSH key and run an SSH
27
-agent process to handle authentication for the file transfers.
28
-</code>
29 31
30 32
Copy the script the machine you want to install the software on, and then run it in install mode: ''./sbgrid-laptop -i''. Follow the prompts on the screen to create your configuration file, your software installation list and to enable logins using an SSH key for authentication.
31 33
32
-======= Sync Script ======
34
+### Sync Script
33 35
There is a script in the programs tree that can be used to copy the appropriate branch from a shared installation to your laptop or workstation.
34 36
35 37
Copy /programs/share/bin/localsync from the machine that has the software to your home directory on the standalone machine:
36 38
37
-<code>scp your.server.name:/programs/share/bin/localsync ~/</code>
39
+
40
+ scp your.server.name:/programs/share/bin/localsync ~/
41
+
38 42
39 43
Then run the script like this:
40 44
41
-<code>
42
-chmod 755 ~/localsync
43
-~/localsync yourusername@your.server.name
44
-</code>
45
+ chmod 755 ~/localsync
46
+ ~/localsync yourusername@your.server.name
47
+
45 48
46 49
The script will prompt you for your sudo (admin) password in order to create the programs directory, and then it will prompt you for your login password to the server that hosts your programs installation.
47 50
48 51
Here is an example run on my workstation:
49 52
50
-<code>
51
- $ ./localsync bene@developer.sbgrid.org
52
-Running 'sudo mkdir /programs && sudo chown bene /programs'
53
-[sudo] password for bene:
54
-Copying the software from the i386-mac branch on your server to your local
55
-hard disk. Enter your ssh login password below for bene@developer.sbgrid.org:
53
+```
54
+ $ ./localsync bene@developer.sbgrid.org
55
+ Running 'sudo mkdir /programs && sudo chown bene /programs'
56
+ [sudo] password for bene:
57
+ Copying the software from the i386-mac branch on your server to your local
58
+ hard disk. Enter your ssh login password below for bene@developer.sbgrid.org:
56 59
57
-receiving file list ...
58
-</code>
60
+ receiving file list ...
61
+```
59 62
60 63
This will copy the entire branch for your architecture to your local hard drive. For the OS X branch, this will use approximately 100 GB of disk space.
61 64
62 65
You should use a network cable for the initial download, since the download is fairly large. Subsequent runs of the 'localsync' script are differential; they will only copy new or changed files, so they can be run over a wireless connection. The script can be run at any time to make your local installation match the installation on your local server.
63 66
64
-====== Sharing a Software Installation without NFS ======
67
+# Sharing a Software Installation without NFS
68
+
65 69
While we recommend that sites export their software installation via NFS to their workstations, it is possible to use rsync to copy the master installation to each workstation. This method has the drawback that it requires manual intervention on the part of the local sysadmin, and updates will not be instantaneous or simultaneous for all machines.
66 70
67 71
On each client machine, you'll need an 'sbgrid' user. That user will have a passphraseless ssh key that lets it log into the machine that hosts your primary installation. Each client machine will have a cron job for that sbgrid user that runs at 2 AM that will sync the programs from the master installation to the client machine.
... ...
@@ -72,49 +76,57 @@ Here is a basic command run down. 'server1' holds the programs installation and
72 76
* Create the 'sbgrid' user on client1
73 77
* Check the free space on /.
74 78
* If there's enough free space, set up the programs directory:
75
-<code>
76
-mkdir /programs
77
-chown -R sbgrid:sbgrid /programs
78
-</code>
79
+
80
+
81
+ mkdir /programs
82
+ chown -R sbgrid:sbgrid /programs
83
+
79 84
* If there is not enough free space on the root volume, you'll need to find space on a local volume.
80 85
81 86
* Login as 'sbgrid' on client1.
82 87
* Create the passphraseless ssh key:
83
-<code>
84
-ssh-keygen -d
85
-</code>
88
+
89
+
90
+ ssh-keygen -d
91
+
86 92
87 93
(hit enter to confirm default file location, no passphrase, etc)
94
+
88 95
* Copy the ssh key to server1:
89
-<code>
90
-cat ~/.ssh/id_dsa.pub | ssh server1 'cat - >> ~/.ssh/authorized_keys'
91
-</code>
96
+
97
+
98
+ cat ~/.ssh/id_dsa.pub | ssh server1 'cat - >> ~/.ssh/authorized_keys'
99
+
92 100
* Copy the localsync script from server1 to client1. From client1:
93
-<code>
94
-scp sbgrid@server1:/programs/share/bin/localsync .
95
-</code>
101
+
102
+
103
+ scp sbgrid@server1:/programs/share/bin/localsync .
104
+
96 105
97 106
(May prompt to accept the host key. If you can't login without a password, the ssh key stuff above has failed, and you'll need to troubleshoot that.)
98
-</code>
99
-chmod 755 localsync
100
-./localsync sbgrid@server1
101
-</code>
107
+
108
+ chmod 755 localsync
109
+ ./localsync sbgrid@server1
110
+
102 111
(This will take a while depending on the speed of the machines/network.)
103 112
104 113
* Test the installation:
105
-<code>
114
+
115
+
106 116
tcsh
107
-source /programs/sbgrid.cshrc
108
-</code>
109
- or
110
-<code>
117
+
118
+ source /programs/sbgrid.cshrc
119
+
120
+or
111 121
bash
112
-source /programs/sbgrid.shrc
113
-</code>
122
+
123
+ source /programs/sbgrid.shrc
124
+
114 125
115 126
(You should get a message like this: )
116
-<file>
127
+```
117 128
Welcome to SBGrid!
129
+
118 130
********************************************************************************
119 131
Your use of the applications contained in the /programs directory constitutes
120 132
acceptance of the terms of the SBGrid License Agreement included in the file
... ...
@@ -122,21 +134,25 @@ source /programs/sbgrid.shrc
122 134
exclusively to member laboratories of the SBGrid Consortium.
123 135
124 136
To hush this license message, run 'touch ~/.agree2sbgrid'.
137
+
125 138
********************************************************************************
126
- Please submit bug reports and help requests to: <bugs@sbgrid.org> or
127
- <http://sbgrid.org/bugs>
139
+ Please submit bug reports and help requests to: `<bugs@sbgrid.org>` or
140
+ `<http://sbgrid.org/bugs>`
128 141
This installation last updated: 20110411
142
+
129 143
********************************************************************************
130 144
Total time to initialize: 1 second(s)
131
-</file>
145
+```
132 146
133 147
* Add a cronjob for the updates. As the 'sbgrid' user on client1:
134
-<code>
135
-echo "0 2 * * * ~/localsync sbgrid@server1" | crontab
136
-</code>
148
+
149
+
150
+ echo "0 2 * * * ~/localsync sbgrid@server1" | crontab
151
+
137 152
* Check the cronjob:
138
-<code>
139
-crontab -l
140
-</code>
141 153
142
-You're done!
... ...
\ No newline at end of file
0
+
1
+ crontab -l
2
+
3
+
4
+You're done!
mailinglist.md
... ...
@@ -1,2 +1,5 @@
1
-====== Mailing List for Site Administrators ======
2
-We have a small mailing list for technical users and site administrators. Visit the [[https://cmcd.hms.harvard.edu/sympa/info/sbgrid-tech|SBGrid-tech mailing list]] page to sign up.
... ...
\ No newline at end of file
0
+## Mailing List for Site Administrators
1
+
2
+We have a small mailing list for technical users and site administrators.
3
+
4
+Visit the [SBGrid-tech mailing list](https///cmcd.hms.harvard.edu/sympa/info/sbgrid-tech) page to sign up.
managing_install.md
... ...
@@ -1,6 +1,7 @@
1
-======HOWTOs: SBGrid Installation Notes======
1
+# HOWTOs: SBGrid Installation Notes
2
+
3
+## Site Configuration
2 4
3
-===== Site Configuration =====
4 5
The SBGrid Software Suite is designed to be installed on a single computer at your site, which will then share that installation with all the workstations on your network via NFS.
5 6
We refer to this computer as the site "master" server.
6 7
... ...
@@ -10,34 +11,40 @@ Click on the following image for a graphic detailing the common configuration of
10 11
11 12
{{howtos:site_diagram.png?250}}
12 13
13
-===== Pre-Installation =====
14
-^ Installation Requirements ^^
15
-|Hard Drive Space|250 GB required|
16
-|Operating System|Linux, OS X and other UNIX|
17
-|Privileges | Root account (Linux) or Administrator account (Mac)|
14
+## Pre-Installation
15
+
16
+ | Installation Requirements |
17
+ | ------------------------- | ----------------------------------------------------|
18
+ | Hard Drive Space | 250 GB required |
19
+ | Operating System | Linux, OS X and other UNIX |
20
+ | Privileges | Root account (Linux) or Administrator account (Mac) |
21
+
22
+Email [accounts@sbgrid.org](accounts@sbgrid.org) to request the installation script for the software. Be sure to include the following information in your email:
18 23
19
-Email [[accounts@sbgrid.org]] to request the installation script for the software. Be sure to include the following information in your email:
20 24
* Lab Name
21 25
* Types of computers on site: Linux, OS X Intel, OS X PowerPC, IRIX
22 26
* The names and email addresses of lab members that will use the software. One user may be designated to receive the majority of our correspondence if you would prefer not to hear from us too often.
23 27
24 28
Once the email has been received and your information has been entered into our system, we will email you a script you will run that will begin the remote installation process. Instructions for running the script will be included in that email, and are reproduced below for reference.
25 29
26
-===== Installation =====
27
- - Create an 'sbgrid' user on the machine that will host your software installation. This should be a normal, unprivileged user account.
28
- - Log in as this 'sbgrid' user.
29
- - Download the installation script from the URL provided in the account creation email.
30
- - Make it executable: <code>chmod +x sbgrid-admin</code>
31
- - Run the script: <code>./sbgrid-admin -i</code>
32
- - The script will walk you through configuring your installation, downloading the software and installing a cron job that will keep the software updated at your site. You will need the **site name** and **install key** provided in the account creation email. The installation may take anywhere from several hours to a day, depending on your network and the number of applications available to your site.
30
+## Installation
31
+
32
+ 1. Create an 'sbgrid' user on the machine that will host your software installation. This should be a normal, unprivileged user account.
33
+ 2. Log in as this 'sbgrid' user.
34
+ 3. Download the installation script from the URL provided in the account creation email.
35
+ 4. Make it executable: `chmod +x sbgrid-admin`
36
+ 5. Run the script: `./sbgrid-admin -i`
37
+ 6. The script will walk you through configuring your installation, downloading the software and installing a cron job that will keep the software updated at your site. You will need the **site name** and **install key** provided in the account creation email. The installation may take anywhere from several hours to a day, depending on your network and the number of applications available to your site.
38
+
39
+## Post-Installation Steps
40
+
41
+ 1. Add a symlink in the root directory of each machine that wants to use the software. The installation script will print the suggested syntax for the command.`ln -s /path/to/sbgrid/installation /programs`
42
+ 2. Any user that wishes to use the software needs to configure their shell to initialize the SBGrid shell environment. For bash and other sh-compliant shells, add the following line to your ~/.bash_profile or ~/.bashrc: `. /programs/sbgrid.shrc` For csh and tcsh, add the following line to your ~/.cshrc: `source /programs/sbgrid.cshrc`
43
+ 3. For some linux distributions, the shipped version of tcsh does not support shell variables longer than 4096 characters. Since the current PATH in our default shell initialization is larger than that, you will need to update tcsh. RPMs for Red Hat 4/5 and CentOS 4/5 are provided at /programs/i386-linux/system/RPMS.
33 44
34
-===== Post-Installation Steps =====
35
- - Add a symlink in the root directory of each machine that wants to use the software. The installation script will print the suggested syntax for the command.<code>ln -s /path/to/sbgrid/installation /programs</code>
36
- - Any user that wishes to use the software needs to configure their shell to initialize the SBGrid shell environment. For bash and other sh-compliant shells, add the following line to your ~/.bash_profile or ~/.bashrc: <code>. /programs/sbgrid.shrc</code> For csh and tcsh, add the following line to your ~/.cshrc: <code>source /programs/sbgrid.cshrc</code>
37
- - For some linux distributions, the shipped version of tcsh does not support shell variables longer than 4096 characters. Since the current PATH in our default shell initialization is larger than that, you will need to update tcsh. RPMs for Red Hat 4/5 and CentOS 4/5 are provided at /programs/i386-linux/system/RPMS.
38 45
46
+## SGI IRIX Software Branch
39 47
40
-===== SGI IRIX Software Branch ======
41
-Since the IRIX software branch is frozen and no longer receiving updates, it is not installed and updated in the same manner as the active software branches. In order to install the IRIX software branch, please run: <code>./sbgrid-admin -s</code>
48
+Since the IRIX software branch is frozen and no longer receiving updates, it is not installed and updated in the same manner as the active software branches. In order to install the IRIX software branch, please run: `./sbgrid-admin -s`
42 49
43
-Note that the IRIX branch is only compatible with //tcsh//; there is no sh-compatible configuration for this branch.
... ...
\ No newline at end of file
0
+Note that the IRIX branch is only compatible with *tcsh*; there is no sh-compatible configuration for this branch.
mirrors.md
... ...
@@ -1,9 +1,6 @@
1
-====== SBGrid Mirrors ======
1
+# SBGrid Mirrors
2 2
3
-For the benefit of the local SBGrid community, we recommend the following to access frequently-used open source software. If you would like for us to add a mirror, please [[help@sbgrid.org|contact us]].
3
+For the benefit of the local SBGrid community, we recommend the following to access frequently-used open source software. If you would like for us to add a mirror, please [contact us](help@sbgrid.org).
4 4
5 5
\\
6 6
7
-^ Mirror Name ^^ Mirror URL ^
8
-|{{:software:centos_icon_60.png?nolink}}|[[http://www.centos.org|CentOS]]| [[http://mirrors.med.harvard.edu/centos/]]|
9
-|{{:software:sl6_logo.jpeg?nolink}}|[[http://www.scientificlinux.org/|Scientific Linux]]| [[http://mirrors.med.harvard.edu/scientificlinux/]]|
... ...
\ No newline at end of file
operatingsystems.md
... ...
@@ -1,38 +1,36 @@
1
-====== Supported Operating Systems ======
2
-The SBGrid Software Suite can run on Linux, OS X and IRIX machines.
1
+## Supported Operating Systems
3 2
4
-Last Update: 2014-02-04
3
+The SBGrid Software Suite can run on Linux, OS X and IRIX machines.
5 4
6
-===== Linux =====
5
+### Linux
7 6
We build and test software under 64-bit Red Hat 6. The majority of our Linux users are using the Red Hat/CentOS/Scientific Linux or Fedora distributions, but we also have labs using the software with Ubuntu, Debian and OpenSuSE. We don't explicitly test the software on these distributions, but it is known to work, and we will work to resolve problems reported by users of these Linux distributions.
8 7
9 8
We officially support the two most recent releases of Red Hat/CentOS/Scientific Linux (currently 6 and 7) and the two most recent releases of Fedora Linux. At this time, only 64-bit versions of linux are fully supported. As of January 2015, we are no longer updating the 32-bit software branch, though we will work to resolve reported problems.
10 9
11 10
Currently Supported:
11
+
12 12
* Red Hat Enterprise Linux 6.x and 7.x and the community supported versions: CentOS and Scientific Linux.
13 13
* Fedora releases actively supported by the Fedora community. Check https://fedoraproject.org/wiki/Releases for the current list.
14
- * We are no longer building software for RHEL 5.x, but compatible applications will remain in the software tree. We will respond to support requests for these and we will resolve problems where possible. RHEL5 users may not receive the latest versions of software, but RHEL5 systems will continue to be functional and supported.
15
-\\
14
+ * We are no longer building software for RHEL 5.x, but compatible applications will remain in the software tree. We will respond to support requests for these and we will resolve problems where possible. RHEL5 users may not receive the latest versions of software, but RHEL5 systems will continue to be functional and supported.
16 15
17
-===== OS X Intel =====
16
+## OS X Intel
18 17
We build and test the programs under the most four most recent OS X releases.
19
-
20 18
Currently Supported:
19
+
21 20
* OS X Intel 10.7 - 10.10
22 21
23
-\\
24 22
25
-===== OS X PowerPC =====
23
+## OS X PowerPC
26 24
The OS X PowerPC branch is currently frozen. The applications are stable and work well on our PowerPC hardware, but they are not being updated.
27 25
28 26
Currently Supported:
27
+
29 28
* OS X PowerPC 10.4 - 10.5
30
-\\
31 29
32
-===== IRIX =====
30
+
31
+## IRIX
33 32
The IRIX programs branch is currently frozen. The applications are stable and work well on our SGI hardware, but they are not being updated.
34 33
35 34
Currently Supported:
36
- * IRIX 6.5.26 + bugfix releases
37 35
38
-\\
... ...
\ No newline at end of file
0
+ * IRIX 6.5.26 + bugfix releases
overrides.md
... ...
@@ -1,69 +1,71 @@
1
-====== Overriding Software Versions ======
1
+# Overriding Software Versions
2 2
3 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 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:
5
+## Display Available Versions
7 6
8
-<code>
9
-$ sbgrid -l ccp4
10
- Version information for: /programs/x86_64-linux/ccp4
7
+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:
11 8
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 9
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
10
+ $ sbgrid -l ccp4
11
+ Version information for: /programs/x86_64-linux/ccp4
22 12
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
13
+ Default version: 6.4.0
14
+ In-use version: 6.4.0
15
+ Other available versions: 6.3.0 6.2.0
16
+ Overrides use this shell variable: CCP4_X
27 17
28
- Version information for: /programs/i386-linux/gnuplot
29 18
30
-Default version: 4.6.0
31
-Other available versions: 4.4.3 4.2.6
32
-Overrides use this shell variable: GNUPLOT_L
19
+Running *sbgrid -L* will print the available versions for the three current platforms (OS X PowerPC and Intel, Linux).
33 20
34
- Version information for: /programs/i386-mac/gnuplot
35 21
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>
22
+ $ sbgrid -L gnuplot
23
+ Version information for: /programs/x86_64-linux/gnuplot
40 24
25
+ Default version: 4.6.4
26
+ In-use version: 4.6.4
27
+ Other available versions: 4.6.0 4.4.3 4.2.6
28
+ Overrides use this shell variable: GNUPLOT_X
29
+
30
+ Version information for: /programs/i386-linux/gnuplot
31
+
32
+ Default version: 4.6.0
33
+ Other available versions: 4.4.3 4.2.6
34
+ Overrides use this shell variable: GNUPLOT_L
35
+
36
+ Version information for: /programs/i386-mac/gnuplot
37
+
38
+ Default version: 4.6.4
39
+ Other available versions: 4.4.3 4.2.6 4.6.0
40
+ Overrides use this shell variable: GNUPLOT_M
41
+
42
+
43
+## Overriding Default Versions
41 44
42
-===== Overriding Default Versions =====
43 45
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 46
45 47
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 48
47
-<code>APPLICATION_X=1.2</code>
49
+`APPLICATION_X=1.2`
48 50
49 51
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 52
51
-|Software Directory|Shorthand Initial|
52
-|i386-linux|_L|
53
-|x86_64-linux|_X|
54
-|i386-mac|_M|
53
+ | Software Directory | Shorthand Initial |
54
+ | ------------------ | ----------------- |
55
+ | i386-linux | _L |
56
+ | x86_64-linux | _X |
57
+ | i386-mac | _M |
55 58
56
-To quickly open the overrides file in your default $EDITOR, you can run //sbgrid-overrides -e//.
59
+To quickly open the overrides file in your default $EDITOR, you can run *sbgrid-overrides -e*.
57 60
58 61
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 62
60 63
The example output below shows CCP4 on linux being changed from the default version:
61 64
62
-<code>
63
- Configuration options in effect for this shell:
64
- Variable Setting Configuration
65
- CCP4_M 6.3.0 personal
66
-</code>
65
+ Configuration options in effect for this shell:
66
+ Variable Setting Configuration
67
+ CCP4_M 6.3.0 personal
68
+
67 69
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
0
+## Disabling a Software Package
1
+To disable a specific software package, set its version to "disable" in your ~/.sbgrid.conf file.
recommended.md
... ...
@@ -1,6 +1,8 @@
1
-====== Recommended Hardware ======
2
-===== Linux Workstations =====
3
-SBGrid's preferred hardware vendor is [[http://thinkmate.com|ThinkMate]] and we have some [[http://www.thinkmate.com/sbgrid|recommended configurations]] for structural biology computing.
1
+# Recommended Hardware
4 2
5
-===== Apple Workstations =====
6
-Any Apple machine can be a capable computer for structural biology. The basic Apple educational discount is available through their online web store, and your institution may have negotiated an even better deal with their Apple representative. SBGrid has several labs that run exclusively on Macs and OS X.
... ...
\ No newline at end of file
0
+## Linux Workstations
1
+SBGrid's preferred hardware vendor is [ThinkMate](http://thinkmate.com) and we have some [recommended configurations](http://www.thinkmate.com/sbgrid) for structural biology computing.
2
+
3
+## Apple Workstations
4
+
5
+Any Apple machine can be a capable computer for structural biology. The basic Apple educational discount is available through their online web store, and your institution may have negotiated an even better deal with their Apple representative. SBGrid has several labs that run exclusively on Macs and OS X.
resources.md
... ...
@@ -1,82 +1,95 @@
1
-====== Development Network ======
1
+# Development Network
2
+
2 3
The basic account is a UNIX shell account accessible via SSH. This network account will let you access designated machines in the developer network. Along with the shell account you also get up to 10 GB of data storage, access to high performance compilers, basic development tools like version control systems (svn, git, etc) and shell text editors.
3 4
4 5
Once you have an account, you can access the developer network by connecting via SSH to:
5
- * developer.sbgrid.org - Scientific Linux 6 x86_64
6
+
7
+* developer.sbgrid.org - Scientific Linux 6 x86_64
6 8
7 9
This machine (internally named sbgrid-dev-architect) is the only external facing host on the network, and it hosts your home directory and acts as the SSH bastion host for the network. From this machine you can SSH to any of the build and test hosts via their hostname in the table below in order to compile software, run tests, etc.
8 10
9 11
The following are the always-on operating system/hardware combinations. They are generally kept at the latest point release:
10 12
11
-^ Hostname ^ Operating System ^ Architecture ^ Notes ^
12
-| sbgrid-c5b | CentOS 5 | x86 | Red Hat 5 compatible, base SBGrid 32-bit Linux build VM |
13
-| sbgrid-c5b-64 | CentOS 5 | x86_64 | Red Hat 5 compatible, base SBGrid 64-bit Linux build VM |
14
-| sbgrid-c5t-64 | CentOS 5 | x86_64 | Red Hat 5 compatible, minimal install for portability testing |
15
-| sbgrid-c6b | CentOS 6 | x86 | Red Hat 6 compatible |
16
-| sbgrid-c6b-64 | CentOS 6 | x86_64 | Red Hat 6 compatible, full build environment |
17
-| sbgrid-c6t-64 | CentOS 6 | x86_64 | Red Hat 6 compatible, minimal install for portability testing |
18
-| sbgrid-dev-vm-07 | Debian 5 | x86 | |
19
-| sbgrid-dev-vm-08 | Debian 5 | x86_64 | |
20
-| sbgrid-dev-vm-16 | Debian 6 | x86 | |
21
-| sbgrid-dev-vm-17 | Debian 6 | x86_64 | |
22
-| sbgrid-dev-vm-03 | Ubuntu 10.10 | x86 | |
23
-| sbgrid-dev-vm-04 | Ubuntu 10.10 | x86_64 |
24
-| sbgrid-dev-vm-14 | OpenSuSE 11.3 | x86 | |
25
-| sbgrid-dev-vm-15 | OpenSuSE 11.3 | x86_64 | |
26
-| sbgrid-m106 | OS X 10.6 | x86/x86_64 | Base SBGrid OS X Intel build machine |
27
-| sbgrid-m107 | OS X 10.7 | x86/x86_64 | |
28
-| sbgrid-m108 | OS X 10.8 | x86/x86_64 | |
29
-| sbgrid-m109 | OS X 10.9 | x86/x86_64 | |
30
-| sbgrid-m1010 | OS X 10.10 | x86/x86_64 | |
31
-| sbgrid-dev-flange | OS X 10.5 | PowerPC | |
13
+ | Hostname | Operating System | Architecture | Notes |
14
+ | -------- | ---------------- | ------------ | ----- |
15
+ | sbgrid-c5b | CentOS 5 | x86 | Red Hat 5 compatible, base SBGrid 32-bit Linux build VM |
16
+ | sbgrid-c5b-64 | CentOS 5 | x86_64 | Red Hat 5 compatible, base SBGrid 64-bit Linux build VM |
17
+ | sbgrid-c5t-64 | CentOS 5 | x86_64 | Red Hat 5 compatible, minimal install for portability testing |
18
+ | sbgrid-c6b | CentOS 6 | x86 | Red Hat 6 compatible |
19
+ | sbgrid-c6b-64 | CentOS 6 | x86_64 | Red Hat 6 compatible, full build environment |
20
+ | sbgrid-c6t-64 | CentOS 6 | x86_64 | Red Hat 6 compatible, minimal install for portability testing |
21
+ | sbgrid-dev-vm-07 | Debian 5 | x86 | |
22
+ | sbgrid-dev-vm-08 | Debian 5 | x86_64 | |
23
+ | sbgrid-dev-vm-16 | Debian 6 | x86 | |
24
+ | sbgrid-dev-vm-17 | Debian 6 | x86_64 | |
25
+ | sbgrid-dev-vm-03 | Ubuntu 10.10 | x86 | |
26
+ | sbgrid-dev-vm-04 | Ubuntu 10.10 | x86_64 |
27
+ | sbgrid-dev-vm-14 | OpenSuSE 11.3 | x86 | |
28
+ | sbgrid-dev-vm-15 | OpenSuSE 11.3 | x86_64 | |
29
+ | sbgrid-m106 | OS X 10.6 | x86/x86_64 | Base SBGrid OS X Intel build machine |
30
+ | sbgrid-m107 | OS X 10.7 | x86/x86_64 | |
31
+ | sbgrid-m108 | OS X 10.8 | x86/x86_64 | |
32
+ | sbgrid-m109 | OS X 10.9 | x86/x86_64 | |
33
+ | sbgrid-m1010 | OS X 10.10 | x86/x86_64 | |
34
+ | sbgrid-dev-flange | OS X 10.5 | PowerPC | |
32 35
33 36
34 37
We have the latest versions of the Intel, Portland and Absoft (PPC) compilers:
35 38
36
- * Intel 12.0, 11.1, 10.1 (ifc, ifort) - any linux host, OS X Intel hosts
37
- * Portland 14.4, 12.6, 10.9, 10.2, 9.0-1 (pgcc, pgf77/90/95) - sbgrid-dev-architect, sbgrid-dev-moose
39
+
40
+* Intel 12.0, 11.1, 10.1 (ifc, ifort) - any linux host, OS X Intel hosts
41
+
42
+* Portland 14.4, 12.6, 10.9, 10.2, 9.0-1 (pgcc, pgf77/90/95) - sbgrid-dev-architect, sbgrid-dev-moose
38 43
39 44
There is a configuration file for sh-compatible shells that will enable the compilers and their environmental settings:
40 45
41
-<code>
42
- $ . /build/conf/buildenv.sh
43
-</code>
46
+
47
+ $ . /build/conf/buildenv.sh
44 48
45
-Then you can use the 'build' function to control your compiler settings:
46 49
47
-<code>
48
-$ build help
49
-build: a shell function for controlling compilers
50
+Then you can use the 'build' function to control your compiler settings:
50 51
51
-Usage: build (help|32|64|list)
52
+
53
+ $ build help
54
+ build: a shell function for controlling compilers
55
+
56
+ Usage: build (help|32|64|list)
57
+
58
+ help This help message
59
+ 32 Configure 32-bit compilers
60
+ 64 Configure 64-bit compilers
61
+ list List available compilers
52 62
53
- help This help message
54
- 32 Configure 32-bit compilers
55
- 64 Configure 64-bit compilers
56
- list List available compilers
57
-</code>
58 63
59 64
Additionally, there are other operating systems available as virtual machines that can be enabled (OpenSuSE, Ubuntu, Fedora, etc), and some additional hardware that can be made available (Sun SPARC, IRIX MIPS, etc) on request.
60 65
61
-Graphical access to the machines may be available through Apple Remote Desktop, VNC or the NoMachine desktop sharing client. Other tools could be made available if necessary as well. The whole thing's a bit of an experiment, really, so email us at <bugs@sbgrid.org>, and we'll see what we can work out.
66
+Graphical access to the machines may be available through Apple Remote Desktop, VNC or the NoMachine desktop sharing client. Other tools could be made available if necessary as well. The whole thing's a bit of an experiment, really, so email us at `<bugs@sbgrid.org>`, and we'll see what we can work out.
67
+
68
+# Request an Account
62 69
63
-====== Request an Account ======
64 70
Thanks for your interest in participating in the SBGrid Developer Network.
65 71
66 72
In order to be eligible for an account, you must have software in the SBGrid software suite or be planning to make your software available through SBGrid. This requirement limits accounts to developers of scientific software used in structural biology and related disciplines.
67 73
68 74
That's the only requirement for new accounts. In return for access to these resources, you must agree to not abuse the resources for:
69
- * sending spam
70
- * cracking our computers or other peoples' computers
71
- * other activity which is illegal in the USA or your country
75
+
76
+* sending spam
77
+
78
+* cracking our computers or other peoples' computers
79
+
80
+* other activity which is illegal in the USA or your country
72 81
73 82
And you agree to take reasonable precautions to maintain the security of your password and account by not sharing this information with other people.
74 83
75 84
On our end, we will:
76
- * take reasonable precautions to maintain the security of the network, accounts and data
77
- * make occasional backups of account data (but don't count on it!)
78
- * attempt to maintain a high availability of the developer resources
85
+
86
+* take reasonable precautions to maintain the security of the network, accounts and data
87
+
88
+* make occasional backups of account data (but don't count on it!)
89
+
90
+* attempt to maintain a high availability of the developer resources
79 91
80 92
We reserve the right to close accounts at any time for any reason.
81 93
82
-Still interested? Great! We want to work with you, so please email <bugs@sbgrid.org> with your account request, and we'll get back to you as soon as possible.
94
+Still interested? Great! We want to work with you, so please email `<bugs@sbgrid.org>` with your account request, and we'll get back to you as soon as possible.
95
+
workstation_setup.md
... ...
@@ -1,88 +1,103 @@
1 1
2
-===== General =====
3
- * You should use a network installation for workstations and servers if at all possible. NFS, SMB and AFP all work for sharing a single installation among multiple machines. The decreased admin overhead, bandwidth and disk savings of sharing a single installation is a significant benefit.
4
-
5
-===== Linux =====
6
- * All Linux machines need installations of a recent version (6.17+) of csh/tcsh. Red Hat Enterprise Linux 6 and other recent distributions usually have an up to date version. There are RPMs for Red Hat/CentOS/Scientific Linux 5.x in the software tree in the architecture specific directories:
7
-<code>
8
-/programs/i386-linux/system/RPMs
9
-/programs/x86_64-linux/system/RPMs
10
-</code>
11
- * SELinux must be disabled.
12
- * 64-bit machines need a number of 32-bit compatibility packages installed **even when using the 64-bit software branch**. This is due to a number of binary-only and legacy packages that are only available as 32-bit applications. Additional fonts for Tcl/Tk, Motif and Xview applications are also encouraged.
2
+## General
3
+
4
+* You should use a network installation for workstations and servers if at all possible. NFS, SMB and AFP all work for sharing a single installation among multiple machines. The decreased admin overhead, bandwidth and disk savings of sharing a single installation is a significant benefit.
5
+
6
+## Linux
7
+
8
+* All Linux machines need installations of a recent version (6.17+) of csh/tcsh. Red Hat Enterprise Linux 6 and other recent distributions usually have an up to date version. There are RPMs for Red Hat/CentOS/Scientific Linux 5.x in the software tree in the architecture specific directories:
9
+
10
+ /programs/i386-linux/system/RPMs
11
+ /programs/x86_64-linux/system/RPMs
12
+
13
+* SELinux must be disabled.
14
+
15
+* 64-bit machines need a number of 32-bit compatibility packages installed **even when using the 64-bit software branch**. This is due to a number of binary-only and legacy packages that are only available as 32-bit applications. Additional fonts for Tcl/Tk, Motif and Xview applications are also encouraged.
13 16
14 17
Packages for RHEL 6, and 7 and compatible machines:
15
-<code>
16
-yum install glibc.i686 libgcc.i686 libX11.i686 libXaw.i686 libXext.i686 ncurses.i686 \
17
- redhat-lsb.i686 xorg-x11-fonts-75dpi xorg-x11-fonts-100dpi xorg-x11-fonts-ISO8859-1-75dpi \
18
- xorg-x11-fonts-ISO8859-1-100dpi xorg-x11-fonts-misc libXScrnSaver
19
-</code>
20 18
21
- * The same 32-bit requirement applies for 64-bit Debian and Ubuntu machines. This is supported via the [[https://wiki.debian.org/Multiarch/HOWTO|Multiarch]] system. You'll need at least the following packages to run most of the software. Please email us if you discover we have left some out.
22
-<code>apt-get install libc6-i386 lsb tcsh gawk libjpeg62 curl libx11-6:i386 libxext6:i386</code>
23 19
24
-===== 3D Stereo on RHEL 7 systems with Gnome 3 =====
20
+ yum install glibc.i686 libgcc.i686 libX11.i686 libXaw.i686 libXext.i686 ncurses.i686 \
21
+ redhat-lsb.i686 xorg-x11-fonts-75dpi xorg-x11-fonts-100dpi xorg-x11-fonts-ISO8859-1-75dpi \
22
+ xorg-x11-fonts-ISO8859-1-100dpi xorg-x11-fonts-misc libXScrnSaver
23
+
24
+
25
+* The same 32-bit requirement applies for 64-bit Debian and Ubuntu machines. This is supported via the [Multiarch](https///wiki.debian.org/Multiarch/HOWTO) system. You'll need at least the following packages to run most of the software. Please email us if you discover we have left some out.
26
+`apt-get install libc6-i386 lsb tcsh gawk libjpeg62 curl libx11-6:i386 libxext6:i386`
27
+
28
+## 3D Stereo on RHEL 7 systems with Gnome 3
25 29
26 30
Nvidia 3D stereo typically requires disabling the Composite extension in X.org. Unfortunately, this extension is required to run Gnome 3 and the gdm login mangager supplied as the default desktop in CentOS and many other linux distributions.
27 31
28
-As of version 337.19 of the nvidia driver, some Quadro configurations can operate with the composite extension enabled, but stereo functionality depends on a stereo-aware composite manager. The Composite manager in CentOS7 Gnome3 is not stereo aware and 3D stereo does not work by default.
32
+As of version 337.19 of the nvidia driver, some Quadro configurations can operate with the composite extension enabled, but stereo functionality depends on a stereo-aware composite manager. The Composite manager in CentOS7 Gnome3 is not stereo aware and 3D stereo does not work by default.
29 33
30
-In order to use 3D stereo on Gnome3 systems, you can switch from Gnome3/gdm to MATE/lightdm.
34
+In order to use 3D stereo on Gnome3 systems, you can switch from Gnome3/gdm to MATE/lightdm.
31 35
The MATE Desktop Environment is the continuation of GNOME 2 which is the default desktop in CentOS 5 and 6.
32 36
33 37
To change to MATE on CentOS7 systems, first, install the Extra Packages for Enterprise Linux (EPEL) repo:
34
-<code>
35
- yum install epel-release
36
-</code>
38
+
39
+
40
+ yum install epel-release
41
+
37 42
38 43
Then install the nvidia drivers from epel
39
-<code>
40
- yum install kmod-nvidia
41
-</code>
44
+
45
+
46
+ yum install kmod-nvidia
47
+
42 48
43 49
You may find you need these packages as well
44
-<code>
45
- yum install mesa-libGLU-9.0.0-4.el7.x86_64 libXScrnSaver-1.2.2-6.1.el7.x86_64
46
-</code>
50
+
51
+
52
+ yum install mesa-libGLU-9.0.0-4.el7.x86_64 libXScrnSaver-1.2.2-6.1.el7.x86_64
53
+
47 54
48 55
Next, install lightdm which doesn't require the composite extension.
49
-<code>
50
- yum install lightdm
51
-</code>
56
+
57
+
58
+ yum install lightdm
59
+
52 60
53 61
From there we do a couple of groupinstalls
54 62
You may have these rpms installed already, but just for good measure
55
-<code>
56
- yum group install "X Window System"
57
-</code>
58
-
59
-then
60
-<code>
61
- yum groupinstall "MATE Desktop"
62
-</code>
63
-
64
-Toggle from gdm to lightdm in systemd using systemctl.
65
-To see what you are using as a 'display manager', check this link
66
- <code>
67
-ls -l /etc/systemd/system/display-manager.service
68
-</code>
69
-
70
-This is likely pointing to gdm and should be changed to point to lightdm.
71
-You can change that with systemctl.
72
-<code>
73
- systemctl disable gdm
74
- systemctl enable lightdm
75
-</code>
63
+
64
+
65
+ yum group install "X Window System"
66
+
67
+
68
+then
69
+
70
+
71
+ yum groupinstall "MATE Desktop"
72
+
73
+
74
+Toggle from gdm to lightdm in systemd using systemctl.
75
+To see what you are using as a 'display manager', check this link
76
+
77
+
78
+ ls -l /etc/systemd/system/display-manager.service
79
+
80
+
81
+This is likely pointing to gdm and should be changed to point to lightdm.
82
+You can change that with systemctl.
83
+
84
+
85
+ systemctl disable gdm
86
+ systemctl enable lightdm
87
+
76 88
77 89
And then this will reload you changes, similar to changing runlevels with sysinitV
78
-<code>
79
- systemctl isolate graphical.target
80
-</code>
90
+
91
+
92
+ systemctl isolate graphical.target
93
+
81 94
82 95
Make sure to select MATE from the drop menu as your graphical before you login.
83
-===== Mac OS X ======
84
- * Prior to OS X 10.8, the stock X11 has better compatibility than the Xquartz development version available from MacOSForge. With the OS X 10.8 release, X11 is no longer included by Apple, and you'll need to install the latest Xquartz version offered on the MacOSForge site to run X11-based applications.
96
+## Mac OS X
97
+
98
+* Prior to OS X 10.8, the stock X11 has better compatibility than the Xquartz development version available from MacOSForge. With the OS X 10.8 release, X11 is no longer included by Apple, and you'll need to install the latest Xquartz version offered on the MacOSForge site to run X11-based applications.
99
+
100
+## Laptops
85 101
86
-===== Laptops ======
87
- * You can create a local installation to take along with you.
88
-http://www.sbgrid.org/wiki/software/laptopinstall
... ...
\ No newline at end of file
0
+* You can create a local installation to take along with you.
1
+http://www.sbgrid.org/wiki/laptopinstall