[Swift-commit] r8200 - in SwiftTutorials/ATPESC_2014-08-14/swift-k: . doc

wozniak at ci.uchicago.edu wozniak at ci.uchicago.edu
Thu Aug 14 12:43:06 CDT 2014


Author: wozniak
Date: 2014-08-14 12:43:06 -0500 (Thu, 14 Aug 2014)
New Revision: 8200

Added:
   SwiftTutorials/ATPESC_2014-08-14/swift-k/build-docs.sh
   SwiftTutorials/ATPESC_2014-08-14/swift-k/swift.css
Modified:
   SwiftTutorials/ATPESC_2014-08-14/swift-k/doc/README
Log:
Asciidoc and fixes


Copied: SwiftTutorials/ATPESC_2014-08-14/swift-k/build-docs.sh (from rev 8191, SwiftTutorials/ATPESC_2014-08-14/build-docs.sh)
===================================================================
--- SwiftTutorials/ATPESC_2014-08-14/swift-k/build-docs.sh	                        (rev 0)
+++ SwiftTutorials/ATPESC_2014-08-14/swift-k/build-docs.sh	2014-08-14 17:43:06 UTC (rev 8200)
@@ -0,0 +1,3 @@
+#!/bin/sh -eu
+
+asciidoc --attribute stylesheet=${PWD}/swift.css -a max-width=750px -a textwidth=80 README

Modified: SwiftTutorials/ATPESC_2014-08-14/swift-k/doc/README
===================================================================
--- SwiftTutorials/ATPESC_2014-08-14/swift-k/doc/README	2014-08-14 17:30:17 UTC (rev 8199)
+++ SwiftTutorials/ATPESC_2014-08-14/swift-k/doc/README	2014-08-14 17:43:06 UTC (rev 8200)
@@ -1,7 +1,7 @@
 Swift Tutorial for RCC Midway Cluster
 =====================================
 
-//// 
+////
 
 This is the asciidoc input file.
 Its content is viewable as a plain-text README file.
@@ -59,7 +59,7 @@
 the instructions at http://docs.rcc.uchicago.edu/tutorials/intro-to-rcc-workshop.html
 for more information on using a yubikey to log in.
 
-Once you are logged into the Midway login host, run the following commands 
+Once you are logged into the Midway login host, run the following commands
 to set up your environment.
 
 -----
@@ -67,7 +67,7 @@
 $ wget http://swiftlang.org/tutorials/midway/swift-midway-tutorial.tar.gz
 $ tar xvfz swift-midway-tutorial.tar.gz
 $ cd swift-midway-tutorial
-$ source setup.sh 
+$ source setup.sh
 -----
 
 Verify your environment
@@ -117,7 +117,7 @@
     -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            
+    -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
@@ -152,7 +152,7 @@
       51
 $ head -5 log
 
-Called as: /home/davidkelly999/swift-midway-tutorial/app/simulate: 
+Called as: /home/davidkelly999/swift-midway-tutorial/app/simulate:
 Start time: Mon Dec  2 13:47:41 CST 2013
 Running as user: uid=88848(davidkelly999) gid=88848(davidkelly999) groups=88848(davidkelly999),10008(rcc),10030(pi-gavoth),10031(sp-swift),10036(swift),10058(pi-joshuaelliott),10084(pi-wilde),10118(cron-account),10124(cmts),10138(cmtsworkshop)
 
@@ -274,7 +274,7 @@
 
 .p1.swift
 -----
-sys::[cat ../part01/p1.swift]
+sys::[cat ./part01/p1.swift]
 -----
 
 
@@ -287,10 +287,10 @@
 RunID: 20130827-1413-oa6fdib2
 Progress:  time: Tue, 27 Aug 2013 14:13:33 -0500
 Final status: Tue, 27 Aug 2013 14:13:33 -0500  Finished successfully:1
-$ cat sim.out 
+$ cat sim.out
       84
 $ swift p1.swift
-$ cat sim.out 
+$ cat sim.out
       36
 -----
 
@@ -317,7 +317,7 @@
 
 .p2.swift
 -----
-sys::[cat ../part02/p2.swift]
+sys::[cat ./part02/p2.swift]
 -----
 
 The script also shows an
@@ -360,7 +360,7 @@
 
 .p3.swift
 ----
-sys::[cat ../part03/p3.swift]
+sys::[cat ./part03/p3.swift]
 ----
 
 To run:
@@ -390,8 +390,8 @@
 int values = toInt(arg("values","5"));
 -----
 
