Diff for "EMAN2PMWorkflow"

Differences between revisions 5 and 6

Tutorial to aid adding a new e2program to the e2projectmanager.py

This tutorial covers the necessary steps to incorporate a e2program into the projectmanager.

Modifications to the e2program itself

Canonical e2programs must maintain the following standards

Options are handled via EMArgumentParser, which is a subclass of Python's argparse module (version 2.7 and higher). For more information on argparse, see the python documentation.
Arguments are handled via EMArgumentParser.
A line usage = """blah, blah, blah...""" must be present to give help info on the e2program
A line progname = os.path.basename(sys.argv[0]) must be present

To illustrate, here is an example program:

   1 #!/usr/bin/env python
   2 
   3 from EMAN2 import *
   4 
   5 def main():
   6     progname = os.path.basename(sys.argv[0])
   7     usage = """prog arg1, arg2, [options] 
   8             This is an exmaple program """
   9 
  10     parser = EMArgumentParser(usage=usage,version=EMANVERSION)
  11     parser.add_argument("--option1",type=str,help="This is the first option",default="myvalue")
  12     parser.add_argument("--option2",type=int,help="This is the second option",default=1)
  13     parser.add_argument("--option3",type=float,help="This is the third option",default=3.14)
  14     parser.add_argument("--option4",action="store_true",help="This is the fourth option",default=False)

-  ⇤ ← Revision 5 as of 2012-04-19 19:17:34 → 
  Size: 880
  Editor: JohnFlanagan
  Comment:
+   ← Revision 6 as of 2012-04-19 19:20:57 → ⇥
  Size: 1396
  Editor: JohnFlanagan
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 5:
-. Options are handled via EMArgumentParser, which is a subclass of Python's argparse module (version 2.7 and higher).
+. Options are handled via EMArgumentParser, which is a subclass of Python's argparse module (version 2.7 and higher). For more information on argparse, see the python documentation.
 Line 20:
+    parser = EMArgumentParser(usage=usage,version=EMANVERSION)
    parser.add_argument("--option1",type=str,help="This is the first option",default="myvalue")
    parser.add_argument("--option2",type=int,help="This is the second option",default=1)
    parser.add_argument("--option3",type=float,help="This is the third option",default=3.14)
    parser.add_argument("--option4",action="store_true",help="This is the fourth option",default=False)