Ignore:
Timestamp:
May 6, 2017 9:09:55 AM (5 years ago)
Author:
vondreele
Message:

provide comments for GSASIIscriptable.py

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/GSASIIscriptable.py

    r2821 r2822  
    8383   
    8484def SaveDictToProjFile(Project,nameList,ProjFile):
    85     'Save a GSAS-II project file from dictionary/nameList created by LoadDictFromProjFile'
     85    '''Save a GSAS-II project file from dictionary/nameList created by LoadDictFromProjFile
     86    param: dict Project: representation of gpx file following the GSAS-II
     87        tree struture as described for LoadDictFromProjFile
     88    param: list nameList: names of main tree entries & subentries used to reconstruct project file
     89    param: str ProjFile: full file name for output project.gpx file (including extension)
     90    '''
    8691    file = open(ProjFile,'wb')
    8792    print 'save to file: ',ProjFile
     
    99104   
    100105def ImportPowder(reader,filename):
     106    '''Use a reader to import a powder diffraction data file
     107    param: str reader: one of 'G2pwd_fxye','G2pwd_xye','G2pwd_BrukerRAW','G2pwd_csv','G2pwd_FP',
     108        'G2pwd_Panalytical','G2pwd_rigaku'
     109    param: str filename: full name of powder data file; can be "multi-Bank" data
     110    returns: list rdlist: list of rrader objects containing powder data, one for each
     111        "Bank" of data encountered in file
     112        items in reader object of interest are:
     113            rd.comments: list of str: comments found on powder file
     114            rd.dnames: list of str: data nammes suitable for use in GSASII data tree
     115                NB: duplicated in all rd entries in rdlist
     116            rd.powderdata: list of numpy arrays: pos,int,wt,zeros,zeros,zeros as needed
     117                for a PWDR entry in  GSASII data tree.       
     118    '''
    101119    readerlist = ['G2pwd_fxye','G2pwd_xye','G2pwd_BrukerRAW','G2pwd_csv','G2pwd_FP',
    102120        'G2pwd_Panalytical','G2pwd_rigaku']
Note: See TracChangeset for help on using the changeset viewer.