[Swift-commit] r5454 - in branches/release-0.93/docs: cookbook cookbook/.cache documentation documentation/.cache quickstart quickstart/.cache siteguide siteguide/.cache tutorial tutorial/.cache userguide userguide/.cache utils utils/.cache
ketan at ci.uchicago.edu
ketan at ci.uchicago.edu
Tue Dec 20 16:34:40 CST 2011
Author: ketan
Date: 2011-12-20 16:34:40 -0600 (Tue, 20 Dec 2011)
New Revision: 5454
Added:
branches/release-0.93/docs/cookbook/.cache/
branches/release-0.93/docs/cookbook/.cache/cookbook.txt
branches/release-0.93/docs/documentation/.cache/
branches/release-0.93/docs/documentation/.cache/documentation.txt
branches/release-0.93/docs/quickstart/.cache/
branches/release-0.93/docs/quickstart/.cache/quickstart.txt
branches/release-0.93/docs/siteguide/.cache/
branches/release-0.93/docs/siteguide/.cache/siteguide.txt
branches/release-0.93/docs/tutorial/.cache/
branches/release-0.93/docs/tutorial/.cache/tutorial.txt
branches/release-0.93/docs/userguide/.cache/
branches/release-0.93/docs/userguide/.cache/userguide.txt
branches/release-0.93/docs/utils/.cache/
branches/release-0.93/docs/utils/.cache/gensites.txt
Log:
commiting cache dirs
Added: branches/release-0.93/docs/cookbook/.cache/cookbook.txt
===================================================================
--- branches/release-0.93/docs/cookbook/.cache/cookbook.txt (rev 0)
+++ branches/release-0.93/docs/cookbook/.cache/cookbook.txt 2011-12-20 22:34:40 UTC (rev 5454)
@@ -0,0 +1,16 @@
+Swift Cookbook
+==============
+Swift team <swift-user at ci.uchicago.edu>
+v0.92, March 2011
+
+include::overview[]
+
+include::swift_basics[]
+
+include::coasters[]
+
+include::diverse_infrastructures[]
+
+include::debugging_swift[]
+
+include::log_processing[]
Added: branches/release-0.93/docs/documentation/.cache/documentation.txt
===================================================================
--- branches/release-0.93/docs/documentation/.cache/documentation.txt (rev 0)
+++ branches/release-0.93/docs/documentation/.cache/documentation.txt 2011-12-20 22:34:40 UTC (rev 5454)
@@ -0,0 +1,11 @@
+Swift Document Generation
+=========================
+
+include::overview[]
+
+include::structure[]
+
+include::building[]
+
+include::automation[]
+
Added: branches/release-0.93/docs/quickstart/.cache/quickstart.txt
===================================================================
--- branches/release-0.93/docs/quickstart/.cache/quickstart.txt (rev 0)
+++ branches/release-0.93/docs/quickstart/.cache/quickstart.txt 2011-12-20 22:34:40 UTC (rev 5454)
@@ -0,0 +1,101 @@
+Swift Quickstart
+================
+
+[abstract]
+Abstract
+--------
+This guide describes the steps needed to download, install, configure,
+and run the basic examples for Swift. If you are using a pre-installed
+version of Swift, you can skip directly to the configuration section.
+
+Stable Releases vs. Development Releases
+----------------------------------------
+Stable releases of Swift have undergone more extensive testing than development releases.
+In general, they are more stable, have fewer bugs, and have been tested on a variety of
+systems.
+
+The development version of Swift is aimed at developers and testers. The development
+code has the highest chance of containing buggy and untested code. If you need stability
+please use the latest stable release.
+
+Downloading a Swift Distribution
+--------------------------------
+There are two main ways of getting the Swift implementation: binary
+releases and the source repository.
+
+Binary Releases
+~~~~~~~~~~~~~~~
+For the majority of users, downloading and installing binary releases is recommended.
+Since Swift is written in Java, the binary packages will run on all supported platforms with
+Java Runtime Environment 1.5 or greater. Binary releases can be obtained from the
+http://www.ci.uchicago.edu/swift/downloads/index.php[Swift downloads page].
+
+Once downloaded, simply unpack the downloaded package (swift-<version>.tar.gz) into a
+directory of your choice:
+
+-----
+tar -xzvf swift-<version>.tar.gz
+-----
+
+This will create a swift-<version> directory containing the build.
+
+Source Repository
+~~~~~~~~~~~~~~~~~
+The source code for Swift is available to developers who have an interest in contributing
+new features. To build Swift from source code, you will need http://ant.apache.org/[Apache Ant]
+and http://www.oracle.com/technetwork/java/javase/downloads/index.html[Java JDK]. Once
+built, the dist/swift-svn directory will contain your build.
+
+To download and build Swift 0.93, follow these instructions:
+-----
+$ mkdir swift-0.93
+$ cd swift-0.93
+$ svn co https://cogkit.svn.sourceforge.net/svnroot/cogkit/branches/4.1.9/src/cog
+$ cd cog/modules
+$ svn co https://svn.ci.uchicago.edu/svn/vdl2/branches/release-0.93 swift
+$ cd swift
+$ ant redist
+-----
+
+Setting your PATH
+-----------------
+Once Swift is installed, it is useful to add the swift binary to your PATH
+environment variable. To do this, first determine where the Swift bin
+directory is located. If you installed Swift from a binary release, it will
+be in the swift-0.93/bin directory where you installed it. If you followed
+the instructions above for installing Swift from a source repository, it
+will be located in swift-0.93/cog/modules/swift/dist/swift-svn/bin.
+
+Add the following line to the bottom of ~/.bashrc:
+
+-----
+export PATH=$PATH:/full/path/to/swift
+-----
+
+When you login, test this out by typing the command
+-----
+$ which swift
+-----
+
+This should point you to the path of the Swift binary.
+
+Running Swift Examples
+----------------------
+The Swift examples can be found in the examples directory in the Swift
+distribution. The examples are written in the SwiftScript language, and
+have .swift as a file extension.
+
+Execution of a Swift workflow is done using the swift command, which
+takes the Swift workflow file name as an argument:
+
+-----
+cd examples/tutorial
+swift hello.swift
+-----
+
+When you run this application, it should create a file called hello.txt.
+If this file gets created, you have successfully ran your first
+Swift script!
+
+More documentation on how to run Swift can be found at
+http://www.ci.uchicago.edu/swift/docs/index.php,
Added: branches/release-0.93/docs/siteguide/.cache/siteguide.txt
===================================================================
--- branches/release-0.93/docs/siteguide/.cache/siteguide.txt (rev 0)
+++ branches/release-0.93/docs/siteguide/.cache/siteguide.txt 2011-12-20 22:34:40 UTC (rev 5454)
@@ -0,0 +1,21 @@
+Site Configuration Guide
+========================
+
+:toc:
+:icons:
+:website: http://www.ci.uchicago.edu/swift/guides/siteguide.php
+:numbered:
+
+include::prereqs[]
+
+include::pads[]
+
+include::fusion[]
+
+include::beagle[]
+
+include::futuregrid[]
+
+include::mcs[]
+
+include::intrepid[]
Added: branches/release-0.93/docs/tutorial/.cache/tutorial.txt
===================================================================
--- branches/release-0.93/docs/tutorial/.cache/tutorial.txt (rev 0)
+++ branches/release-0.93/docs/tutorial/.cache/tutorial.txt 2011-12-20 22:34:40 UTC (rev 5454)
@@ -0,0 +1,17 @@
+A Swift Tutorial
+================
+
+:toc:
+:icons:
+:website: http://www.ci.uchicago.edu/swift/guides/tutorial.php
+:numbered:
+
+include::introduction[]
+
+include::hello_world[]
+
+include::language_features[]
+
+include::runtime_features[]
+
+include::bits[]
Added: branches/release-0.93/docs/userguide/.cache/userguide.txt
===================================================================
--- branches/release-0.93/docs/userguide/.cache/userguide.txt (rev 0)
+++ branches/release-0.93/docs/userguide/.cache/userguide.txt 2011-12-20 22:34:40 UTC (rev 5454)
@@ -0,0 +1,41 @@
+Swift User Guide
+================
+
+:toc:
+:icons:
+:website: http://www.ci.uchicago.edu/swift/guides/userguide.php
+:numbered:
+
+include::overview[]
+
+include::language[]
+
+include::mappers[]
+
+include::commands[]
+
+include::app_procedures[]
+
+include::configuration_properties[]
+
+include::profiles[]
+
+include::site_catalog[]
+
+include::transformation_catalog[]
+
+include::build_options[]
+
+include::kickstart[]
+
+include::reliability_mechanisms[]
+
+include::clustering[]
+
+include::coasters[]
+
+include::howto_tips[]
+
+include::cdm[]
+
+include::log-processing[]
Added: branches/release-0.93/docs/utils/.cache/gensites.txt
===================================================================
--- branches/release-0.93/docs/utils/.cache/gensites.txt (rev 0)
+++ branches/release-0.93/docs/utils/.cache/gensites.txt 2011-12-20 22:34:40 UTC (rev 5454)
@@ -0,0 +1,235 @@
+Gensites
+==========
+:toc:
+:icons:
+:website: http://www.ci.uchicago.edu/swift
+:numbered:
+
+Overview
+--------
+To simplify this configuration process, versions of Swift starting with
+0.92 include a utility called gensites. The gensites command is used
+to generate a sites.xml file for running a swift workflow on a given
+site. It accomplishes this by using a series of templates. The templates
+used by gensites are the same templates used for internal testing, so
+they are likely up to date and known to work on a given site.
+
+
+Viewing All Available Site Templates
+------------------------------------
+To view a list of all available templates, run the following command:
+
+-----
+$ gensites -T
+-----
+
+You should see output similar to this:
+-----
+intrepid
+local
+local-pbs-coasters
+pads
+queenbee
+sge-local
+ssh
+ssh-pbs-coasters
+surveyor
+-----
+
+You will notice that the templates can be specific to a particular set
+of machines like Intrepid and Queenbee, or they may be more general and
+aim to work across a variety of machines, as in the case of
+local-pbs-coasters. Gensites will look in three directories for available
+templates: your current directory, $SWIFT_HOME/etc/sites and $HOME/.swift/sites.
+
+Listing the Template
+--------------------
+To view the contents of a template, type:
+
+-----
+$ gensites -l templatename
+-----
+
+Running this command will print some information about the template and give
+you an idea of what settings you will need to specify. You should see
+something like this:
+
+-----
+Description: Template for Intrepid. More information about this system can be found at http://www.alcf.anl.gov/support/gettingstarted/index.php
+Required Tokens: host work project queue
+-----
+
+The required tokens are required to properly use the templates. These are placeholder
+values you will need to specify in the
+following steps.
+
+Providing Site Specific Values
+------------------------------
+
+The gensites script needs to know how to replace the placeholder values
+in the template. This is done by configuring the swift.properties file.
+Gensites will first look for a swift.properties file in the current
+directory. If it does not exist, it will next look in $HOME/.swift.
+
+To add site specific values to swift.properties, add a line in the
+follow format:
+
+-----
+#site templatename setting=value
+-----
+
+Continuing the previous example, here is what you could add to
+swift.properties to replace the values of project, queue and work for
+the surveyor template:
+
+-----
+#site surveyor project=MyProject
+#site surveyor queue=MyQueue
+#site surveyor work=/path/to/workdir
+-----
+
+Now, running the command 'gensites surveyor' will produce the following
+valid configuration file:
+
+-----
+<config>
+ <pool handle="surveyor">
+ <filesystem provider="local" />
+ <execution provider="coaster" jobmanager="local:cobalt"/>
+ <profile namespace="globus" key="project">MyProject</profile>
+ <profile namespace="globus" key="queue">MyQueue</profile>
+ <profile namespace="globus" key="kernelprofile">zeptoos</profile>
+ <profile namespace="globus" key="alcfbgpnat">true</profile>
+ <profile namespace="karajan" key="jobthrottle">21</profile>
+ <profile namespace="karajan" key="initialScore">10000</profile>
+ <profile namespace="globus" key="workersPerNode">1</profile>
+ <profile namespace="globus" key="workerLoggingLevel">DEBUG</profile>
+ <profile namespace="globus" key="slots">1</profile>
+ <profile namespace="globus" key="maxTime">900</profile>
+ <profile namespace="globus" key="nodeGranularity">64</profile>
+ <profile namespace="globus" key="maxNodes">64</profile>
+ <workdirectory>/path/to/workdir</workdirectory>
+ </pool>
+</config>
+-----
+
+Generating Application Configurations with Gensites
+---------------------------------------------------
+Gensites can also be used to create a valid application catalog, commonly
+called tc.data. Here are some examples of how to specify applications within
+your swift.properties file:
+
+-----
+#app intrepid echo=/usr/bin/echo
+-----
+
+This first example shows a site specific application. The #app definition
+tells gensites this is related to an application rather than a #site
+definition. In the second part, echo=/usr/bin/echo, the left hand side
+is the name of the application that will be called from within swift. The
+right hand site is the path name which points to the binary.
+
+-----
+#app intrepid echo=$HOME/bin/echo
+-----
+
+Environment variables will be interpreted and converted to full path names
+for Swift.
+
+-----
+#app intrepid echo=bin/echo
+-----
+
+Gensites can take relative paths (relative to your current directory) and
+translate them to full path names for Swift.
+
+WARNING: Running gensites with #app definitions will replace any file
+called tc.data in your current directory. If a file called tc.data exists,
+it will be renamed to tc.data.old. If you run gensites twice, the original
+contents of your tc.data will be lost. Please either rename your tc file
+or copy to a different location.
+
+Running Swift With the New Configuration
+----------------------------------------
+
+Now that the gensites is configured and producing a valid configuration
+file, Swift needs to know to use it. The first step is to create a
+unique config file based on the preferences you specified.
+
+-----
+$ gensites surveyor > myconfig.xml
+-----
+
+This will send the output of gensites to myconfig.xml. This example will
+use a swift.properties location in the default directories (your current
+directory, ~/.swift/swift.properties). To specify a different location
+to the swift.properties, use:
+
+-----
+$ gensites surveyor -p myswift.properties > myconfig.xml
+-----
+
+Next, provide the configuration filename to swift:
+-----
+$ swift -sites.file myconfig.xml myscript.swift
+-----
+
+Alternatively, if you have specified applications, be sure to load that into
+Swift
+-----
+$ swift -sites.file myconfig.xml -tc.file tc.data mycript.swift
+-----
+
+Providing Default Values for All Templates
+------------------------------------------
+It is also possible to specify a default value for a setting, regardless
+of template you use. If you want to set your queue to default to "fast"
+across all templates, you can do this by omitting the template name.
+Consider the following swift.properties:
+
+-----
+#site queue=fast
+#site surveyor project=MyProject
+#site surveyor work=/path/to/workdir
+-----
+By omitting the template name, the default value for queue on surveyor
+(and any other template you use) will be set to "fast". One thing to
+keep in mind when setting default values is that order matters. Be sure
+to set your default values first before setting template specific values.
+
+Just like the #site definitions, when a site name is not specified, an app
+will be created for every site that is defined in your template.
+-----
+#app echo=/bin/echo
+-----
+
+More Help
+---------
+The gensites script provides additional options not discussed here, such
+as using templates and swift.properties in non-standard directories. For
+more information, run gensites -h. Here is a full list of all options
+available.
+
+-----
+$ gensites -help
+
+ usage: gensites template [-p properties.file] [-L template_directory] [-h] [-T] [-l]
+
+ template Name of template to use
+ -p properties.file Specify a swift.properties to use
+ -L template_directory Specify a non-standard template directory
+ -T List all templates available
+ -h Help / usage information
+ -l List the contents of a specific template
+
+ Examples:
+
+ Create a site configuration file for sites.xml using default properties.file in current directory
+ $ gensites pads > sites.xml
+
+ Use a specific properties file for a site
+ $ gensites -p sites.properties pads > sites.xml
+
+ Specify a non-standard directory where templates are located
+ $ gensites -L template.dir pads > sites.xml
+-----
More information about the Swift-commit
mailing list