[Swift-commit] r4357 - www/cookbook
ketan at ci.uchicago.edu
ketan at ci.uchicago.edu
Wed Apr 13 11:26:30 CDT 2011
Author: ketan
Date: 2011-04-13 11:26:30 -0500 (Wed, 13 Apr 2011)
New Revision: 4357
Modified:
www/cookbook/cookbook-asciidoc.html
www/cookbook/cookbook-asciidoc.txt
Log:
added items on cookbook
Modified: www/cookbook/cookbook-asciidoc.html
===================================================================
--- www/cookbook/cookbook-asciidoc.html 2011-04-13 15:13:54 UTC (rev 4356)
+++ www/cookbook/cookbook-asciidoc.html 2011-04-13 16:26:30 UTC (rev 4357)
@@ -590,10 +590,47 @@
</div>
</div>
<div class="sect1">
-<h2 id="_swift_on_8230">2. Swift on …</h2>
+<h2 id="_swift_basics">2. Swift Basics</h2>
<div class="sectionbody">
<div class="sect2">
-<h3 id="_beagle">2.1. Beagle</h3>
+<h3 id="_installation">2.1. Installation</h3>
+<div class="paragraph"><p>Installation instructions</p></div>
+</div>
+<div class="sect2">
+<h3 id="_environment_setup">2.2. Environment Setup</h3>
+<div class="paragraph"><p>Setting up the environment</p></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">The environment will be different when using Swift from prebuilt
+distribution and trunk.</td>
+</tr></table>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_first_swiftscript">2.3. First SwiftScript</h3>
+<div class="paragraph"><p>Your first SwiftScript
+Hello Swift-World!</p></div>
+</div>
+<div class="sect2">
+<h3 id="_second_swiftscript">2.4. Second SwiftScript</h3>
+<div class="paragraph"><p>Your second SwiftScript
+catsn</p></div>
+</div>
+<div class="sect2">
+<h3 id="_swift_commandline_options">2.5. Swift Commandline Options</h3>
+<div class="paragraph"><p>A description of Swift Commandline Options</p></div>
+<div class="paragraph"><p>Also includes a description of Swift inputs and outputs.</p></div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_swift_on_8230">3. Swift on …</h2>
+<div class="sectionbody">
+<div class="sect2">
+<h3 id="_beagle">3.1. Beagle</h3>
<div class="paragraph"><p>Swift is now installed on Beagle as a module. Swift supports a Coasters based,
PBS-enabled computing environment for Beagle. To get started with Swift on
Beagle follow the steps outlined below:</p></div>
@@ -608,43 +645,110 @@
in README of that folder.</p></div>
</div>
<div class="sect2">
-<h3 id="_intrepid_bg_p">2.2. Intrepid-BG/P</h3>
+<h3 id="_intrepid_bg_p">3.2. Intrepid-BG/P</h3>
+<div class="paragraph"><p>Swift on Intrepid-BG/P</p></div>
</div>
<div class="sect2">
-<h3 id="_pads">2.3. PADS</h3>
+<h3 id="_pads">3.3. PADS</h3>
+<div class="paragraph"><p>Swift on PADS</p></div>
</div>
<div class="sect2">
-<h3 id="_osg">2.4. OSG</h3>
+<h3 id="_osg">3.4. OSG</h3>
+<div class="paragraph"><p>Swift on OSG</p></div>
</div>
<div class="sect2">
-<h3 id="_bionimbus">2.5. Bionimbus</h3>
+<h3 id="_bionimbus">3.5. Bionimbus</h3>
+<div class="paragraph"><p>Swift on Bionimbus</p></div>
</div>
<div class="sect2">
-<h3 id="_magellan">2.6. Magellan</h3>
+<h3 id="_magellan">3.6. Magellan</h3>
+<div class="paragraph"><p>Swift on Magellan</p></div>
</div>
</div>
</div>
<div class="sect1">
-<h2 id="_coasters">3. Coasters</h2>
+<h2 id="_coasters">4. Coasters</h2>
<div class="sectionbody">
-<div class="paragraph"><p>How to run Swift under different Coasters configurations.</p></div>
+<div class="paragraph"><p>Describe coasters mechanisms.
+Include neat diagrams.</p></div>
<div class="sect2">
-<h3 id="_manual">3.1. Manual</h3>
+<h3 id="_for_beginners">4.1. For Beginners</h3>
+<div class="paragraph"><p>Coasters for beginners.</p></div>
</div>
<div class="sect2">
-<h3 id="_passive">3.2. Passive</h3>
+<h3 id="_for_intermediate_users">4.2. For Intermediate Users</h3>
+<div class="paragraph"><p>Coasters for intermediate users.</p></div>
</div>
<div class="sect2">
-<h3 id="_persistent">3.3. Persistent</h3>
+<h3 id="_for_advanced_users">4.3. For Advanced Users</h3>
+<div class="paragraph"><p>Coasters for advanced users.</p></div>
</div>
+<div class="sect2">
+<h3 id="_how_to_run_swift_under_different_coasters_configurations">4.4. How to run Swift under different Coasters configurations</h3>
+<div class="sect3">
+<h4 id="_manual">4.4.1. Manual</h4>
+<div class="paragraph"><p>Todo</p></div>
</div>
+<div class="sect3">
+<h4 id="_passive">4.4.2. Passive</h4>
+<div class="paragraph"><p>Todo</p></div>
</div>
+<div class="sect3">
+<h4 id="_persistent">4.4.3. Persistent</h4>
+<div class="paragraph"><p>Todo</p></div>
</div>
+</div>
+<div class="sect2">
+<h3 id="_summary_of_differences_between_different_coaster_types">4.5. Summary of Differences Between different Coaster types</h3>
+<div class="paragraph"><p>A tabular representations of highlights of different coaster setups</p></div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_collective_data_management_cdm_and_jets">5. Collective Data Management (CDM) and JETS</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>CDM and JETS</p></div>
+<div class="sect2">
+<h3 id="_cdm">5.1. CDM</h3>
+<div class="paragraph"><p>todo</p></div>
+</div>
+<div class="sect2">
+<h3 id="_jets">5.2. JETS</h3>
+<div class="paragraph"><p>todo</p></div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_debugging_swift">6. Debugging Swift</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>De-bug.</p></div>
+<div class="sect2">
+<h3 id="_debugging_heuristics_or_where_to_look_when_things_break">6.1. Debugging Heuristics or Where to look when things break</h3>
+<div class="paragraph"><p>Steps to follow to debug Swift</p></div>
+</div>
+<div class="sect2">
+<h3 id="_swift_logging_and_log4j_setup">6.2. Swift Logging and log4j Setup</h3>
+<div class="paragraph"><p>Logging levels for Swift.</p></div>
+</div>
+<div class="sect2">
+<h3 id="_what_if_swift_hangs">6.3. What if Swift hangs?</h3>
+<div class="paragraph"><p>Swift has a built-in hang-checker that chips in when Swift hangs.</p></div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_deprecated_things_of_swift">7. Deprecated things of Swift</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>Notes on things that have been deprecated and may not be supported in the near
+future.</p></div>
+</div>
+</div>
+</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Version 0.92<br />
-Last updated 2011-04-13 00:16:38 CDT
+Last updated 2011-04-13 11:07:15 CDT
</div>
</div>
</body>
Modified: www/cookbook/cookbook-asciidoc.txt
===================================================================
--- www/cookbook/cookbook-asciidoc.txt 2011-04-13 15:13:54 UTC (rev 4356)
+++ www/cookbook/cookbook-asciidoc.txt 2011-04-13 16:26:30 UTC (rev 4357)
@@ -19,8 +19,41 @@
SwiftScript programs are dataflow oriented - they are primarily concerned with processing (possibly large) collections of data files, by invoking programs to do that processing. Swift handles execution of
such programs on remote sites by choosing sites, handling the staging of input and output files to and from the chosen sites and remote execution of program code.
+Swift Basics
+------------
+
+Installation
+~~~~~~~~~~~~
+Installation instructions
+
+Environment Setup
+~~~~~~~~~~~~~~~~~
+
+Setting up the environment
+[NOTE]
+The environment will be different when using Swift from prebuilt
+distribution and trunk.
+
+
+First SwiftScript
+~~~~~~~~~~~~~~~~~
+Your first SwiftScript
+Hello Swift-World!
+
+Second SwiftScript
+~~~~~~~~~~~~~~~~~~~
+Your second SwiftScript
+catsn
+
+Swift Commandline Options
+~~~~~~~~~~~~~~~~~~~~~~~~~
+A description of Swift Commandline Options
+
+Also includes a description of Swift inputs and outputs.
+
Swift on ...
------------
+
Beagle
~~~~~~
Swift is now installed on Beagle as a module. Swift supports a Coasters based,
@@ -42,24 +75,98 @@
Intrepid-BG/P
~~~~~~~~~~~~~
+Swift on Intrepid-BG/P
+
PADS
~~~~
+Swift on PADS
+
OSG
~~~
+Swift on OSG
+
Bionimbus
~~~~~~~~~
+Swift on Bionimbus
+
Magellan
~~~~~~~~
+Swift on Magellan
Coasters
--------
-How to run Swift under different Coasters configurations.
+Describe coasters mechanisms.
+Include neat diagrams.
+
+For Beginners
+~~~~~~~~~~~~~~
+Coasters for beginners.
+
+For Intermediate Users
+~~~~~~~~~~~~~~~~~~~~~~~
+Coasters for intermediate users.
+
+For Advanced Users
+~~~~~~~~~~~~~~~~~~~
+Coasters for advanced users.
+
+
+How to run Swift under different Coasters configurations
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
Manual
-~~~~~~
+^^^^^^^
+Todo
+
Passive
-~~~~~~~
+^^^^^^^^
+Todo
+
Persistent
-~~~~~~~~~~
+^^^^^^^^^^^
+Todo
+Summary of Differences Between different Coaster types
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A tabular representations of highlights of different coaster setups
+
+Collective Data Management (CDM) and JETS
+--------------------------------------------
+CDM and JETS
+
+CDM
+~~~~
+
+todo
+
+JETS
+~~~~~
+
+todo
+
+Debugging Swift
+---------------
+
+De-bug.
+
+Debugging Heuristics or Where to look when things break
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Steps to follow to debug Swift
+
+Swift Logging and log4j Setup
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Logging levels for Swift.
+
+What if Swift hangs?
+~~~~~~~~~~~~~~~~~~~~~
+
+Swift has a built-in hang-checker that chips in when Swift hangs.
+
+
+Deprecated things of Swift
+---------------------------
+Notes on things that have been deprecated and may not be supported in the near
+future.
+
More information about the Swift-commit
mailing list