Cheaha GettingStarted: Difference between revisions

From Cheaha
Jump to navigation Jump to search
(→‎Hardware: edited hardware)
(Update url for new docs site and use consistent text for obsolete reference.)
 
(125 intermediate revisions by 18 users not shown)
Line 1: Line 1:
Cheaha is a cluster computing environment for UAB researchers.Information about the history and future plans for Cheaha is available on the [[cheaha]] page.
The documentation for Cheaha Getting Started has moved.  Please visit https://docs.rc.uab.edu/cheaha/getting_started/ for instructions on getting started with Cheaha.  


== Access (Cluster Account Request) ==
The obsolete content of the original page can be found at [[Obsolete: Cheaha Getting Started]] for historical reference.
 
To request an account on [[Cheaha]], please [mailto:support@vo.uabgrid.uab.edu submit an authorization request to the IT Research Computing staff].  Please include some background information about the work you plan on doing on the cluster and the group you work with, ie. your lab or affiliation.
 
Usage of Cheaha is governed by [http://www.uabgrid.uab.edu/aup UAB's Acceptable Use Policy (AUP)] for computer resources.
 
The official DNS name of Cheaha's frontend machine is ''cheaha.rc.uab.edu''. If you want to refer to the machine as ''cheaha'', you'll have to either add the "rc.uab.edu" to you computer's DNS search path.  On Unix-derived systems (Linux, Mac) you can edit your computers /etc/resolv.conf as follows (you'll need administrator access to edit this file)
<pre>
search rc.uab.edu
</pre>
Or you can customize your SSH configuration to use the short name "cheaha" as a connection name. On systems using OpenSSH you can add the following to your  ~/.ssh/config file
 
<pre>
Host cheaha
Hostname cheaha.rc.uab.edu
</pre>
 
== Login ==
===Overview===
Once your account has been created, you'll receive an email containing your user ID, generally your Blazer ID. Logging into Cheaha requires an SSH client. Most UAB Windows workstations already have an SSH client installed, possibly named '''SSH Secure Shell Client''' or [http://www.chiark.greenend.org.uk/~sgtatham/putty/ PuTTY]. Linux and Mac OS X systems should have an SSH client installed by default.
 
Usage of Cheaha is governed by [http://www.uabgrid.uab.edu/aup UAB's Acceptable Use Policy (AUP)] for computer resources.
 
===Client Configuration===
This section will cover steps to configure Windows, Linux and Mac OS X clients to connect to Cheaha.
====Linux====
Linux systems, regardless of the flavor (RedHat, SuSE, Ubuntu, etc...), should already have an SSH client on the system as part of the default install.
# Start a terminal (on RedHat click Applications -> Accessories -> Terminal, on Ubuntu Ctrl+Alt+T)
# At the prompt, enter the following command to connect to Cheaha ('''Replace blazerid with your Cheaha userid''')
ssh '''blazerid'''@cheaha.rc.uab.edu
 
====Mac OS X====
Mac OS X is a Unix operating system (BSD) and has a built in ssh client.
# Start a terminal (click Finder, type Terminal and double click on Terminal under the Applications category)
# At the prompt, enter the following command to connect to Cheaha ('''Replace blazerid with your Cheaha userid''')
ssh '''blazerid'''@cheaha.rc.uab.edu
 
====Windows====
There are many SSH clients available for Windows, some commercial and some that are free (GPL). This section will cover two clients that are commonly found on UAB Windows systems.
=====MobaXterm=====
[http://mobaxterm.mobatek.net/ MobaXterm] is a free (also available for a price in a Profession version) suite of SSH tools. Of the Windows clients we've used, MobaXterm is the easiest to use and feature complete. [http://mobaxterm.mobatek.net/features.html Features] include (but not limited to):
* SSH client (in a handy web browser like tabbed interface)
* Embedded Cygwin (which allows Windows users to run many Linux commands like grep, rsync, sed)
* Remote file system browser (graphical SFTP)
* X11 forwarding for remotely displaying graphical content from Cheaha
* Installs without requiring Windows Administrator rights
 
Start MobaXterm and click the Session toolbar button (top left). Click SSH for the session type, enter the following information and click OK. Once finished, double click cheaha.uabgrid.uab.edu in the list of Saved sessions under PuTTY sessions:
{| border="1" cellpadding="5"
!Field
!Cheaha Settings
|-
|'''Remote host'''
|cheaha.rc.uab.edu
|-
|'''Port'''
|22
|-
|}
=====PuTTY=====
[http://www.chiark.greenend.org.uk/~sgtatham/putty/ PuTTY] is a free suite of SSH and telnet tools written and maintained by [http://www.pobox.com/~anakin/ Simon Tatham]. PuTTY supports SSH, secure FTP (SFTP), and X forwarding (XTERM) among other tools.
 
* Start PuTTY (Click START -> All Programs -> PuTTY -> PuTTY). The 'PuTTY Configuration' window will open
* Use these settings for each of the clusters that you would like to configure
{| border="1" cellpadding="5"
!Field
!Cheaha Settings
|-
|'''Host Name (or IP address)'''
|cheaha.rc.uab.edu
|-
|'''Port'''
|22
|-
|'''Protocol'''
|SSH
|-
|'''Saved Sessions'''
|cheaha.rc.uab.edu
|-
|}
* Click '''Save''' to save the configuration, repeat the previous steps for the other clusters
* The next time you start PuTTY, simply double click on the cluster name under the 'Saved Sessions' list
 
=====SSH Secure Shell Client=====
SSH Secure Shell is a commercial application that is installed on many Windows workstations on campus and can be configured as follows:
* Start the program (Click START -> All Programs -> SSH Secure Shell -> Secure Shell Client). The 'default - SSH Secure Shell' window will open
* Click File -> Profiles -> Add Profile to open the 'Add Profile' window
* Type in the name of the cluster (for example: cheaha) in the field and click 'Add to Profiles'
* Click File -> Profiles -> Edit Profiles to open the 'Profiles' window
* Single click on your new profile name
* Use these settings for the clusters
{| border="1" cellpadding="5"
!Field
!Cheaha Settings
|-
|'''Host name'''
|cheaha.rc.uab.edu
|-
|'''User name'''
|blazerid (insert your blazerid here)
|-
|'''Port'''
|22
|-
|'''Protocol'''
|SSH
|-
|'''Encryption algorithm'''
|<Default>
|-
|'''MAC algorithm'''
|<Default>
|-
|'''Compression'''
|<None>
|-
|'''Terminal answerback'''
|vt100
|-
|}
* Leave 'Connect through firewall' and 'Request tunnels only' unchecked
* Click '''OK''' to save the configuration, repeat the previous steps for the other clusters
* The next time you start SSH Secure Shell, click 'Profiles' and click the cluster name
 
=== Logging in to Cheaha ===
No matter which client you use to connect to the Cheaha, the first time you connect, the SSH client should display a message asking if you would like to import the hosts public key. Answer '''Yes''' to this question.
 
* Connect to Cheaha using one of the methods listed above
* Answer '''Yes''' to import the cluster's public key
** Enter your BlazerID password
** If you were issued a temporary password, enter it (Passwords are CaSE SensitivE!!!) You should see a message similar to this
You are required to change your password immediately (password aged)
 
WARNING: Your password has expired.
You must change your password now and login again!
Changing password for user joeuser.
Changing password for joeuser
(current) UNIX password:
*** (current) UNIX password: '''Enter your temporary password at this prompt and press enter'''
*** New UNIX password: '''Enter your new strong password and press enter'''
*** Retype new UNIX password: '''Enter your new strong password again and press enter'''
*** After you enter your new password for the second time and press enter, the shell may exit automatically. If it doesn't, type exit and press enter
*** Log in again, this time use your new password
* After successfully logging in for the first tiem, You may see the following message '''just press ENTER for the next three prompts, don't type any passphrases!'''
It doesn't appear that you have set up your ssh key.
This process will make the files:
      /home/joeuser/.ssh/id_rsa.pub
      /home/joeuser/.ssh/id_rsa
      /home/joeuser/.ssh/authorized_keys
