~ubuntu-branches/ubuntu/raring/voxbo/raring

« back to all changes in this revision

Viewing changes to munge/vbbatch.hlp

  • Committer: Bazaar Package Importer
  • Author(s): Michael Hanke
  • Date: 2010-06-06 11:33:11 UTC
  • Revision ID: james.westby@ubuntu.com-20100606113311-v3c13imdkkd5n7ae
Tags: upstream-1.8.5~svn1172
ImportĀ upstreamĀ versionĀ 1.8.5~svn1172

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
VoxBo vbbatch (v%1%)
 
3
usage:
 
4
  vbbatch -c <command> [<file> ...]
 
5
flags:
 
6
  -c "command"   command line to execute (should be in quotes)
 
7
  -p <pri>       set job priority
 
8
  -x <str>       use str as your variable string instead of FILE
 
9
  -n <str>       use str as your index string instead of IND
 
10
  -m <maxjobs>   maximum number of concurrent jobs at full priority
 
11
  -r             really run it, don't just show the commands
 
12
  -req <req>     add a requirement (you'll know if you need it)
 
13
  -i             interactive mode (ask for each file)
 
14
  -d <n>         add a bunch of dummy files (see below)
 
15
  -sn <seqname>  sequence name visible in queue
 
16
  -jn <jobname>  job names visible in queue (can use FILE, IND)
 
17
  -f <seq>       flush private sequence
 
18
  -a <seq>       append to private sequence
 
19
  -s <seq>       submit private sequence
 
20
  -e <email>     address for notification, use -- for no email
 
21
  --run=<n>      don't queue, run now on n cores
 
22
  -h             show help
 
23
  -v             show version
 
24
notes:
 
25
  In your command, the token FILE will be replaced with each file you
 
26
  specify.  The token IND will be replaced with an index, starting from 000
 
27
  
 
28
  maxjobs defaults to 10
 
29
  
 
30
  The -f, -a, and -s options allow you to build a compound
 
31
  batch job in pieces, and then to submit the whole thing as
 
32
  one sequence.  Use -f to first flush it (just in case), then
 
33
  call vbbatch as you normally would, but use -a to append the
 
34
  jobs to your private sequence, and finally use -s to submit
 
35
  the whole thing.
 
36
  
 
37
  The -r flag is there to encourage you to check the generated
 
38
  command lines before you really submit.  Run vbbatch without it,
 
39
  and if you like what you see, run it again with -r.
 
40
  
 
41
  The -p flag can take a numeric priority from 0 to 5 or a scheduling
 
42
  policy as described in the help to voxq.
 
43
 
 
44
  If --run is specified without =n, the default is the total number of
 
45
  available cores minus 1 (or 1, if that would be 0).  Note that even
 
46
  if you use --run, you still have to include the -r flag to indicate
 
47
  you really want to run the jobs, not just see them.
 
48
 
 
49
  The -d flag lets you create "dummy" files, with the filenames just
 
50
  being the numbers from 0 to n-1.  Usually you would use it with IND,
 
51
  not FILE.
 
52
examples:
 
53
  Run myscript.sh on all your subjects' Anatomy directories:
 
54
 
 
55
    vbbatch -c "myscript.sh FILE" study*/sub*/Anatomy -r
 
56
 
 
57
  Run myperms.sh 1000 times at low priority, with different output
 
58
  files:
 
59
 
 
60
    vbbatch -c "myperms.sh results_IND.nii.gz" -d 1000 -r -p xnice
 
61