[Swift-commit] r8174 - SwiftTutorials/ATPESC_2014-08-14/swift-t

[wozniak at ci.uchicago.edu]

Author: wozniak
Date: 2014-08-14 10:12:13 -0500 (Thu, 14 Aug 2014)
New Revision: 8174

Modified:
   SwiftTutorials/ATPESC_2014-08-14/swift-t/tutorial.txt
Log:
Doc example 01


Modified: SwiftTutorials/ATPESC_2014-08-14/swift-t/tutorial.txt
===================================================================
--- SwiftTutorials/ATPESC_2014-08-14/swift-t/tutorial.txt	2014-08-14 15:12:01 UTC (rev 8173)
+++ SwiftTutorials/ATPESC_2014-08-14/swift-t/tutorial.txt	2014-08-14 15:12:13 UTC (rev 8174)
@@ -1,9 +1,18 @@
 
+:toc:
+
 = Tutorial: Swift/T
 
 This tutorial will walk through 4 examples of the use of Swift/T, in
 addition to a molecular dynamics example.
 
+== Swift/T materials
+
+For more information on Swift/T, see:
+
+* http://swift-lang.org/Swift-T[Swift/T home]
+* http://swift-lang.org/Swift-T/guide.html[Swift/T user guide]
+
 == Files
 
 The examples are in the +examples/+ directory.
@@ -14,9 +23,15 @@
 installations of Swift/T on Cetus/Mira.
 
 Each example contains a +*.swift+ Swift script that is the Swift
-program.  There is also a +run-local+ script to run the Swift script
+program.  The Swift/T compiler +stc+ translates the Swift script into
+an MPI program encoded in a +*.tcl+ file.  This is launched by using
+the +turbine+ program or a scheduler-specific script, such as the
+provided +turbine-cobalt-run.zsh+ script.
+
+There is also a +run-local+ script to run the Swift script
 on the login node and a +run-compute+ script to submit the Swift
-program to Cobalt.
+program to Cobalt.  These scripts add +stc+ and +turbine+ entries to
+your +PATH+ automatically.
 
 == Swift/T installations
 
@@ -35,4 +50,35 @@
 ----
 ./run-local.sh
 ----
-3. This
+3. This program is a simple Hello World example.
++
+----
+include::examples/01-hello/hello.swift[]
+----
+4. Run:
++
+----
+./run-compute.sh
+----
++
+This will report something like:
++
+----
+SETTINGS=../../cfg/settings-compute.sh
+TURBINE_OUTPUT=/home/user/turbine-output/2014/08/14/10/06/20
+SCRIPT_NAME=hello.tcl
+NODES=2
+project: ATPESC2014
+JOB_ID=312170
+----
++
+Turbine will copy +hello.tcl+ to +TURBINE_OUTPUT+ and run from that
+directory.  The Cobalt log may be found there.  Standard output is
+directed to +TURBINE_OUTPUT/output.txt+.
++
+The contents of +output.txt+ are the Blue Gene runtime output plus the
+Swift-generated line:
++
+----
+stdout[0]: Hello world!
+----