Generating public/private rsa key pair.
Enter file in which to save the key (/home/joeuser/.ssh/id_rsa):
** Enter file in which to save the key (/home/joeuser/.ssh/id_rsa):'''Press Enter'''
** Enter passphrase (empty for no passphrase):'''Press Enter'''
** Enter same passphrase again:'''Press Enter'''
Your identification has been saved in /home/joeuser/.ssh/id_rsa.
Your public key has been saved in /home/joeuser/.ssh/id_rsa.pub.
The key fingerprint is:
f6:xx:xx:xx:xx:dd:9a:79:7b:83:xx:f9:d7:a7:d6:27 joeuser@cheaha.uabgrid.uab.edu
 
Congratulations, you should now have a command prompt and be ready to start [[Cheaha2_GettingStarted|Sample_Job_Scripts submitting jobs]]!!!
 
== Hardware ==
[[Image:Research-computing-platform.png|right|thumb|450px|Logical Diagram of Cheaha Configuration]]
 
=== Performance ===
{{CheahaTflops}}
 
=== Hardware ===
 
The Cheaha Compute Platform includes three generations of commodity compute hardware, totaling 868 compute cores, 2.8TB of RAM, and over 200TB of storage.
 
The hardware is grouped into generations designated gen1, gen2, and gen3 (oldest to newest). The following descriptions highlight the hardware profile for each generation.
 
