[Swift-commit] r6407 - trunk/docs/siteguide
ketan at ci.uchicago.edu
ketan at ci.uchicago.edu
Tue Mar 26 13:47:51 CDT 2013
Author: ketan
Date: 2013-03-26 13:47:50 -0500 (Tue, 26 Mar 2013)
New Revision: 6407
Modified:
trunk/docs/siteguide/fusion
trunk/docs/siteguide/futuregrid
trunk/docs/siteguide/intrepid
Log:
updates and refinement
Modified: trunk/docs/siteguide/fusion
===================================================================
--- trunk/docs/siteguide/fusion 2013-03-25 19:22:57 UTC (rev 6406)
+++ trunk/docs/siteguide/fusion 2013-03-26 18:47:50 UTC (rev 6407)
@@ -1,10 +1,10 @@
Fusion (x86 cluster)
-------------------
-Fusion is a 320-node computing cluster for the Argonne
-National Laboratory community. The primary goal of the LCRC is to
-facilitate mid-range computing in all of the scientific programs of
-Argonne and the University of Chicago.
+Fusion is a 320-node computing cluster for the Argonne's Laboratory Computing
+Resource Center (LCRC). The primary goal of the LCRC is to facilitate mid-range
+computing in all of the scientific programs of Argonne and the University of
+Chicago.
This section will walk you through running a simple Swift script
on Fusion.
@@ -30,9 +30,10 @@
SSH Keys
~~~~~~~~
Before accessing Fusion, be sure to have your SSH keys configured correctly.
-SSH keys are required to access fusion. You should see information about
-this when you request your account. Email support at lcrc.anl.gov for
-additional help.
+SSH keys are required to access fusion. You should see information about this
+when you request your account. Check
+link:http://wiki.mcs.anl.gov/IT/index.php/SSH_keys[ssh FAQ] or email
+support at lcrc.anl.gov for additional help.
Connecting to a login node
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -40,17 +41,17 @@
node with the following command:
-----
-ssh yourusername at fusion.lcrc.anl.gov
+ssh <yourusername>@fusion.lcrc.anl.gov
-----
Creating sites.xml
~~~~~~~~~~~~~~~~~~
-Swift relies on various configuration files to determine how to
-run. This section will provide a working configuration file which
+Swift uses various configuration files to determine how to
+run an application. This section will provide a working configuration file which
you can copy and paste to get running quickly. The sites.xml file
tells Swift how to submit jobs, where working directories are
located, and various other configuration information. More
-information on sites.xml can be found in the Swift User's Guide.
+information on sites.xml can be found in the Swift link:http://www.ci.uchicago.edu/swift/guides/trunk/userguide/userguide.html[user guide].
The first step is to paste the text below into a file named sites.xml.
@@ -60,18 +61,19 @@
This file will require one customization. Create a
directory called swiftwork. Modify \_WORK_ in sites.xml
-to point to this new directory. For example
+to point to a new directory. For example
+
-----
-<workdirectory>/home/myhome/swiftwork</workdirectory>
+<workdirectory>/tmp/swiftwork</workdirectory>
-----
-Creating tc.data
-~~~~~~~~~~~~~~~~
-The tc.data configuration file gives information about the applications
+Creating tc
+~~~~~~~~~~~
+The tc configuration file gives information about the applications
that will be called by Swift. More information about the format
-of tc.data can be found in the Swift User's guide.
+of tc can be found in the Swift user guide.
-Paste the following example into a file named tc.data
+Paste the following example into a file named tc
-----
include::../../tests/providers/fusion/coasters/tc.template.data[]
@@ -79,22 +81,26 @@
Copy a Swift Script
~~~~~~~~~~~~~~~~~~~~
-Within the Swift directory is an examples directory which contains
-several introductory Swift scripts. The example we will use in this
-section is called catsn.swift. Copy this script to the same directory
-that your sites.xml and tc.data files are located.
+Within the Swift directory is an examples directory which contains several
+introductory Swift scripts. The example we will use in this section is called
+catsn.swift. The script copies input file's content to another file using the
+Unix cat utility. Copy this script to the same directory that your sites.xml
+and tc.data files are located.
-----
$ cp ~/swift/examples/misc/catsn.swift .
$ cp ~/swift/examples/misc/data.txt .
-----
-TIP: The location of your swift directory may vary depending on how you installed it. Change this to the examples/misc directory of your installation as needed.
+TIP: The location of your swift directory may vary depending on how you
+installed it. Change this to the examples/misc directory of your installation
+as needed.
+
Run Swift
~~~~~~~~~
Finally, run the script
-----
-$ swift -sites.file sites.xml -tc.file tc.data catsn.swift
+$ swift -sites.file sites.xml -tc.file tc catsn.swift
-----
You should see 10 new text files get created, named catsn*.out. If
@@ -118,7 +124,10 @@
More Help
~~~~~~~~~
-The best place for additional help is the Swift user mailing list. You can subscribe to this list at
-https://lists.ci.uchicago.edu/cgi-bin/mailman/listinfo/swift-user. When submitting information, please send your sites.xml file, your tc.data, and any Swift log files that were created during your attempt.
+The best place for additional help is the Swift user mailing list. You can
+subscribe to this list at
+link:https://lists.ci.uchicago.edu/cgi-bin/mailman/listinfo/swift-user[swift-user].
+When submitting information, send your sites.xml file, your tc.data, and
+any Swift log files that were created during your attempt.
Modified: trunk/docs/siteguide/futuregrid
===================================================================
--- trunk/docs/siteguide/futuregrid 2013-03-25 19:22:57 UTC (rev 6406)
+++ trunk/docs/siteguide/futuregrid 2013-03-26 18:47:50 UTC (rev 6407)
@@ -9,12 +9,12 @@
physical clusters. We use the resources offered by one such cluster via the
Nebula middleware.
-More information on futuregrid can be found at https://portal.futuregrid.org/.
+More information on futuregrid can be found link:https://portal.futuregrid.org/[here].
Requesting Futuregrid Access
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you do not already have a futuregrid account, you can follow the
-instructions at https://portal.futuregrid.org/gettingstarted to get started.
+instructions link:https://portal.futuregrid.org/gettingstarted[here] to get started.
This page provides information on how to create an account, how to join
a project, how to set up your SSH keys, and how to create a new project.
@@ -31,11 +31,13 @@
Download your Credentials
~~~~~~~~~~~~~~~~~~~~~~~~~
Run the following commands to retrieve your credentials:
+
-----
$ cd swift-vm-boot
$ scp yourusername at hotel.futuregrid.org:nimbus_creds.tar.gz .
$ tar xvfz nimbus_creds.tar.gz
-----
+
When you extract your credential file, look at the file called
hotel.conf. Near the bottom of this file will be two settings
called vws.repository.s3id and vws.repository.s3key. Copy these
Modified: trunk/docs/siteguide/intrepid
===================================================================
--- trunk/docs/siteguide/intrepid 2013-03-25 19:22:57 UTC (rev 6406)
+++ trunk/docs/siteguide/intrepid 2013-03-26 18:47:50 UTC (rev 6407)
@@ -1,17 +1,16 @@
Intrepid (Blue Gene/P)
---------------------
+Intrepid is an IBM Blue Gene/P (BG/p) supercomputer located at the Argonne
+Leadership Computing Facility. More information on Intrepid can be found at
+http://www.alcf.anl.gov. Surveyor and Challenger are similar, smaller
+machines.
-Intrepid is an IBM Blue Gene/P supercomputer located at the Argonne
-Leadership Computing Facility. More information on Intrepid can be
-found at http://www.alcf.anl.gov. Surveyor and Challenger are
-similar, smaller machines.
-
Requesting Access
~~~~~~~~~~~~~~~~~
-If you do not already have an account on Intrepid, you can request
-one at https://accounts.alcf.anl.gov/accounts/request.php. More information about
-this process and requesting allocations for your project can be found at
-http://www.alcf.anl.gov/support/gettingstarted/index.php.
+If you do not already have an account on Intrepid, you can request one
+link:https://accounts.alcf.anl.gov/accounts/request.php[here]. More information
+about this process and requesting allocations for your project can be found
+link:http://www.alcf.anl.gov/support/gettingstarted/index.php[here].
SSH Keys
~~~~~~~~
@@ -80,7 +79,7 @@
-----
/home/username/swiftwork
/home/username/work
-/tmp
+/tmp/swift.work
-----
Which project(s) are you a member of?
@@ -122,7 +121,7 @@
Now that you know what queue to use, your project, and your work
directory, it is time to set up Swift. Swift uses a configuration file
-called sites.xml to determine how it should run. There are two
+called sites.xml to determine how it should run. There are two
methods you can use for creating this file. You can manually edit the
configuration file, or generate it with a utility called +gensites+.
@@ -190,9 +189,9 @@
More Help
~~~~~~~~~
The best place for additional help is the Swift user mailing list. You can
-subscribe to this list at
-https://lists.ci.uchicago.edu/cgi-bin/mailman/listinfo/swift-user. When
-submitting information, send your sites.xml file, your tc.data, and any Swift
-log files that were created during your attempt.
+subscribe to this
+link:https://lists.ci.uchicago.edu/cgi-bin/mailman/listinfo/swift-user[list].
+When submitting information, send your sites.xml file, your tc.data, and any
+Swift log files that were created during your attempt.
More information about the Swift-commit
mailing list