[Swift-commit] r7706 - SwiftApps/swift-galaxy

[ketan at ci.uchicago.edu]

Author: ketan
Date: 2014-03-13 11:20:30 -0500 (Thu, 13 Mar 2014)
New Revision: 7706

Modified:
   SwiftApps/swift-galaxy/README
Log:
readme improvements

Modified: SwiftApps/swift-galaxy/README
===================================================================
--- SwiftApps/swift-galaxy/README	2014-03-13 16:03:26 UTC (rev 7705)
+++ SwiftApps/swift-galaxy/README	2014-03-13 16:20:30 UTC (rev 7706)
@@ -10,17 +10,24 @@
 Galaxy tool, called `foreach` which allows user to compose Galaxy workflows
 such that each computation stage in the workflow is executed by Swift. User can
 compose Galaxy tool and pick up arbitrary executables and dataset to run the
-executable over.
+executable over. User can also run the executable over a list of items such as
+string or file parameters.
 
-This document can be found http://www.mcs.anl.gov/~ketan/swiftgalaxy.html[here].
+NOTE: This document can be found http://www.mcs.anl.gov/~ketan/swiftgalaxy.html[here].
 
-Description of the Swift-Galaxy `foreach` tool 
------------------------------------------------
+Swift-Galaxy `foreach` Mechanism 
+---------------------------------
 
-There are two ways, the foreach Swift tool can be utilized. First, over a range
-of numbers. The tool is used to run a Swift foreach loop over a range of
-numbers for any arbitrary executable. The executable will run with number in
-range as commandline argument, one at a time. User can add arbitrary string
+The basic mechanism is that the tool user-interface will accept parameters and
+will pass them along to a backend Swift "generator". This generator program
+will run the parameters over Swift source and configuration templates. As a
+result, the right source and configuration files are produced in a temporary
+directory (`/tmp/tmpname`). This is then executed and the results collected.
+
+There are two ways the foreach Swift tool can be utilized. First, over a range
+of numbers. The tool is used to run any arbitrary executable via Swift foreach
+loop over a range of numbers. The executable will run with number in range as
+commandline argument, one at a time. Furthermore, user can add arbitrary string
 arguments in addition to the number argument to the call to executable.
 
 The second version runs the foreach loop over a list of items. These items can
@@ -146,3 +153,10 @@
 
 Step 6. For examples of other Galaxy-Swift tools, look into the swift directoty.
 
+Upcoming Features
+------------------
+
+* Mixing the order of file and string arguments
+* Optionally allowing user to not use range number as arguments
+* Providing more Swift patterns, eg. `if-else` conditionals
+