~ubuntu-branches/ubuntu/vivid/cctools/vivid

« back to all changes in this revision

Viewing changes to doc/man/maker_wq.m4

  • Committer: Package Import Robot
  • Author(s): Michael Hanke
  • Date: 2012-03-30 12:40:01 UTC
  • mfrom: (9.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20120330124001-ze0lhxm5uwq2e3mo
Tags: 3.4.2-2
Added patch to handle a missing CFLAGS variable in Python's sysconfig
report (Closes: #661658).

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
include(manual.h)dnl
 
2
HEADER(maker_wq)
 
3
 
 
4
SECTION(NAME) 
 
5
BOLD(maker_wq) - Run the Maker genome annotation tool using Work Queue to harness heterogenous resources 
 
6
 
 
7
SECTION(SYNOPSIS)
 
8
CODE(BOLD(maker_wq [options] <maker_opts> <maker_bopts> <maker_exe> ))
 
9
 
 
10
SECTION(DESCRIPTION)
 
11
BOLD(maker_wq) is a master script to run the Maker genome annotation tool using Work Queue to enable the user to harness the heterogenous power of multiple systems simultaneously. It accepts all of the Maker inputs. The primary difference is that the MPI code has been replaced with Work Queue components. 
 
12
PARA
 
13
BOLD(maker_wq) expects a maker_wq_worker in the path, and can be used from any working directory. All required input files are specified in the standard Maker control files just as in the standard Maker distribution. 
 
14
 
 
15
SECTION(OPTIONS)
 
16
OPTIONS_BEGIN
 
17
OPTION_PAIR(-port, port) Specify the port on which to create the Work Queue
 
18
OPTION_PAIR(-fa, fast_abort) Specify a fast abort multiplier
 
19
OPTION_PAIR(-N, project) Specify a project name for utilizing shared workers
 
20
OPTIONS_END
 
21
 
 
22
SECTION(EXIT STATUS)
 
23
On success, returns zero.  On failure, returns non-zero.
 
24
 
 
25
SECTION(ENVIRONMENT VARIABLES)
 
26
 
 
27
SECTION(EXAMPLES)
 
28
 
 
29
To run maker_wq, specify the same arguments as standard Maker:
 
30
LONGCODE_BEGIN
 
31
maker_wq maker_opts.ctl maker_bopts.ctl maker_exe.ctl > output
 
32
LONGCODE_END
 
33
This will begin the Maker run. All that is needed now is to submit workers that can be accessed by our master.
 
34
 
 
35
SECTION(COPYRIGHT)
 
36
 
 
37
COPYRIGHT_BOILERPLATE
 
38
 
 
39
SECTION(SEE ALSO)
 
40
 
 
41
FOOTER