[Swift-commit] r4450 - www/cookbook

Fri May 6 10:26:03 CDT 2011

Author: ketan
Date: 2011-05-06 10:26:03 -0500 (Fri, 06 May 2011)
New Revision: 4450

Modified:
   www/cookbook/cookbook-asciidoc.html
   www/cookbook/cookbook-asciidoc.txt
Log:
 

Modified: www/cookbook/cookbook-asciidoc.html
===================================================================

--- www/cookbook/cookbook-asciidoc.html	2011-05-04 22:17:58 UTC (rev 4449)
+++ www/cookbook/cookbook-asciidoc.html	2011-05-06 15:26:03 UTC (rev 4450)
@@ -1079,18 +1079,24 @@
 <div class="sect2">
 <h3 id="_beagle">3.1. Beagle</h3>
 <div class="paragraph"><p>Swift is now installed on Beagle as a module. Swift supports a Coasters based,
-PBS-enabled computing environment for Beagle. To get started with Swift on
-Beagle follow the steps outlined below:</p></div>
+computing environment for Beagle. A detailed Swift documentation is maintained
+[[<a href="http://www.ci.uchicago.edu/swift/docs/index.php]">here</a>].  To get started
+with Swift on Beagle follow the steps outlined below:</p></div>
 <div class="paragraph"><p><strong>step 1.</strong> Load the Swift module on Beagle as follows: <tt>module load swift</tt></p></div>
-<div class="paragraph"><p><strong>step 2.</strong> Create a Swift specific folder where all your Swift related work will
-stay. (say, <tt>mkdir swift-lab</tt>)</p></div>
-<div class="paragraph"><p><strong>step 3.</strong> To get started with an example, copy the folder at
-<tt>/home/ketan/labs/catsn.works</tt> to the above created swift-lab. (<tt>cp -r
-/home/ketan/catsn.works ~/swift-lab</tt>).</p></div>
-<div class="paragraph"><p><strong>step 4.</strong> From the sites file: <tt>catsn.works/beagle-coaster.xml</tt>, change the path
-of swift.workdir to your preferred location (say to <tt>~/swift-lab/swift.workdir</tt>)
-and the project name to the one you are part of.</p></div>
-<div class="paragraph"><p><strong>step 5.</strong> Run the example using following commandline: <tt>swift -config cf -tc.file tc -sites.file beagle-coaster-1.xml catsn.swift -n=1</tt></p></div>
+<div class="paragraph"><p><strong>step 2.</strong> Create and change to a directory where your Swift related work will
+stay. (say, <tt>mkdir swift-lab</tt>, followed by, <tt>cd swift-lab</tt>)</p></div>
+<div class="paragraph"><p><strong>step 3.</strong> To get started with a simple example running <tt>/bin/cat</tt> to read an input file <tt>data.txt</tt> and write to an output file <tt>f.nnn.out</tt>, copy the folder at <tt>/home/ketan/labs/catsn</tt> to the above directory. (<tt>cp -r /home/ketan/catsn .</tt> followed by <tt>cd catsn</tt>).</p></div>
+<div class="paragraph"><p><strong>step 4.</strong>  In the sites file: <tt>beagle-coaster.xml</tt>, make the following two
+changes: <strong>1)</strong> change the path of <tt>workdirectory</tt> to your preferred location
+(say to <tt>/lustre/beagle/$USER/swift-lab/swift.workdir</tt>) and <strong>2)</strong> Change the
+project name to your project (<tt>CI-CCR000013</tt>) . The workdirectory will contain
+execution data related to each run, e.g. wrapper scripts, system information,
+inputs and outputs.</p></div>
+<div class="paragraph"><p><strong>step 5.</strong> Run the example using following commandline (also found in run.sh):
+<tt>swift -config cf -tc.file tc -sites.file beagle-coaster.xml catsn.swift -n=1</tt>
+. You can further change the value of <tt>-n</tt> to any arbitrary number to run that
+many number of concurrent <tt>cat</tt></p></div>
+<div class="paragraph"><p><strong>step 6.</strong> Check the output in the generated <tt>outdir</tt> directory (<tt>ls outdir</tt>)</p></div>
 <div class="paragraph"><p>Note: Running from sandbox node or requesting 1 hour walltime for upto 3 nodes
 will get fast prioritized execution. Good for small tests</p></div>
 </div>
@@ -1477,7 +1483,7 @@
 <div id="footer">
 <div id="footer-text">
 Version 0.92<br />
-Last updated 2011-05-04 13:09:08 CDT
+Last updated 2011-05-06 10:25:32 CDT
 </div>
 </div>
 </body>

Modified: www/cookbook/cookbook-asciidoc.txt
===================================================================
--- www/cookbook/cookbook-asciidoc.txt	2011-05-04 22:17:58 UTC (rev 4449)
+++ www/cookbook/cookbook-asciidoc.txt	2011-05-06 15:26:03 UTC (rev 4450)
@@ -488,24 +488,31 @@
 Beagle
 ~~~~~~
 Swift is now installed on Beagle as a module. Swift supports a Coasters based,
-PBS-enabled computing environment for Beagle. To get started with Swift on
-Beagle follow the steps outlined below:
+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:
 
 *step 1.* Load the Swift module on Beagle as follows: +module load swift+
 
-*step 2.* Create a Swift specific folder where all your Swift related work will
-stay. (say, +mkdir swift-lab+)
+*step 2.* Create and change to a directory where your Swift related work will
+stay. (say, +mkdir swift-lab+, followed by, +cd swift-lab+)
 
-*step 3.* To get started with an example, copy the folder at
-+/home/ketan/labs/catsn.works+ to the above created swift-lab. (+cp -r
-/home/ketan/catsn.works ~/swift-lab+). 
+*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 4.* From the sites file: +catsn.works/beagle-coaster.xml+, change the path
-of swift.workdir to your preferred location (say to +~/swift-lab/swift.workdir+)
-and the project name to the one you are part of.
+*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 5.* Run the example using following commandline: +swift -config cf -tc.file tc -sites.file beagle-coaster-1.xml catsn.swift -n=1+
+*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 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
 


