[Swift-commit] r7016 - SwiftTutorials/swift-cray-tutorial/doc

[wilde at ci.uchicago.edu]

Author: wilde
Date: 2013-08-27 19:57:36 -0500 (Tue, 27 Aug 2013)
New Revision: 7016

Modified:
   SwiftTutorials/swift-cray-tutorial/doc/README
Log:
Corrected some doc errors.

Modified: SwiftTutorials/swift-cray-tutorial/doc/README
===================================================================
--- SwiftTutorials/swift-cray-tutorial/doc/README	2013-08-28 00:42:31 UTC (rev 7015)
+++ SwiftTutorials/swift-cray-tutorial/doc/README	2013-08-28 00:57:36 UTC (rev 7016)
@@ -76,8 +76,8 @@
 $ swift -version  # verify that you have Swift 0.94.1
 -----
 
-NOTE: If you re-login or open new ssh sessions, you must
-re-run `source setup.sh` in each ssh shell/window.
+NOTE: If you re-login or open new ssh sessions, you must re-run `source setup.sh` in each ssh shell/window.
+
 To check out the tutorial scripts from SVN
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -95,17 +95,18 @@
 Simple "science applications" for the workflow tutorial
 -------------------------------------------------------
 
-This tutorial is based on two simple example programs (both
-implemented as bash shell scripts) that serve a very simple stand-ins
-for real science applications: `simulation.sh` and `stats.sh`.
+This tutorial is based on two intentionally trivial example programs,
+`simulation.sh` and `stats.sh`, (implemented as bash shell scripts)
+that serve as easy-to-understand proxies for real science
+applications. These "programs" behave as follows.
 
 simulation.sh
 ~~~~~~~~~~~
 
-The simulation.sh script serves as a trivial substitute for a complex
-scientific simulation application. It generates and prints a set of
-one or more random integers in the range [0-2^62) as controlled by its
-command line arguments, which are:
+The simulation.sh script serves as a trivial proxy for any more
+complex scientific simulation application. It generates and prints a
+set of one or more random integers in the range [0-2^62) as controlled
+by its command line arguments, which are:
 
 -----
 $ ./app/simulate.sh --help
@@ -139,8 +140,6 @@
 |=======================
 ////
 
-With no arguments, simulate.sh prints 1 number in the range of 1-100. Otherwise it generates n numbers of the form (R*scale)+bias where R is a random integer. By default it logs information about its execution environment to stderr.  Here's some examples of its usage:
-
 With no arguments, simulate.sh prints 1 number in the range of
 1-100. Otherwise it generates n numbers of the form (R*scale)+bias
 where R is a random integer. By default it logs information about its
@@ -487,18 +486,25 @@
 Part 4: Running a parallel ensemble on Cray compute nodes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-p4.swift will run our mock "simulation"
+`p4.swift` will run our mock "simulation"
 applications on Cray 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`, making the parallel portion of the script behave like this:
+`stderr`.
 
+////
+
+FIXME: need to revise this figure: drop prog:
+
+, making the parallel portion of the script behave like this:
+
 image::part04.png[align="center"]
 
 .p4.swift
 ----
 sys::[cat ../part04/p4.swift]
 ----
+////
 
 Now when you run `swift p4.swift` you'll see that two types output
 files will placed in the `output/` directory: `sim_N.out` and