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

[ketan at ci.uchicago.edu]

Author: ketan
Date: 2011-06-23 13:49:19 -0500 (Thu, 23 Jun 2011)
New Revision: 4671

Added:
   trunk/docs/cookbook/figures
Modified:
   trunk/docs/cookbook/diverse_infrastructures
Log:
spruced up the beagle cookbook section

Modified: trunk/docs/cookbook/diverse_infrastructures
===================================================================
--- trunk/docs/cookbook/diverse_infrastructures	2011-06-23 18:32:08 UTC (rev 4670)
+++ trunk/docs/cookbook/diverse_infrastructures	2011-06-23 18:49:19 UTC (rev 4671)
@@ -3,35 +3,45 @@
 
 Beagle
 ~~~~~~
-Swift is now installed on Beagle as a module. Swift supports a Coasters based,
-computing environment for Beagle. A detailed Swift documentation is maintained
-[[http://www.ci.uchicago.edu/swift/docs/index.php][here]]. To get started
-with Swift on Beagle follow the steps outlined below:
+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+.
 
-*step 1.* Load the Swift module on Beagle as follows: +module load swift+
+image::figures/catsn.png[Swift Example]
 
-*step 2.* Create and change to a directory where your Swift related work will
-stay. (say, +mkdir swift-lab+, followed by, +cd swift-lab+)
+The steps are as follows:
 
-*step 3.* To get started with a simple example running +/bin/cat+ to read an input file +data.txt+ and write to an output file +f.nnn.out+, copy the folder at +/home/ketan/labs/catsn+ to the above directory. (+cp -r /home/ketan/catsn .+ followed by +cd catsn+).
+*step 1.* Load the Swift module on Beagle commandline as follows: +$ module load swift+
 
-*step 4.*  In the sites file: +beagle-coaster.xml+, make the following two
-changes: *1)* change the path of +workdirectory+ to your preferred location
-(say to +/lustre/beagle/$USER/swift-lab/swift.workdir+) and *2)* Change the
-project name to your project (+CI-CCR000013+) . The workdirectory will contain
-execution data related to each run, e.g. wrapper scripts, system information,
-inputs and outputs.
+*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 5.* Run the example using following commandline (also found in run.sh):
-+swift -config cf -tc.file tc -sites.file beagle-coaster.xml catsn.swift -n=1+
-. You can further change the value of +-n+ to any arbitrary number to run that
-many number of concurrent +cat+
+*step 3.* copy the folder at +/home/ketan/labs/catsn+ to the above directory. (+$cp -r /home/ketan/catsn .+ followed by +$ cd catsn+).
 
-*step 6.* Check the output in the generated +outdir+ directory (+ls outdir+)
+*step 4.*  In the sites file: +sites.xml+ make the following two
+changes:
 
-Note: Running from sandbox node or requesting 1 hour walltime for upto 3 nodes
-will get fast prioritized execution. Good for small tests
+ 1. change the path of the +$$<workdirectory>$$+ element to your preferred location (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.
+
+  *step 5.* Run the example using following commandline (also found in run.sh):
+
+  ----
+  $ swift -config cf -tc.file tc -sites.file sites.xml catsn.swift -n=1
+  ----
+
+  You can further change the value of +-n+ to any arbitrary number to run that
+  many number of concurrent +cat+
+
+  *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
 //~~~~~~~~~~~~~

Added: trunk/docs/cookbook/figures
===================================================================
--- trunk/docs/cookbook/figures	                        (rev 0)
+++ trunk/docs/cookbook/figures	2011-06-23 18:49:19 UTC (rev 4671)
@@ -0,0 +1 @@
+link /ci/www/projects/swift/cookbook/figures/
\ No newline at end of file


Property changes on: trunk/docs/cookbook/figures
___________________________________________________________________
Added: svn:special
   + *