Source Code for Module diffpy.srrietveld.applications.srhelp

 1  ############################################################################## 
 2  # 
 3  # diffpy.srrietveld by DANSE Diffraction group 
 4  #                   Simon J. L. Billinge 
 5  #                   (c) 2009 Trustees of the Columbia University 
 6  #                   in the City of New York.  All rights reserved. 
 7  # 
 8  # File coded by:    Wenduo Zhou, Peng Tian 
 9  # 
10  # See AUTHORS.txt for a list of people who contributed. 
11  # See LICENSE.txt for license information. 
12  # 
13  ############################################################################## 
14   
15  __id__ = "$Id: srhelp.py 5658 2010-07-09 20:05:34Z juhas $" 
16   
17  helpstring = { 
18          "instrument": "(1) Name of Instrument iparm file\n(2) Name of Instrument XML File", 
19          "structure": "Name of CIF File (.cif) or SrRietveld Crystal Structure XML File (.xml)", 
20          "data": "Full-path Name of Data File", 
21          "strategy": "(1) Name of Refinement Strategy or (2) Name of SrRietveld Refinement Strategy File", 
22          "bank": "Bank(s) to refine in T.O.F. data", 
23          "background": "Name of Data File Containing Background Parameter or Background XML file", 
24          "engine": "Type of Refinement Engine (i.e.,Refinement Backend). Fullprof or GSAS", 
25          "excludedregion": "Name of XML file to Indicate User Specified Excluded Region" 
26      } 
27   
28 -def getHelp(optionname): 
29      """ Get help string for an option name 
30   
31      Arguement: 
32        - optionname  :   str, name of an option supported 
33   
34      Return          :   str 
35      """ 
36      try: 
37          resultstring = helpstring[optionname] 
38      except KeyError, err: 
39          errmsg = "Help string for option %-20s does not exist" 
40          raise NotImplementedError, errmsg 
41   
42      return resultstring 
43