[Swift-commit] r6286 - in trunk/docs: userguide utils
ketan at ci.uchicago.edu
ketan at ci.uchicago.edu
Sun Feb 17 18:39:04 CST 2013
Author: ketan
Date: 2013-02-17 18:39:03 -0600 (Sun, 17 Feb 2013)
New Revision: 6286
Modified:
trunk/docs/userguide/transformation_catalog
trunk/docs/utils/gensites.txt
Log:
minor improvements
Modified: trunk/docs/userguide/transformation_catalog
===================================================================
--- trunk/docs/userguide/transformation_catalog 2013-02-16 16:38:43 UTC (rev 6285)
+++ trunk/docs/userguide/transformation_catalog 2013-02-18 00:39:03 UTC (rev 6286)
@@ -8,12 +8,12 @@
Swift configuration file or on the command line.
The format is one line per executable per site, with fields separated by
-tabs.
+tab or space.
Some example entries:
----
-localhost echo /bin/echo INSTALLED INTEL32::LINUX null
-TGUC touch /usr/bin/touch INSTALLED INTEL32::LINUX GLOBUS::maxwalltime="0:1"
+localhost echo /bin/echo INSTALLED INTEL32::LINUX null
+TGUC touch /usr/bin/touch INSTALLED INTEL32::LINUX GLOBUS::maxwalltime="0:1"
----
The fields are: site, transformation name, executable path, installation
@@ -40,7 +40,7 @@
the following application sets an environment variable called R_LIBS to
/home/user/R_libs.
-----
-localhost R /usr/bin/R INSTALLED INTEL32::LINUX env::R_LIBS=/home/user/r_libs
+localhost R /usr/bin/R INSTALLED INTEL32::LINUX env::R_LIBS=/home/user/r_libs
-----
Setting Multiple Profiles
@@ -49,5 +49,5 @@
sets two environment variables: R_LIBS and R_HOME.
-----
-localhost R /usr/bin/R INSTALLED INTEL32::LINUX env::R_LIBS=/home/user/r_libs;env::R_HOME=/home/user/r
+localhost R /usr/bin/R INSTALLED INTEL32::LINUX env::R_LIBS=/home/user/r_libs;env::R_HOME=/home/user/r
-----
Modified: trunk/docs/utils/gensites.txt
===================================================================
--- trunk/docs/utils/gensites.txt 2013-02-16 16:38:43 UTC (rev 6285)
+++ trunk/docs/utils/gensites.txt 2013-02-18 00:39:03 UTC (rev 6286)
@@ -9,8 +9,8 @@
--------
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
+to generate a sites.xml file for running a Swift script on a given
+site. It accomplishes this by using site 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.
@@ -25,21 +25,25 @@
You should see output similar to this:
-----
+beagle
+beagle-ssh
intrepid
local
-local-pbs-coasters
+midway
pads
+persistent-coasters
queenbee
sge-local
-ssh
ssh-pbs-coasters
+stampede
surveyor
+uc3
-----
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
+ssh-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
@@ -50,19 +54,19 @@
$ 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.
+Running this command will print the contents of sites.xml file corresponding to
+the template and give you an idea of what settings you will need to specify.
-The required tokens are required to properly use the templates. These are
-placeholder values you will need to specify in the following steps.
+The 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.
+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:
@@ -71,9 +75,8 @@
#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:
+For 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
@@ -119,7 +122,7 @@
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
+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.
-----
@@ -159,18 +162,19 @@
to the swift.properties, use:
-----
-$ gensites surveyor -p myswift.properties > myconfig.xml
+$ gensites surveyor -p myswift.properties > sites.surveyor.xml
-----
-Next, provide the configuration filename to swift:
+Next, provide the configuration filename to Swift:
-----
-$ swift -sites.file myconfig.xml myscript.swift
+$ swift -sites.file sites.surveyor.xml myscript.swift
-----
Alternatively, if you have specified applications, be sure to load that into
-Swift
+Swift:
+
-----
-$ swift -sites.file myconfig.xml -tc.file tc.data mycript.swift
+$ swift -sites.file sites.surveyor.xml -tc.file tc.data mycript.swift
-----
Providing Default Values for All Templates
More information about the Swift-commit
mailing list