[Swift-commit] r7179 - SwiftTutorials/OSDC-2013-10-17/doc

[wilde at ci.uchicago.edu]

Author: wilde
Date: 2013-10-18 08:41:38 -0500 (Fri, 18 Oct 2013)
New Revision: 7179

Modified:
   SwiftTutorials/OSDC-2013-10-17/doc/README
Log:
Initial adjustments from Cray to OSDC. More needed.

Modified: SwiftTutorials/OSDC-2013-10-17/doc/README
===================================================================
--- SwiftTutorials/OSDC-2013-10-17/doc/README	2013-10-18 03:58:38 UTC (rev 7178)
+++ SwiftTutorials/OSDC-2013-10-17/doc/README	2013-10-18 13:41:38 UTC (rev 7179)
@@ -1,5 +1,5 @@
-Swift Cray Tutorial
-===================
+Swift Tutorial for Open Science Data Cloud Resources
+====================================================
 
 //// 
 
@@ -9,7 +9,7 @@
 ////
 
 This tutorial is viewable at:
-http://swift-lang.org/tutorials/cray/swift-cray-tutorial.html
+http://swift-lang.org/tutorials/osdc/swift-osdc-tutorial.html
 
 ////
 
@@ -23,7 +23,7 @@
 
 Compute-node exercises, running apps via qsub and aprun:
 
-  p4 - Running apps on Cray compute nodes
+  p4 - Running apps on OSDC compute nodes
   p5 - Running on multiple pools of compute nodes
   p6 - Running a more complex workflow pattern
 
@@ -48,21 +48,21 @@
 clusters, clouds, grids, and supercomputers.
 
 In this tutorial, you'll be able to first try a few Swift examples
-(parts 1-3) on the Cray login host, to get a sense of the
-language. Then in parts 4-6 you'll run similar workflows on Cray
+(parts 1-3) on an OSDC login host, to get a sense of the
+language. Then in parts 4-6 you'll run similar workflows on OSDC
 compute nodes, and see how more complex workflows can be expressed
 with Swift scripts.
 
 Swift tutorial setup
 --------------------
 
-To install the tutorial scripts on Cray "Raven" XE6-XK7 test system,
+To install the tutorial scripts on an OSDC login host,
 do:
 
 -----
 $ cd $HOME
-$ tar xzf /home/users/p01532/swift-cray-tutorial.tgz
-$ cd swift-cray-tutorial
+$ tar xzf /glusterfs/users/swiftlang/tutorial/swift-osdc-tutorial.tgz
+$ cd swift-osdc-tutorial
 $ source setup.sh   # You must run this with "source" !
 -----
 
@@ -85,10 +85,10 @@
 the Swift Subversion repository, do:
 
 -----
-$ svn co https://svn.ci.uchicago.edu/svn/vdl2/SwiftTutorials/swift-cray-tutorial Cray-Swift
+$ svn co https://svn.ci.uchicago.edu/svn/vdl2/SwiftTutorials/swift-osdc-tutorial OSDC-Swift
 -----
 
-This will create a directory called "Cray-Swift" which contains all of the
+This will create a directory called "OSDC-Swift" which contains all of the
 files used in this tutorial.
 
 
@@ -480,14 +480,14 @@
 on the site's compute nodes.
 
 
-Running applications on Cray compute nodes with Swift
+Running applications on OSDC compute nodes with Swift
 -----------------------------------------------------
 
-Part 4: Running a parallel ensemble on Cray compute nodes
+Part 4: Running a parallel ensemble on OSDC compute nodes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 `p4.swift` will run our mock "simulation"
-applications on Cray compute nodes.  The script is similar to as
+applications on OSDC compute nodes.  The script is similar to as
 `p3.swift`, but specifies that each simulation app invocation should
 additionally return the log file which the application writes to
 `stderr`.
@@ -511,9 +511,11 @@
 `sim_N.log`.  The log files provide data on the runtime environment of
 each app invocation. For example:
 
+FIXME: The output below needs to get recaptured for OSDC nodes
+
 -----
 $ cat output/sim_0.log
-Called as: /home/users/p01532/swift-cray-tutorial/app/simulate.sh: --timesteps 1 --range 100 --nvalues 5
+Called as: /home/users/p01532/swift-osdc-tutorial/app/simulate.sh: --timesteps 1 --range 100 --nvalues 5
 
 Start time: Tue Aug 27 12:17:43 CDT 2013
 Running on node: nid00018
@@ -542,7 +544,7 @@
 -----
 
 To tell Swift to run the apps on compute nodes, we specify in the
-`apps` file that the apps should be executed on the `raven` site
+`apps` file that the apps should be executed on the `osdc` site
 (instead of the `localhost` site).  We can specify the location of
 each app in the third field of the `apps` file, with either an
 absolute pathname or the name of an executable to be located in
@@ -610,13 +612,16 @@
 -----
 
 Swift's `sites.xml` configuration file allows many parameters to
-specify how jobs should be run on a given cluster. Consider for
-example that Raven has several queues, each with limitiations on the
-size of jobs that can be run in them.  All Raven queues will only run
-2 jobs per user at one. The Raven queue "small" will only allow up to
-4 nodes per job and 1 hours of walltime per job.  The following
-site.xml parameters will allow us to match this:
+specify how jobs should be run on a given cluster.
 
+FIXME: Translate this concept from Cray to OSDC:
+
+Consider for example that Raven has several queues, each with
+limitiations on the size of jobs that can be run in them.  All Raven
+queues will only run 2 jobs per user at one. The Raven queue "small"
+will only allow up to 4 nodes per job and 1 hours of walltime per job.
+The following site.xml parameters will allow us to match this:
+
 -----
   <profile namespace="globus" key="queue">small</profile>
   <profile namespace="globus" key="slots">2</profile>
@@ -746,6 +751,8 @@
 $ swift p6.swift -steps=5 -nsim=1000
 -----
 
+FIXME: Adjust from Cray to OSDC concepts: (perhaps show how to add more nodes dynamically)
+
 The other change required is to the sites.xml to control how many nodes you request.
 Change the "maxnodes" values to control the number of nodes to request.
 
@@ -835,6 +842,8 @@
 -----
 
 
+FIXME:  Adjust to OSDC from Cray (show two pools of VMs):
+
 Now lets make further use of Swift's ability to route specific apps to
 specific pools of resources. The Cray Raven system has two node types,
 XE6 32-core 2 x IL-16, and XK7 16-core 1 x IL-16 plus one GPU.  Each