[Swift-commit] r6958 - SwiftTutorials/CIC_2013-08-09/doc

[wilde at ci.uchicago.edu]

Author: wilde
Date: 2013-08-22 13:01:36 -0500 (Thu, 22 Aug 2013)
New Revision: 6958

Added:
   SwiftTutorials/CIC_2013-08-09/doc/2-stage-diamond.png
Modified:
   SwiftTutorials/CIC_2013-08-09/doc/README
Log:
cic doc edits.

Added: SwiftTutorials/CIC_2013-08-09/doc/2-stage-diamond.png
===================================================================
(Binary files differ)


Property changes on: SwiftTutorials/CIC_2013-08-09/doc/2-stage-diamond.png
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Modified: SwiftTutorials/CIC_2013-08-09/doc/README
===================================================================
--- SwiftTutorials/CIC_2013-08-09/doc/README	2013-08-22 17:22:03 UTC (rev 6957)
+++ SwiftTutorials/CIC_2013-08-09/doc/README	2013-08-22 18:01:36 UTC (rev 6958)
@@ -52,39 +52,97 @@
 
 -----
 $ cd tutorial            # change to the newly created tutorial directory
-$ source setup.sh <SITE> # sets swift config files in $HOME/.swift
+$ source setup.sh        # sets swift config files in $HOME/.swift
 $ java -version          # verify that you have Oracle JAVA (prefered; 1.6 or later)
 $ swift -version         # verify that Swift 0.94 is in your $PATH and functional
 -----
 
-NOTE: If you re-login, you will need to re-run source setup.sh.
+NOTE: If you re-login or create additional terminal sessions, you must re-run `source setup.sh` in each one.
 
 Simple "science applications" for the workflow tutorial
 -------------------------------------------------------
-There are two shell scripts included that serve a very simple stand-ins for science application:
-simulation.sh and stats.sh
+We use two shell scripts in this tutorial to serve as very simple stand-ins for a real science application:
+`simulation.sh` and `stats.sh`. These are located in the `tutorial/app` directory.
 
 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^32) as controlled by its optional arguments, which are:
+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 optional arguments, which are:
 
+-----
+$ ./app/simulate.sh --help
+./app/simulate.sh: usage:
+    -b|--bias       offset bias: add this integer to all results
+    -B|--biasfile   file of integer biases to add to results
+    -l|--log        generate a log in stderr if not null
+    -n|--nvalues    print this many values per simulation            
+    -r|--range      range (limit) of generated results
+    -s|--seed       use this integer [0..32767] as a seed
+    -S|--seedfile   use this file (containing integer seeds [0..32767]) one per line
+    -t|--timesteps  number of simulated "timesteps" in seconds (determines runtime)
+    -x|--scale      scale the results by this integer
+    -h|-?|?|--help  print this help
+$ 
+-----
+
+////
 .simulation.sh arguments
 [width="80%",cols="^2,10",options="header"]
 
 |=======================
-|Argument number|Description
+|Argument|Short|Description
 |1    |runtime: sets run time of simulation.sh in seconds
 |2    |range: limits generated values to the range [0,range-1]
 |3    |biasfile: add the integer contained in this file to each value generated
 |4    |scale: multiplies each generated value by this integer
 |5    |count: number of values to generate in the simulation
 |=======================
+////
 
-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. 
+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:
 
 -----
-$ ./simulate.sh
-96
+$ simulate.sh 2>log
+       5
+$ head -5 log
+
+Called as: /home/wilde/swift/tut/CIC_2013-08-09/app/simulate.sh: 
+
+Start time: Thu Aug 22 12:40:24 CDT 2013
+Running on node: login01.osgconnect.net
+
+$ tail -5 log
+SSH_CLIENT=67.173.156.31 46887 22
+SSH_CONNECTION=67.173.156.31 46887 128.135.158.173 22
+SSH_TTY=/dev/pts/9
+TERM=xterm-color
+USER=wilde
+$ 
+
+$ simulate.sh -n 3 -r 1000000 2>log
+  386702
+  239454
+   13849
+
+$ simulate.sh -n 3 -r 1000000 -x 100 2>log
+ 6643700
+62182300
+ 5230600
+
+$ simulate.sh -n 3 -r 1000 -x 1000 2>log
+  565000
+  636000
+  477000
+
+$ time simulate.sh -n 3 -r 1000 -x 1000 -t 3 2>log
+  336000
+   20000
+  320000
+real	0m3.012s
+user	0m0.005s
+sys	0m0.006s
+$ 
+
+
 -----
 
 stats.sh