[Swift-commit] r8442 - www/Swift-T

[wozniak at ci.uchicago.edu]

Author: wozniak
Date: 2015-04-29 15:08:40 -0500 (Wed, 29 Apr 2015)
New Revision: 8442

Modified:
   www/Swift-T/turbine-sites.html
Log:
Document TURBINE_OUTPUT_FORMAT


Modified: www/Swift-T/turbine-sites.html
===================================================================
--- www/Swift-T/turbine-sites.html	2015-04-29 19:52:28 UTC (rev 8441)
+++ www/Swift-T/turbine-sites.html	2015-04-29 20:08:40 UTC (rev 8442)
@@ -768,6 +768,19 @@
 this, you should run <code>swift-t</code> or <code>turbine</code> under the <code>nice</code> command.
 It will affect other users so please be cautious when using this mode
 for debugging.</p></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<div class="title">Tip</div>
+</td>
+<td class="content">When running on a big HPC machine, it may be difficult to get STC
+(a Java-based program) running.  STC output (<code>program.tic</code>) is
+platform-independent.  You may run STC to develop and debug your
+script on your local workstation, then simply copy <code>program.tic</code> to
+the big machine for execution.  Just make sure that the STC and
+Turbine versions are compatible (the same release number).</td>
+</tr></table>
+</div>
 <div class="sect2">
 <h3 id="_public_installations">Public installations</h3>
 <div class="paragraph"><p>These are maintained by the Swift/T team.  Because they may become out
@@ -986,6 +999,15 @@
 automatically create <code>TURBINE_OUTPUT</code> if necessary
 </p>
 </dd>
+<dt class="hdlist1">
+<code>TURBINE_OUTPUT_FORMAT</code>
+</dt>
+<dd>
+<p>
+Allows customization of the automatic
+output directory creation.  See <a href="#turbine_output">Turbine output</a>
+</p>
+</dd>
 </dl></div>
 </div>
 <div class="sect2">
@@ -1088,29 +1110,33 @@
 </dl></div>
 </div>
 <div class="sect2">
-<h3 id="_turbine_output_directory">Turbine output directory</h3>
+<h3 id="turbine_output">Turbine output directory</h3>
 <div class="paragraph"><p>The working directory (<code>PWD</code>) for the job is called <code>TURBINE_OUTPUT</code>.</p></div>
-<div class="paragraph"><p>If the user does not set this variable, Turbine will select one based on the date
-and report it.  The automatically selected directory will be placed
-under <code>TURBINE_OUTPUT_ROOT</code>, which defaults to <code>$HOME/turbine-output</code>.
-The user program will be copied to <code>TURBINE_OUTPUT</code> before submission.
-Standard output and error goes to <code>TURBINE_OUTPUT/output.txt</code>.</p></div>
-<div class="admonitionblock">
-<table><tr>
-<td class="icon">
-<div class="title">Tip</div>
-</td>
-<td class="content">When running on a big HPC machine, it may be difficult to get STC
-(a Java-based program) running.  STC output (<code>program.tic</code>) is
-platform-independent.  You may run STC to develop and debug your
-script on your local workstation, then simply copy <code>program.tic</code> to
-the big machine for execution.  Just make sure that the STC and
-Turbine versions are compatible (the same release number).</td>
-</tr></table>
+<div class="paragraph"><p>If the user does not set this variable, Turbine will select one based
+on the date and report it.  The automatically selected directory will
+be placed under <code>TURBINE_OUTPUT_ROOT</code>, which defaults to
+<code>$HOME/turbine-output</code>.  The user program will be copied to
+<code>TURBINE_OUTPUT</code> before submission.  Standard output and error goes to
+<code>TURBINE_OUTPUT/output.txt</code>.</p></div>
+<div class="paragraph"><p>The automatically created Turbine output directory <code>TURBINE_OUTPUT</code> is
+generated by passing <code>TURBINE_OUTPUT_FORMAT</code> to the <code>date</code> command.
+The default value is <code>%Y/%m/%d/%H/%M/%S</code>, that is,
+<code>year/month/day/hour/minute/second</code> (see <code>man date</code> for more options).
+An additional option is provided by Turbine is <code>%Q</code>, which puts a
+unique number in that spot.  <code>TURBINE_OUTPUT_PAD</code> sets the minimum
+field width of the integer put into the spot, defaulting to 3.</p></div>
+<div class="paragraph"><p>For example, on a Wednesday, <code>TURBINE_OUTPUT_ROOT=/scratch</code>,
+<code>TURBINE_OUTPUT_FORMAT=%A/%Q</code>, <code>TURBINE_OUTPUT_PAD=1</code> would run
+subsequent Swift/T jobs in:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><code>/scratch/Wednesday/1
+/scratch/Wednesday/2
+/scratch/Wednesday/3</code></pre>
+</div></div>
 </div>
 </div>
 </div>
-</div>
 <div class="sect1">
 <h2 id="_x86_clusters">x86 clusters</h2>
 <div class="sectionbody">
@@ -2432,7 +2458,7 @@
 <div id="footer">
 <div id="footer-text">
 Version 0.8.0<br />
-Last updated 2015-04-29 14:52:39 CDT
+Last updated 2015-04-29 15:06:21 CDT
 </div>
 </div>
 </body>