[Swift-commit] r6809 - SwiftApps/Scattering/paintgrid/docs

Thu Aug 8 15:14:53 CDT 2013

Author: davidk
Date: 2013-08-08 15:14:53 -0500 (Thu, 08 Aug 2013)
New Revision: 6809

Modified:
   SwiftApps/Scattering/paintgrid/docs/README
   SwiftApps/Scattering/paintgrid/docs/tutorial.html
Log:
Updated html


Modified: SwiftApps/Scattering/paintgrid/docs/README
===================================================================

--- SwiftApps/Scattering/paintgrid/docs/README	2013-08-08 20:01:02 UTC (rev 6808)
+++ SwiftApps/Scattering/paintgrid/docs/README	2013-08-08 20:14:53 UTC (rev 6809)
@@ -190,10 +190,9 @@
 head node of a cluster. In order to avoid overloading a single machine, the
 localhost configuration is set up to run only 1 job at a time.
 
-To run:
 -----
-$ swift paintgrid.swift                         # Default values 
-$ swift paintgrid.swift -params=onepoint.params # To use a specific parameter file 
+$ swift paintgrid.swift                          # Default values
+$ swift paintgrid.swift -params=onepoint.params  # Specify a param file
 -----
 
 Orthros
@@ -201,7 +200,6 @@
 To run paintgrid.swift on the Orthros cluster, you must point Swift to an xml
 file that describes information about the scheduler.
 
-To run:
 -----
 $ swift -sites.file orthros.xml paintgrid.swift                       # Default values
 $ swift -sites.file orthros.xml paintgrid.swift -image=data.0001.tif  # To specify an image
@@ -211,10 +209,9 @@
 ~~~~~~
 To run on Beagle, you must run another step that configures an SSH tunnel.
 
-To run:
 -----
 $ ./start-beagle
-$ swift -sites.file beagle.xml paintgrid.swift              # Default values 
-$ swift -sites.file beagle.xml paintgrid.swift -runTime=1   # A 1 second sleep time for processPoints.py
+$ swift -sites.file beagle.xml paintgrid.swift
 $ ./stop-beagle
 -----
+

Modified: SwiftApps/Scattering/paintgrid/docs/tutorial.html
===================================================================
--- SwiftApps/Scattering/paintgrid/docs/tutorial.html	2013-08-08 20:01:02 UTC (rev 6808)
+++ SwiftApps/Scattering/paintgrid/docs/tutorial.html	2013-08-08 20:14:53 UTC (rev 6809)
@@ -828,18 +828,92 @@
   ofile = processPoints(processPoints_script, image, pointSet);
 }</tt></pre>
 </div></div>
+<div class="paragraph"><p>There are several command line options you can pass to the swift script to
+define how it runs. Below is a list of arguments and a description of what they
+do.</p></div>
+<div class="tableblock">
+<table rules="all"
+width="100%"
+frame="border"
+cellspacing="0" cellpadding="4">
+<caption class="title">Table 4. paintgrid.swift arguments</caption>
+<col width="50%" />
+<col width="50%" />
+<thead>
+<tr>
+<th align="left" valign="top">Parameter       </th>
+<th align="left" valign="top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td align="left" valign="top"><p class="table">-params=file</p></td>
+<td align="left" valign="top"><p class="table">Name of params file to use. Defaults to genpoints.params.</p></td>
+</tr>
+<tr>
+<td align="left" valign="top"><p class="table">-image=file</p></td>
+<td align="left" valign="top"><p class="table">Name of image file to analyze. Defaults to data.0001.tiny.</p></td>
+</tr>
+<tr>
+<td align="left" valign="top"><p class="table">-runTime=seconds</p></td>
+<td align="left" valign="top"><p class="table">Sleep time value for processPoints.py (floating point seconds)</p></td>
+</tr>
+</tbody>
+</table>
 </div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">Command line arguments to swift scripts must come after the name of the
+script. For example: swift paintgrid.swift -params=myfile -image=myimage</td>
+</tr></table>
 </div>
+</div>
+</div>
 <div class="sect1">
 <h2 id="_how_to_run">How to run</h2>
 <div class="sectionbody">
+<div class="paragraph"><p>The following steps will explain how to run paintgrid.swift on different sites.</p></div>
+<div class="sect2">
+<h3 id="_localhost">Localhost</h3>
+<div class="paragraph"><p>The paintgrid.swift script can run locally on a laptop, desktop, or on the
+head node of a cluster. In order to avoid overloading a single machine, the
+localhost configuration is set up to run only 1 job at a time.</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>$ swift paintgrid.swift                          # Default values
+$ swift paintgrid.swift -params=onepoint.params  # Specify a param file</tt></pre>
+</div></div>
 </div>
+<div class="sect2">
+<h3 id="_orthros">Orthros</h3>
+<div class="paragraph"><p>To run paintgrid.swift on the Orthros cluster, you must point Swift to an xml
+file that describes information about the scheduler.</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>$ swift -sites.file orthros.xml paintgrid.swift                       # Default values
+$ swift -sites.file orthros.xml paintgrid.swift -image=data.0001.tif  # To specify an image</tt></pre>
+</div></div>
 </div>
+<div class="sect2">
+<h3 id="_beagle">Beagle</h3>
+<div class="paragraph"><p>To run on Beagle, you must run another step that configures an SSH tunnel.</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>$ ./start-beagle
+$ swift -sites.file beagle.xml paintgrid.swift
+$ ./stop-beagle</tt></pre>
+</div></div>
 </div>
+</div>
+</div>
+</div>
 <div id="footnotes"><hr /></div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2013-08-08 14:39:22 CDT
+Last updated 2013-08-08 15:09:56 CDT
 </div>
 </div>
 </body>