-Now we can specify that more runs should be performed and that each should run 
-for more timesteps, and produce more that one value each, within a specified range, 
+Now we can specify that more runs should be performed and that each should run
+for more timesteps, and produce more that one value each, within a specified range,
 using command line arguments placed after the Swift script name in the form `-parameterName=value`:
 
 -----
@@ -437,7 +437,7 @@
 Now try running (`-nsim=`) 100 simulations of (`-steps=`) 1 second each:
 
 -----
-$ swift p3.swift -nsim=100 -steps=1 
+$ swift p3.swift -nsim=100 -steps=1
 Swift 0.94.1 RC2 swift-r6895 cog-r3765
 
 RunID: 20130827-1444-rq809ts6
@@ -464,9 +464,9 @@
 Part 4: Running a parallel ensemble on Midway compute nodes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-`p4.swift` will run our mock "simulation" applications on Midway 
-compute nodes. The script is similar to as `p3.swift`, but specifies 
-that each simulation app invocation should additionally return the 
+`p4.swift` will run our mock "simulation" applications on Midway
+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`.
 
 Now when you run `swift p4.swift` you'll see that two types output
@@ -481,7 +481,7 @@
 Start time: Mon Dec  2 12:17:06 CST 2013
 Running as user: uid=88848(davidkelly999) gid=88848(davidkelly999) groups=88848(davidkelly999),10008(rcc),10030(pi-gavoth),10031(sp-swift),10036(swift),10058(pi-joshuaelliott),10084(pi-wilde),10118(cron-account),10124(cmts),10138(cmtsworkshop)
 Running on node: midway002
-Node IP address: 10.50.181.2 172.25.181.2 
+Node IP address: 10.50.181.2 172.25.181.2
 
 Simulation parameters:
 
@@ -510,9 +510,9 @@
 Consider for example that Midway has several Slurm partitions. The sandyb
 partition has 16 cores, and the westmere partition has 12 cores. Depending
 on the application and which partitions are busy, you may want to modify
-where you run. 
+where you run.
 
-Here is an example of the swift.properties in the part04 directory: 
+Here is an example of the swift.properties in the part04 directory:
 
 -----
 site=westmere
@@ -521,7 +521,7 @@
 -----
 
 The first line, site=westmere, allows you to define which partition to run on. Swift includes
-templates for each partition that provides some reasonable default values. Other valid partitions 
+templates for each partition that provides some reasonable default values. Other valid partitions
 are amd, bigmem, gpu, local, and sandyb.
 
 The second and third line override some of the default values, by specifying a reservation that will
@@ -537,7 +537,7 @@
 Performing larger Swift runs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To test with larger runs, there are two changes that are required. The first is a 
+To test with larger runs, there are two changes that are required. The first is a
 change to the command line arguments. The example below will run 1000 simulations
 with each simulation taking 5 seconds.
 
@@ -556,7 +556,7 @@
 
 After each Swift run, a new run directory is created called runNNN.
 Each run directory will have a log file with a similar name called
-runNNN.log. Once you have identified the log file name, run the 
+runNNN.log. Once you have identified the log file name, run the
 command `plot.sh` <logfile>` to generate the plots for that
 specific run. For example:
 
@@ -569,7 +569,7 @@
 $ ls
 apps  cf  p3-20131202-2004-0kh4ha6e.d  run000.log  sites.xml
 
-$ plot.sh run000.log 
+$ plot.sh run000.log
 -----
 
 This yields plots like:
@@ -595,7 +595,7 @@
 
 .p6.swift
 ----
-sys::[cat ../part06/p6.swift]
+sys::[cat ./part06/p6.swift]
 ----
 
 Note that the workflow is based on data flow dependencies: each simulation depends on the seed value, calculated in this statement:
@@ -714,4 +714,3 @@
 bias values as is needed for each simulation.  As a further exercise,
 modify the script to generate a unique seed value for each simulation,
 which is a common practice in ensemble computations.
-

Copied: SwiftTutorials/ATPESC_2014-08-14/swift-k/swift.css (from rev 8192, SwiftTutorials/ATPESC_2014-08-14/swift.css)
===================================================================
--- SwiftTutorials/ATPESC_2014-08-14/swift-k/swift.css	                        (rev 0)
+++ SwiftTutorials/ATPESC_2014-08-14/swift-k/swift.css	2014-08-14 17:43:06 UTC (rev 8200)
@@ -0,0 +1,10 @@
+
+/* SWIFT/T GUIDE CUSTOMIZATIONS */
+
+a:visited {
+  color: gray;
+}
+h5 {
+  font-size: 0.8em;
+}
+




More information about the Swift-commit mailing list