[Swift-commit] r8244 - SwiftApps/subjobs

[ketan at ci.uchicago.edu]

Author: ketan
Date: 2014-09-11 15:35:40 -0500 (Thu, 11 Sep 2014)
New Revision: 8244

Modified:
   SwiftApps/subjobs/README.txt
Log:
update to README

Modified: SwiftApps/subjobs/README.txt
===================================================================
--- SwiftApps/subjobs/README.txt	2014-09-11 14:58:02 UTC (rev 8243)
+++ SwiftApps/subjobs/README.txt	2014-09-11 20:35:40 UTC (rev 8244)
@@ -9,8 +9,8 @@
 
 This package provides tools and scripts to run Swift applications in sub-block mode over the BlueGene resources.
 
-Running subjobs from Swift
---------------------------
+Swift sub-block jobs
+---------------------
 
 To set up environment:
 
@@ -24,4 +24,67 @@
 ./runswift
 ----
 
+sub-block jobs from bash
+-------------------------
 
+To run the example application from bash:
+
+----
+./runbash
+----
+
+Swift Sub-block jobs: HowTo
+----------------------------
+
+In order to convert an ordinary Swift app run in sub-block mode, the following changes are required:
+
+. Add bg.sh as the application invoker in place of sh. For example, if the app definition is as follows:
+
+----
+sh @exe @i @o arg("s","1") stdout=@sout stderr=@serr;
+----
+
+Replace the shell invocation with the bg.sh invocations like so:
+
+----
+bg.sh @exe @i @o arg("s","1") stdout=@sout stderr=@serr;
+----
+
+. Add the +SUBBLOCK_SIZE+ environment variable to the sites file. For example:
+
+----
+<profile key="SUBBLOCK_SIZE" namespace="env">16</profile>
+----
+
+NOTE: The value of +SUBBLOCK_SIZE+ variable must be a power of 2 greater than 8 and less than the +maxnodes+ value.
+
+A complete example sites file for a sub-block job run on ALCF Vesta is shown below:
+
+----
+<?xml version="1.0" encoding="UTF-8"?>
+<config xmlns="http://www.ci.uchicago.edu/swift/SwiftSites">
+
+<pool handle="cluster">
+<execution provider="coaster" jobmanager="local:cobalt" />
+
+<profile namespace="globus" key="slots">1</profile>
+<profile namespace="globus" key="mode">script</profile>
+
+<profile namespace="karajan" key="jobThrottle">2.99</profile>
+<profile namespace="karajan" key="initialScore">10000</profile>
+<profile namespace="globus" key="maxwalltime">00:40:00</profile>
+<profile namespace="globus" key="walltime">2050</profile>
+
+<profile namespace="globus" key="maxnodes">256</profile>
+<profile namespace="globus" key="nodegranularity">256</profile>
+<profile key="SUBBLOCK_SIZE" namespace="env">8</profile>
+<profile namespace="globus" key="jobsPerNode">32</profile>
+
+<workdirectory>/home/ketan/swiftwork</workdirectory>
+<filesystem provider="local"/>
+
+</pool>
+</config>
+----
+
+