[Swift-commit] r6235 - trunk/docs/cookbook

[ketan at ci.uchicago.edu]

Author: ketan
Date: 2013-02-05 09:10:54 -0600 (Tue, 05 Feb 2013)
New Revision: 6235

Modified:
   trunk/docs/cookbook/infrastructures
   trunk/docs/cookbook/overview
Log:
cookbook update and polish

Modified: trunk/docs/cookbook/infrastructures
===================================================================
--- trunk/docs/cookbook/infrastructures	2013-02-04 19:37:36 UTC (rev 6234)
+++ trunk/docs/cookbook/infrastructures	2013-02-05 15:10:54 UTC (rev 6235)
@@ -3,30 +3,44 @@
 
 Beagle
 ~~~~~~
-Swift is available on Beagle as a software module.
-In this recipe, we will walk you through a very simple example running Swift
-on Beagle. The prerequisites required for running this example on Beagle is an access to Beagle and a project allocation. The example is a simplest form of a real application that involves reading from a disc file and writing onto another disc file. It runs the +/bin/cat+ Unix command to read an input file called +data.txt+ and write it to an output file in a folder +outdir+, called +f.nnn.out+.
+Beagle is a University of Chicago's Computational Institute super computer
+dedicated to bioinformatics research. It is a cray XE6 machine running PBS job
+scheduler. More on Beagle could be found
+link:https://beagle.ci.uchicago.edu[here].
 
+Swift is available on Beagle as a software module. This recipe will walk you
+through a very simple example running Swift on Beagle. The prerequisites for
+running this example on Beagle is an access to and a project allocation on
+Beagle. The example is a simplest form of a real application which involves
+reading from a disc file and writing onto another disc file. It runs the
++/bin/cat+ Unix command to read an input file called +data.txt+ and write it to
+an output file in a folder +outdir+, called +f.nnn.out+.
+
 image::figures/catsn.png[Swift Example]
 
 The steps are as follows:
 
-*step 1.* Load the Swift module on Beagle commandline as follows: +$ module load swift+
+*step 1.* Load the Swift module on Beagle commandline as follows: +$ module
+load swift+
 
-*step 2.* Create and change to a directory where your Swift related work (source, inputs, outputs) will
-stay. (say, +$ mkdir swift-lab+, followed by, +$ cd swift-lab+)
+*step 2.* Create and change to a directory where your Swift related work
+(source, inputs, outputs) will stay. (say, +$ mkdir swift-lab+, followed by, +$
+cd swift-lab+)
 
-*step 3.* copy the folder at +/home/ketan/labs/catsn+ to the above directory. (+$cp -r /home/ketan/catsn .+ followed by +$ cd catsn+).
+*step 3.* copy the folder at +/home/ketan/labs/catsn+ to the above directory.
+(+$cp -r /home/ketan/catsn .+ followed by +$ cd catsn+).
 
-*step 4.*  In the sites file: +sites.xml+ make the following two
-changes:
+*step 4.*  In the sites file: +sites.xml+ make the following two changes:
 
- 1. change the path of the +$$<workdirectory>$$+ element to your preferred location (this location is *required* to be on /lustre, say to +/lustre/beagle/<yourname>/swift-lab/swift.workdir+), and
+ 1. change the path of the +$$<workdirectory>$$+ element to your preferred
+ location (this location is *required* to be on /lustre, say to
+ +/lustre/beagle/<yourname>/swift-lab/swift.workdir+), and
 
-  2. Change the project name to your project (for instance, +CI-CCR000013+) . The workdirectory will contain
-  execution data related to each run, e.g. wrapper scripts, system information, inputs and outputs.
+  2. Change the project name to your project (for instance, +CI-CCR000013+) .
+  The workdirectory will contain execution data related to each run, e.g.
+  wrapper scripts, system information, inputs and outputs.
 
-*step 5.* Run the example using following commandline (also found in run.sh):
+*step 5.* Run the example using following commandline:
 
 ----
 $ swift -config cf -tc.file tc -sites.file sites.xml catsn.swift -n=1
@@ -37,11 +51,6 @@
 
 *step 6.* Check the output in the generated +outdir+ directory (+ls outdir+)
 
-Note: Running from sandbox node or requesting 1 hour walltime for upto 3 nodes
-will get fast prioritized execution. Good for small tests
-Swift supports a coasters based computing environment for Beagle. A detailed version of Swift documentation is maintained
-http://www.ci.uchicago.edu/swift/docs/index.php[here].
-
 //
 //Intrepid-BG/P
 //~~~~~~~~~~~~~

Modified: trunk/docs/cookbook/overview
===================================================================
--- trunk/docs/cookbook/overview	2013-02-04 19:37:36 UTC (rev 6234)
+++ trunk/docs/cookbook/overview	2013-02-05 15:10:54 UTC (rev 6235)
@@ -1,11 +1,11 @@
 Overview
 --------
-This cookbook covers various recipes involving setting up and running Swift under diverse
-configurations based on the application requirements and the underlying
-infrastructures. The Swift system comprises of SwiftScript language and the
-Swift runtime system. For
-introductory material, consult the Swift tutorial found 
+This cookbook covers recipes involving setting up and running Swift
+under various computational systems based on the application requirements and the
+underlying infrastructures. The Swift framework comprises of a scripting language
+and the Swift runtime system. For introductory material, consult the Swift
+tutorial found
 link:http://www.ci.uchicago.edu/swift/guides/trunk/tutorial/tutorial.html[here].
 
-WARNING: Please be warned that the cookbook is under construction and the recipes are not tested rigorously. 
+WARNING: Note that the cookbook is under construction and the recipes presented here are not tested rigorously.