* <strike> Generation 1 (gen1) -- 64 2-CPU AMD 1.6 GHz compute nodes with Gigabit interconnect. This is the original hardware collection purchased with NSF EPSCoR funds in 2005, approx $150K. These nodes are sometimes called the "Verari" nodes. These nodes are tagged as "verari-compute-#-#" in the ROCKS naming convention.</strike> (gen1 was decommissioned in June 2013)
* Generation 2 (gen2) -- 24 2x4 core (196 cores total) Intel 3.0 GHz Intel compute nodes with dual data rate Infiniband interconnect and the initial high-perf storage implementation using 60TB DDN. This is the hardware collection purchased exclusively with the annual VPIT funds allocation, approx $150K/yr for the 2008 and 2009 fiscal years.  These nodes are sometimes confusingly called "cheaha2" or "cheaha" nodes. These nodes are tagged as "cheaha-compute-#-#" in the ROCKS naming convention.
* Generation 3 (gen3) -- 48 2x6 core (576 cores total) 2.66 GHz Intel compute nodes with quad data rate Infiniband, ScaleMP, and the high-perf storage build-out for capacity and redundancy with 120TB DDN. This is the hardware collection purchased with a combination of the NIH SIG funds and some of the 2010 annual VPIT investment. These nodes were given the code name "sipsey" and tagged as such in the node naming for the queue system. These nodes are tagged as "sipsey-compute-#-#" in the ROCKS naming convention. 16 of the gen3 nodes (sipsey-compute-0-1 thru sipsey-compute-0-16) were upgraded in 2014 from 48GB to 96GB of memory per node.
* Generation 4 (gen4) -- 3 16 core (48 cores total) compute nodes. This hardware collection purchase by [http://www.soph.uab.edu/ssg/people/tiwari Hemant Tiwari of SSG]. These nodes were given the code name "ssg" and tagged as such in the node naming for the queue system. These nodes are tagged as "ssg-compute-0-#" in the ROCKS naming convention.
* Generation 6 (gen6) --
** 26 Compute Nodes with two 12 core processors (Intel Xeon E5-2680 v3 2.5GHz) with 256GB DDR4 RAM, FDR InfiniBand and 10GigE network cards
** 14 Compute Nodes with two 12 core processors (Intel Xeon E5-2680 v3 2.5GHz) with 384GB DDR4 RAM, FDR InfiniBand and 10GigE network card
** FDR InfiniBand Switch
** 10Gigabit Ethernet Switch
** Management node and gigabit switch for cluster management
** Bright Advanced Cluster Management software licenses
 
Summarized, Cheaha's compute pool includes:
* gen4 is 48 cores of [http://ark.intel.com/products/64583/Intel-Xeon-Processor-E5-2680-20M-Cache-2_70-GHz-8_00-GTs-Intel-QPI 2.70GHz eight-core Intel Xeon E5-2680 processors] with 24G of RAM per core or 384GB total
* gen3.1 is 192 cores of [http://ark.intel.com/products/47922/Intel-Xeon-Processor-X5650-12M-Cache-2_66-GHz-6_40-GTs-Intel-QPI?q=x5650 2.67GHz six-core Intel Xeon X5650 processors] with 8Gb RAM per core or 96GB total
* gen3 is 384 cores of [http://ark.intel.com/products/47922/Intel-Xeon-Processor-X5650-12M-Cache-2_66-GHz-6_40-GTs-Intel-QPI?q=x5650 2.67GHz six-core Intel Xeon X5650 processors] with 4Gb RAM per core or 48GB total
* gen2 is 192 cores of [http://ark.intel.com/products/33083/Intel-Xeon-Processor-E5450-12M-Cache-3_00-GHz-1333-MHz-FSB 3.0GHz quad-core Intel Xeon E5450 processors] with 2Gb RAM per core
* <strike> gen1 is 100 cores of 1.6GhZ AMD Opteron 242 processors with 1Gb RAM per core </strike> (decomissioned June 2013)
 
{|border="1" cellpadding="2" cellspacing="0"
|+ Physical Nodes
|- bgcolor=grey
!gen!!queue!!#nodes!!cores/node!!RAM/node
|-
|gen6.1|| ?? || 26 || 24 || 256G
|-
|gen6.2|| ?? || 14 || 24 || 384G
|-
|gen5||openstack(?)|| ? || ? || ?G
|-
|gen4||ssg||3||16||385G
|-
|gen3.1||sipsey||16||12||96G
|-
|gen3||sipsey||32||12||48G
|-
|gen2||cheaha||24||8||16G
|}
 
== Cluster Software ==
* Rocks 5.4 (Maverick)
* CentOS 5.9 x86_64
* Grid Engine 6.2u5p2-1
* Condor for Open Science Grid access (coming soon)
 
== Queing System ==
All work on Cheaha must be submitted to our queing system (SGE). A common mistake made by new users is to run 'jobs' on the head node. This section gives a basic overview of what a queuing system is and why we use it.
=== What is a queuing system? ===
* Software that gives users fair allocation of the cluster's resources
* Schedules jobs based using resource requests (the following are commonly requested resources, there are many more that are available)
** Number of processors (often referred to as "slots")
** Maximum memory (RAM) required per slot
** Maximum run time
* Common queuing systems:
** Sun Grid Engine (Also know as SGE, OGE, GE)
** OpenPBS
** Torque
** LSF (load sharing facility)
 
Cheaha uses Sun Grid Engine, which was developed by Sun Microsystems http://gridengine.sunsource.net/ and is open source (SISSL License).
 
=== Typical Workflow ===
* Stage data to $USER_SCRATCH (your scratch directory)
* Research how to run your code in "batch" mode. Batch mode typically means the ability to run it from the command line without requiring any interaction from the user.
* Identify the appropriate resources needed to run the job. The following are mandatory resource requests for all jobs on Cheaha
** Maximum memory (RAM) required per slot
** Maximum runtime
* Write a job script specifying queuing system parameters, resource requests and commands to run program
* Submit script to queuing system (qsub script.job)
* Monitor job (qstat)
* Review the results and resubmit as necessary
* Clean up the scratch directory by moving or deleting the data off of the cluster
 
=== Resource Requests ===
Accurate resource requests are extremely important to the health of the over all cluster. In order for Cheaha to operate properly, the queing system must know how much runtime and RAM each job will need.
==== Mandatory Resource Requests ====
* h_rt - Maximum run time of each job process, also referred to as walltime (example of requesting 2 hours of runtime: #$ -l h_rt=2:00:00)
** For '''Array''' jobs, this represents the maximum run time for each task
** For serial or parallel jobs, this represents the maximum run time for the entire job
* vf - Maximum amount of memory needed for each job slot / processor core (example of requesting 2 GB's of RAM per slot: #$ -l vf=2G)
 
==== Other Common Resource Requests ====
* h_vmem - Some times you won't know how much memory per slot your job will need. Setting this resource request to a upper limit will force the job to close if it exceeds the limit. (example of requesting a hard limit of 3 GB's of RAM per slot: #$ -l h_vmem=3G) This can also be used to prevent an out of control job (memory leak) from crashing the compute node! When requesting h_vmem, set it slightly higher than the vf memory request, for example if your job needs 2.5 GB of RAM per slot, you may want to ensure it terminates if it exceeds 2.8GB (#$ -l h_vmem=2.8G,vf=2.5G)
 
=== Submitting Jobs ===
Jobs are submitted on Cheaha by using the "qsub" command. The full manual for qsub is available by running the following command
man qsub
 
==== Job Script File Format ====
To submit a job to the queuing systems, you will first define your job in a script (a text file) and then submit that script to the queuing system.
 
The script file needs to be '''formatted as a UNIX file''', not a Windows or Mac text file. In geek speak, this means that the end of line (EOL) character should be a line feed (LF) rather than a carriage return line feed (CRLF) for Windows or carriage return (CR) for Mac.
 
If you submit a job script formatted as a Windows or Mac text file, your job will likely fail with misleading messages, for example that the path specified does not exist.
 
Windows '''Notepad''' does not have the ability to save files using the UNIX file format. Do NOT use Notepad to create files intended for use on the clusters. Instead use one of the alternative text editors listed in the following section.
 
===== Converting Files to UNIX Format =====
====== Dos2Unix Method ======
The lines below that begin with $ are commands, the $ represents the command prompt and should not be typed!
 
The dos2unix program can be used to convert Windows text files to UNIX files with a simple command. After you have copied the file to your home directory on the cluster, you can identify that the file is a Windows file by executing the following (Windows uses CR LF as the line terminator, where UNIX uses only LF and Mac uses only CR):
<pre>
$ file testfile.txt
testfile.txt: ASCII text, with CRLF line terminators
</pre>
 
Now, convert the file to UNIX
<pre>
$ dos2unix testfile.txt
dos2unix: converting file testfile.txt to UNIX format ...
</pre>
 
Verify the conversion using the file command
<pre>
$ file testfile.txt
testfile.txt: ASCII text
</pre>
 
====== Alternative Windows Text Editors ======
There are many good text editors available for Windows that have the capability to save files using the UNIX file format. Here are a few:
* [[http://www.geany.org/ Geany]] is an excellent free text editor for Windows and Linux that supports Windows, UNIX and Mac file formats, syntax highlighting and many programming features. To convert from Windows to UNIX click '''Document''' click '''Set Line Endings''' and then '''Convert and Set to LF (Unix)'''
* [[http://notepad-plus.sourceforge.net/uk/site.htm Notepad++]] is a great free Windows text editor that supports Windows, UNIX and Mac file formats, syntax highlighting and many programming features. To convert from Windows to UNIX click '''Format''' and then click '''Convert to UNIX Format'''
* [[http://www.textpad.com/ TextPad]] is another excellent Windows text editor. TextPad is not free, however.
 
=== Interactive Resources ===
 
After you login to Cheaha the command-line interface that you see is running on the head node.  Most of your light interactive prep-work to submit a compute job to the scheduler can be carried out on this head node.  If you have a heavier workload to prepare for a batch job (eg. compiling code or other manipulations of data) or your compute application requires interactive control, you should request a dedicated interactive node for this work.
 
Interactive resources are requested by submitting an "interactive" job to the scheduler.  Interactive jobs will provide you a command line on a compute resource that you can use just like you would the command line on the head node.  The difference is that the scheduler has dedicated the requested resources to your job and you can run your interactive commands without having to worry about impacting other users on the head node.
 
Interactive jobs are requested with the qlogin command (please use your correct email address in place of the ''$USER@uab.edu'' string if you do not have an @uab.edu email address):
<pre>
qlogin -l h_rt=1:00:00,vf=1G -m b -M $USER@uab.edu
</pre>
 
This command requests 1 compute core with 1Gb of RAM for 1 hour.  The command will wait until the resource is reserved by the scheduler and send you an email when the resource is available.  The email alert can be useful during periods of heavy cluster demand when interactive resources reservations may have significant wait times. 
 
More advanced interactive scenarios to support graphical applications are available using [[Setting_Up_VNC_Session|VNC]].
 
Alternatively, you can use the qrsh program to run a specific command on an interactive node.  For example, the following command will run the `ls` command on an interactive node rather than the cluster head node:
<pre>
qrsh -l h_rt=1:00:00,vf=1G -m b -M $USER@uab.edu -now no ls
</pre>
More interesting uses of the above scenario might be to offload a software compile from the head node onto an interactive node.
 
== Storage ==
 
=== No Automatic Backups ===
 
There is no automatic back up of any data on the cluster (home, scratch, or whatever).  All data back up is managed by you.  If you aren't managing a data back up process, then you have no backup data.
 
=== Home directories ===
 
Your home directory on Cheaha is NFS-mounted to the compute nodes as /home/$USER or $HOME. It is acceptable to use your home directory a location to store job scripts, custom code, libraries, job scripts.
 
'''The home directory must not be used to store large amounts of data.''' Please use $USER_SCRATCH
for actively used data sets or request shared scratch space for shared data sets.
 
=== Scratch ===
Research Computing policy requires that all bulky input and output must be located on the scratch space. The home directory is intended to store your job scripts, log files, libraries and other supporting files.
 
'''Important Information:'''
* Scratch space (network and local) '''is not backed up'''.
* Research Computing expects each user to keep their scratch areas clean. The cluster scratch area are not to be used for archiving data.
 
Cheaha has two types of scratch space, network mounted and local.
* Network scratch ($USER_SCRATCH) is available on the head node and each compute node. This storage is a Lustre high performance file system providing roughly 240TB of storage. This should be your jobs primary working directory, unless the job would benefit from local scratch (see below).
* Local scratch is physically located on each compute node and is not accessible to the other nodes (including the head node). This space is useful if the job performs a lot of file I/O. Most of the jobs that run on our clusters do not fall into this category. Because the local scratch is inaccessible outside the job, it is important to note that you must move any data between local scratch to your network accessible scratch within your job. For example, step 1 in the job could be to copy the input from $USER_SCRATCH to ${USER_SCRATCH}, step 2 code execution, step 3 move the data back to $USER_SCRATCH.
 
==== Network Scratch ====
Network scratch is available using the environment variable $USER_SCRATCH or directly by /scratch/user/${USER}
 
It is advisable to use the environment variable whenever possible rather than the hard coded path.
 
==== Local Scratch ====
Each compute node has a local scratch directory that is accessible via the scheduler variable '''$TMPDIR'''. If your job performs a lot of file I/O, the job should use $TMPDIR rather than  $USER_SCRATCH to prevent bogging down the network scratch fil system. The amount of scratch space available on each compute node is approximately 40GB.
 
The $TMPDIR is a special temporary directory created by the scheduler uniq for the job. It's important to note that this directory is deleted when the job completes, so the job script has to move the results to $USER_SCRATCH or other location prior to the job exiting.
 
Note that $TMPDIR is only useful for jobs in which all processes run on the same compute node, so MPI jobs are not candidates for this solution.
 
The following is an array job example that uses $TMPDIR by transferring the inputs into $TMPDIR at the beginning of the script and the result out of $TMPDIR at the end of the script.
 
<pre>
#!/bin/bash
#$ -S /bin/bash
#$ -cwd
#
#$ -N local_scratch_example
#$ -pe smp 1
#$ -t 1-1000
# Maximum Job Runtime (ex: 20 minutes)
#$ -l h_rt=00:20:00
# Maximum memory needed per slot (ex: 2 GB)
#$ -l vf=2G
#
#$ -j y
#
#$ -M YOUR_EMAIL_ADDRESS
#$ -m eas
#
 
# Load modules if necessary
source /etc/profile.d/modules.sh
module load R/R-2.9.0
 
echo "TMPDIR: $TMPDIR"
 
cd $TMPDIR
# Create a working directory under the special scheduler local scratch directory
# using the array job's taskID
mdkir $SGE_TASK_ID
cd $SGE_TASK_ID
 
# Next copy the input data to the local scratch
echo "Copying input data from network scratch to $TMPDIR/$SGE_TASK_ID - $(date)
# The input data in this case has a numerical file extension that
# matches $SGE_TASK_ID
cp -a $USER_SCRATCH/GeneData/INP*.$SGE_TASK_ID ./
echo "copied input data from network scratch to $TMPDIR/$SGE_TASK_ID - $(date)
 
someapp -S 1 -D 10 -i INP*.$SGE_TASK_ID -o geneapp.out.$SGE_TASK_ID
 
# Lastly copy the results back to network scratch
echo "Copying results from local $TMPDIR/$SGE_TASK_ID to network - $(date)
cp -a geneapp.out.$SGE_TASK_ID $USER_SCRATCH/GeneData/
echo "Copied results from local $TMPDIR/$SGE_TASK_ID to network - $(date)
 
</pre>
 
=== Project Storage ===
Cheaha has a location where shared data can be stored called $SHARE_SCRATCH . As with user scratch, this area '''is not backed up'''!
 
This is helpful if a team of researchers must access the same data. Please open a help desk ticket to request a project directory under $SHARE_SCRATCH.
 
=== Uploading Data ===
 
Data can be moved onto the cluster (pushed) from a remote client (ie. you desktop) via SCP or SFTP.  Data can also be downloaded to the cluster (pulled) by issuing transfer commands once you are logged into the cluster. Common transfer methods are `wget <URL>`, FTP, or SCP, and depend on how the data is made available from the data provider.
 
Large data sets should be staged directly to your $USER_SCRATCH directory so as not to fill up $HOME.  If you are working on a data set shared with multiple users, it's preferable to request space in $SHARE_SCRATCH rather than duplicating the data for each user.
 
== Environment Modules ==
[http://modules.sourceforge.net/ Environment Modules] is installed on Cheaha and should be used when constructing your job scripts if an applicable module file exists. Using the module command you can easily configure your environment for specific software packages without having to know the specific environment variables and values to set. Modules allows you to dynamically configure your environment without having to logout / login for the changes to take affect.
 
If you find that specific software does not have a module, please submit a [http://etlab.eng.uab.edu/ helpdesk ticket] to request the module.
 
'''Note:''' If you are using LAM MPI for parallel jobs, you must load the LAM module in both your job script and your profile. For example, assume we want to use LAM-MPI compiled for GNU:
 
* for BASH users add this to your ~/.bashrc and your job script, or for CSH users add this to your ~/.cshrc and your job script
<pre>
module load lammpi/lam-7.1-gnu
</pre>
 
* Cheaha supports bash completion for the module command. For example, type 'module' and press the TAB key twice to see a list of options:
<pre>
module TAB TAB
 
add          display      initlist    keyword      refresh      switch      use         
apropos      help        initprepend  list        rm          unload      whatis     
avail        initadd      initrm      load        show        unuse       
clear        initclear    initswitch  purge        swap        update
</pre>
 
* To see the list of available modulefiles on the cluster, run the '''module avail''' command (note the example list below may not be complete!) or '''module load ''' followed by two tab key presses:
<pre>
module avail
R/R-2.11.1                      cufflinks/cufflinks-0.9        intel/intel-compilers          mvapich-intel                  rna_pipeline/rna_pipeline-0.31
R/R-2.6.2                      eigenstrat/eigenstrat          jags/jags-1.0-gnu              mvapich2-gnu                    rna_pipeline/rna_pipeline-0.5.0
R/R-2.7.2                      eigenstrat/eigenstrat-2.0      lammpi/lam-7.1-gnu              namd/namd-2.6                  s.a.g.e./sage-6.0
R/R-2.8.1                      ent/ent-1.0.2                  lammpi/lam-7.1-intel            namd/namd-2.7                  samtools/samtools
R/R-2.9.0                      fastphase/fastphase-1.4        mach/mach                      openmpi/openmpi-1.2-gnu        samtools/samtools-0.1
R/R-2.9.2                      fftw/fftw3-gnu                  macs/macs                      openmpi/openmpi-1.2-intel      shrimp/shrimp-1.2
RAxML/RAxML-7.2.6              fftw/fftw3-intel                macs/macs-1.3.6                openmpi/openmpi-gnu            shrimp/shrimp-1.3
VEGAS/VEGAS-0.8                freesurfer/freesurfer-4.5      maq/maq-0.7                    openmpi/openmpi-intel          spparks/spparks
amber/amber-10.0-intel          fregene/fregene-2008            marthlab/gigabayes              openmpi-gnu                    structure/structure-2.2
amber/amber-11-intel            fsl/fsl-4.1.6                  marthlab/mosaik                openmpi-intel                  tau/tau
apbs/apbs-1.0                  genn/genn                      marthlab/pyrobayes              paraview/paraview-3.4          tau/tau-2.18.2p2
atlas/atlas                    gromacs/gromacs-4-gnu          mathworks/R2009a                paraview/paraview-3.6          tau/tau-lam-intel
birdsuite/birdsuite-1.5.3      gromacs/gromacs-4-intel        mathworks/R2009b                pdt/pdt                        tophat/tophat
birdsuite/birdsuite-1.5.5      hapgen/hapgen                  mathworks/R2010a                pdt/pdt-3.14                    tophat/tophat-1.0.8
bowtie/bowtie                  hapgen/hapgen-1.3.0            mpich/mpich-1.2-gnu            phase/phase                    tophat/tophat-1.1
bowtie/bowtie-0.10              haskell/ghc                    mpich/mpich-1.2-intel          plink/plink                    vmd/vmd
bowtie/bowtie-0.12              illuminus/illuminus            mpich/mpich2-gnu                plink/plink-1.05                vmd/vmd-1.8.6
bowtie/bowtie-0.9              impute/impute                  mrbayes/mrbayes-gnu            plink/plink-1.06
chase                          impute/impute-2.0.3            mrbayes/mrbayes-intel          plink/plink-1.07
cufflinks/cufflinks            impute/impute-2.1.0            mvapich-gnu                    python/python-2.6
 
</pre>
 
Some software packages have multiple module files, for example:
* plink/plink
* plink/plink-1.05
* plink/plink-1.06
 
In this case, the plink/plink module will always load the latest version, so loading this module is equivalent to loading plink/plink-1.06. If you always want to use the latest version, use this approach. If you want use a specific version, use the module file containing the appropriate version number.
 
Some modules, when loaded, will actually load other modules. For example, the ''gromacs/gromacs-4-intel'' module will also load ''openmpi/openmpi-intel'' and ''fftw/fftw3-intel''.
 
* To load a module, ex: for a Gromacs job, use the following '''module load''' command in your job script:
<pre>
module load gromacs/gromacs-4-intel
</pre>
 
* To see a list of the modules that you currently have loaded use the '''module list''' command
<pre>
module list
Currently Loaded Modulefiles:
1) fftw/fftw3-intel            2) openmpi/openmpi-intel  3) gromacs/gromacs-4-intel
</pre>
 
* A module can be removed from your environment by using the '''module unload''' command:
<pre>
module unload gromacs/gromacs-4-intel
 
module list
 
No Modulefiles Currently Loaded.
</pre>
 
* The definition of a module can also be viewed using the '''module show''' command, revealing what a specific module will do to your environment:
<pre>
module show gromacs/gromacs-4-intel
 
-------------------------------------------------------------------
/etc/modulefiles/gromacs/gromacs-4-intel:
 
module-whatis Sets up gromacs-intel v4.0.2 in your enviornment
module load fftw/fftw3-intel
module load openmpi/openmpi-intel
prepend-path PATH /opt/uabeng/gromacs/intel/4/bin/
prepend-path LD_LIBRARY_PATH /opt/uabeng/gromacs/intel/4/lib
prepend-path MANPATH /opt/uabeng/gromacs/intel/4/man
-------------------------------------------------------------------
</pre>
 
=== Error Using Modules from a Job Script ===
 
If you are using modules and the command your job executes runs fine from the command line but fails when you run it from the job, you may be having an issue with the script initialization.  If you see this error in your job error output file
<pre>
-bash: module: line 1: syntax error: unexpected end of file
-bash: error importing function definition for `BASH_FUNC_module'
</pre>
Add the command `unset module` before calling your module files.  The -V job argument will cause a conflict with the module function used in your script.
 
== Sample Job Scripts ==
The following are sample job scripts, please be careful to edit these for your environment (i.e. replace <font color="red">YOUR_EMAIL_ADDRESS</font> with your real email address), set the h_rt to an appropriate runtime limit and modify the job name and any other parameters.
 
'''Hello World''' is the classic example used throughout programming. We don't want to buck the system, so we'll use it as well to demonstrate jobs submission with one minor variation: our hello world will send us a greeting using the name of whatever machine it runs on. For example, when run on the Cheaha head node, it would print "Hello from cheaha.uabgrid.uab.edu".
 
=== Hello World (serial) ===
 
A serial job is one that can run independently of other commands, ie. it doesn't depend on the data from other jobs running simultaneously.  You can run many serial jobs in any order.  This is a common solution to processing lots of data when each command works on a single piece of data.  For example, running the same conversion on 100's of images.
 
Here we show how to create job script for one simple command.  Running more than one command just requires submitting more jobs.
 
* Create your hello world application.  Run this command to create a script, turn it into to a command, and run the command (just copy and past the following on to the command line).
<pre>
cat > helloworld.sh << EOF
echo Hello from `hostname`
EOF
chmod +x helloworld.sh
./helloworld.sh
</pre>
 
* Create the Grid Engine job script that will request 1 cpu slots and a maximum runtime of 10 minutes
<pre>
$ vi helloworld.job
</pre>
<pre>
#!/bin/bash
#
# Define the shell used by your compute job
#
#$ -S /bin/bash
#
# Tell the cluster to run in the current directory from where you submit the job
#
#$ -cwd
#
# Name your job to make it easier for you to track
#
#$ -N HelloWorld_serial
#
# Tell the scheduler only need 10 minutes
#
#$ -l h_rt=00:10:00,s_rt=0:08:00,vf=256M
#
# Set your email address and request notification when you job is complete or if it fails
#
#$ -M YOUR_EMAIL_ADDRESS
#$ -m eas
#
#
# Load the appropriate module files
#
# (no module is needed for this example, normally an appropriate module load command appears here)
#
# Tell the scheduler to use the environment from your current shell
#
#$ -V
 
./helloworld.sh
</pre>
* Submit the job to Grid Engine and check the status using qstat
<pre>
$ qsub helloworld.job
 
Your job 11613 ("HelloWorld") has been submitted
 
$ qstat -u $USER
 
job-ID  prior  name      user        state submit/start at    queue                          slots ja-task-ID
-----------------------------------------------------------------------------------------------------------------
  11613 8.79717 HelloWorld jsmith      r    03/13/2009 09:24:35 all.q@compute-0-3.local            1       
</pre>
* When the job completes, you should have output files named HelloWorld.o* and HelloWorld.e* (replace the asterisk with the job ID, example HelloWorld.o11613). The .o file is the standard output from the job and .e will contain any errors.
<pre>
$ cat HelloWorld.o11613
Hello World!
</pre>
 
=== Hello World (parallel with MPI) ===
 
MPI is used to coordinate the activity of many computations occurring in parallel.  It is commonly used in simulation software for molecular dynamics, fluid dynamics, and similar domains where there is significant communication (data) exchanged between cooperating process.
 
Here is a simple parallel Grid Engine job script for running commands the rely on MPI. This example also includes the example of compiling the code and submitting the job script to the Grid Engine.
 
* First, create a directory for the Hello World jobs
<pre>
$ mkdir -p ~/jobs/helloworld
$ cd ~/jobs/helloworld
</pre>
* Create the Hello World code written in C (this example of MPI enabled Hello World includes a 3 minute sleep to ensure the job runs for several minutes, a normal hello world example would run in a matter of seconds).
<pre>
$ vi helloworld-mpi.c
</pre>
<pre>
#include <stdio.h>
#include <mpi.h>
 
main(int argc, char **argv)
{
  int node;
 
  int i, j;
  float f;
 
  MPI_Init(&argc,&argv);
  MPI_Comm_rank(MPI_COMM_WORLD, &node);
 
  printf("Hello World from Node %d.\n", node);
  sleep(180);
  for (j=0; j<=100000; j++)
      for(i=0; i<=100000; i++)
          f=i*2.718281828*i+i+i*3.141592654;
 
  MPI_Finalize();
}
</pre>
* Compile the code, first purging any modules you may have loaded followed by loading the module for OpenMPI GNU. The mpicc command will compile the code and produce a binary named helloworld_gnu_openmpi
<pre>
$ module purge
$ module load openmpi/openmpi-gnu
 
$ mpicc helloworld-mpi.c -o helloworld_gnu_openmpi
</pre>
* Create the Grid Engine job script that will request 8 cpu slots and a maximum runtime of 10 minutes
<pre>
$ vi helloworld.job
</pre>
<pre>
#$ -S /bin/bash
#$ -cwd
#
#$ -N HelloWorld
#$ -pe openmpi 8
#$ -l h_rt=00:10:00,s_rt=0:08:00,vf=1G
#$ -j y
#
#$ -M YOUR_EMAIL_ADDRESS
#$ -m eas
#
# Load the appropriate module files
module load openmpi/openmpi-gnu
#$ -V
 
mpirun -np $NSLOTS helloworld_gnu_openmpi
</pre>
* Submit the job to Grid Engine and check the status using qstat
<pre>
$ qsub helloworld.job
 
Your job 11613 ("HelloWorld") has been submitted
 
$ qstat -u $USER
 
job-ID  prior  name      user        state submit/start at    queue                          slots ja-task-ID
-----------------------------------------------------------------------------------------------------------------
  11613 8.79717 HelloWorld jsmith      r    03/13/2009 09:24:35 all.q@compute-0-3.local            8       
</pre>
* When the job completes, you should have output files named HelloWorld.o* and HelloWorld.po* (replace the asterisk with the job ID, example HelloWorld.o11613). The .o file is the standard output from the job and .po will contain any errors.
<pre>
$ cat HelloWorld.o11613
 
Hello world! I'm 0 of 8 on compute-0-3.local
Hello world! I'm 1 of 8 on compute-0-3.local
Hello world! I'm 4 of 8 on compute-0-3.local
Hello world! I'm 6 of 8 on compute-0-6.local
Hello world! I'm 5 of 8 on compute-0-3.local
Hello world! I'm 7 of 8 on compute-0-6.local
Hello world! I'm 2 of 8 on compute-0-3.local
Hello world! I'm 3 of 8 on compute-0-3.local
 
</pre>
 
=== Hello World (mini-cluster environment) ===
 
You may have a computing problem that needs several computers at the same time but it isn't an MPI based solution.  In other words, sometimes you just need a cluster to run your work on because you have tasks that run on different computers. SGE and OpenMPI make it easy to reserve your own cluster.
 
This example illustrates how to set up the request for your mini-cluster. 
 
We start by making a slight modification to our submit script to request more than one computer at a time and then run our serial command on sever machines at the same time.  This example basically takes the qsub script from the MPI example and executes the helloworld.sh command using mpirun.  mpirun is actually a utility that helps you start processes on different computers and provides information that you command can use if it is compiled with MPI libraries.  In this example, we are just using it as a tool to control the cluster we just requested.  Think of mpirun as a subscheduler that controls the mini-cluster you requested via SGE.
 
Edit the qsub script from the MPI example above to call your helloworld.sh script instead of the MPI-based helloworld we built above.  Change the mpirun line in the qsub:
 
mpirun -np $NSLOTS helloworld_gnu_openmpi
 
to the following
 
mpirun -np $NSLOTS hostname
 
Once you've made this change you can run your qsub again and this time you'll see output from helloworld.sh as it was run on each node in your mini-cluster.
 
<pre>
$ qsub helloworld.job
Your job 8143408 ("HelloWorld") has been submitted
 
$ qstat
job-ID  prior  name      user        state submit/start at    queue                          slots ja-task-ID
----------------------------------------------------------------------------------------------------------------
8143408 0.00000 HelloWorld jpr          qw    09/16/2011 11:02:01                                    8       
</pre>
 
If you want to change the size of your cluster, just specify a different size on the command line when you submit the job via qsub.  Command line arguments to qsub override the settings inside you qsub script.
 
$ qsub -pe openmpi 2
 
Typically, if you are requesting your own mini-cluster you are usually not interested in running the exact same command on each node in your cluster. You could use the regular serial commands for that. Ordinarily, you will want to start different commands on different parts of your cluster, like you would in the [[Hadoop|Hadoop example]].
 
=== Hello World (serial) -- revisited ===
 
The job submit scripts (qsub scripts) are actually bash shell scripts in their own right.  The reason for using the funky #$ prefix in the scripts is so that bash interprets any such line as a comment and won't execute it. Because the # character starts a comment in bash, we can weave the  scheduler directives (the #$ lines) into standard bash scripts.  This lets us build scripts that we can execute locally and then easily run the same script to on a cluster node by calling it with qsub. This can be used to our advantage to create a more fluid experience moving between development and production job runs.
 
The following example is a simple variation on the serial job above.  All we will do is convert our qsub script into a command called helloworld that calls the helloworld.sh command.
 
If the first line of a file is #!/bin/bash and that file is executable, the shell will automatically run the command as if were any other system command, eg. ls.  That is, the ".sh" extension on our HelloWorld.sh script is completely optional and is only meaningful to the user.
 
Copy the serial helloworld.job script to a new file, add a the special #!/bin/bash as the first line, and make it executable with the following command (note: those are single quotes in the echo command):
<pre>
echo '#!/bin/bash' | cat helloworld.job > helloworld ; chmod +x helloworld
</pre>
 
Our qsub script has now become a regular command. We can now execute the command with the simple prefix "./helloworld", which means "execute this file in the current directory":
<pre>
./helloworld
Hello from cheaha.uabgrid.uab.edu
</pre>
Or if we want to run the command on a compute node, replace the "./" prefix with "qsub ":
<pre>
$ qsub helloworld
Your job 8143171 ("HelloWorld_serial") has been submitted
</pre>
And when the cluster run is complete you can look at the content of the output:
<pre>
$ cat HelloWorld_serial.o8143171
Hello from sipsey-compute-0-5.local
</pre>
 
You can use this approach of treating you qsub files as command wrappers to build a collection of commands that can be executed locally or via qsub.  The other examples can be restructured similarly.
 
To avoid having to use the "./" prefix, just add the current directory to your PATH. Also, if you plan to do heavy development using this feature on the cluster, please be sure to run qrsh first so you don't load the head node with our development work.
 
=== Gromacs ===
<pre>
#!/bin/bash
#$ -S /bin/bash
#
# Request the maximum runtime for the job
#$ -l h_rt=2:00:00,s_rt=1:55:00
#
# Request the maximum memory needed for each slot / processor core
#$ -l vf=256M
#
# Send mail only when the job ends
#$ -m e
#
# Execute from the current working directory
#$ -cwd
#
#$ -j y
#
# Job Name and email
#$ -N G-4CPU-intel
#$ -M YOUR_EMAIL_ADDRESS
#
# Use OpenMPI parallel environment and 4 slots
#$ -pe openmpi* 4
#
# Load the appropriate module(s)
. /etc/profile.d/modules.sh
module load gromacs/gromacs-4-intel
#
#$ -V
#
 
# Change directory to the job working directory if not already there
cd ${USER_SCRATCH}/jobs/gromacs
 
# Single precision
MDRUN=mdrun_mpi
 
# The $NSLOTS variable is set automatically by SGE to match the number of
# slots requests
export MYFILE=production-Npt-323K_${NSLOTS}CPU
 
mpirun -np $NSLOTS $MDRUN -v -np $NSLOTS -s $MYFILE -o $MYFILE -c $MYFILE -x $MYFILE -e $MYFILE -g ${MYFILE}.log
 
</pre>
 
=== R ===
If you are using LAM MPI for parallel jobs, you must add the following two lines to your ~/.bashrc or ~/.cshrc file.
 
<pre>
module load lammpi/lam-7.1-gnu
</pre>
 
The following is an example job script that will use an array of 1000 tasks (-t 1-1000), each task has a max runtime of 2 hours and will use no more than 256 MB of RAM per task (h_rt=2:00:00,vf=256M)
 
The array is also throttled to only run 32 concurrent tasks at any time (-tc 32), this feature is not available on coosa.
 
More R examples are available here: [[R-userinfo|Running R Jobs on a Rocks Cluster]]
 
Create a working directory and the job submission script
<pre>
$ mkdir -p ~/jobs/ArrayExample
$ cd ~/jobs/ArrayExample
$ vi R-example-array.job
</pre>
 
<pre>
#!/bin/bash
#$ -S /bin/bash
#
# Request the maximum runtime for the job
#$ -l h_rt=2:00:00,s_rt=1:55:00
#
# Request the maximum memory needed for each slot / processor core
#$ -l vf=256M
#
#$ -M YOUR_EMAIL_ADDRESS
# Email me only when tasks abort, use '#$ -m n' to disable all email for this job
#$ -m a
#$ -cwd
#$ -j y
#
# Job Name
#$ -N ArrayExample
#
#$ -t 1-1000
#$ -tc 32
#
#$ -e $HOME/negcon/rep$TASK_ID/$JOB_NAME.e$JOB_ID.$TASK_ID
#$ -o $HOME/negcon/rep$TASK_ID/$JOB_NAME.o$JOB_ID.$TASK_ID
 
. /etc/profile.d/modules.sh
module load R/R-2.9.0
 
#$ -v PATH,R_HOME,R_LIBS,LD_LIBRARY_PATH,CWD
 
cd ~/jobs/ArrayExample/rep$SGE_TASK_ID
R CMD BATCH rscript.R
</pre>
 
Submit the job to the Grid Engine and check the status of the job using the qstat command
<pre>
$ qsub R-example-array.job
$ qstat
 
</pre>
 
== Installed Software ==
 
A partial list of installed software with additional instructions for their use is available on the [[Cheaha Software]] page.

Latest revision as of 20:12, 31 August 2022

The documentation for Cheaha Getting Started has moved. Please visit https://docs.rc.uab.edu/cheaha/getting_started/ for instructions on getting started with Cheaha.

The obsolete content of the original page can be found at Obsolete: Cheaha Getting Started for historical reference.

Retrieved from "https://docs.uabgrid.uab.edu/w/index.php?title=Cheaha_GettingStarted&oldid=6226"