Changeset 3506 for trunk/GSASIIscriptable.py

Timestamp:

Jul 25, 2018 12:12:20 AM (5 years ago)

Author:

svnjenkins

Message:

fix scriptable problem due to change in Restraints; update Tutorials; misc. fixes for Sphinx docs

File:

• trunk/GSASIIscriptable.py (modified) (5 diffs)

trunk/GSASIIscriptable.py

@@ -1201 +1201 @@
     Represents an entire GSAS-II project.
 
-    There are two ways to initialize it:
+    :param str gpxfile: Existing .gpx file to be loaded. If nonexistent,
+            creates an empty project.
+    :param str author: Author's name (not yet implemented)
+    :param str newgpx: The filename the project should be saved to in
+            the future. If both newgpx and gpxfile are present, the project is
+            loaded from the gpxfile, then when saved will be written to newgpx.
+    :param str filename: Name to be used to save the project. Has same function as
+            parameter newgpx (do not use both gpxfile and filename). Use of newgpx
+            is preferred over filename.
+
+    There are two ways to initialize this object:
 
     >>> # Load an existing project file
@@ -1237 +1247 @@
     """
     def __init__(self, gpxfile=None, author=None, filename=None, newgpx=None):
-        """Loads a GSAS-II project from a specified filename.
-
-        :param str gpxfile: Existing .gpx file to be loaded. If nonexistent,
-            creates an empty project.
-        :param str author: Author's name (not yet implemented)
-        :param str newgpx: The filename the project should be saved to in
-            the future. If both newgpx and gpxfile are present, the project is
-            loaded from the gpxfile, then when saved will be written to newgpx.
-        :param str filename: Name to be used to save the project. Has same function as
-            parameter newgpx (do not use both gpxfile and filename). Use of newgpx
-            is preferred over filename.
-        """
         if filename is not None and newgpx is not None:
             raise G2ScriptException('Do not use filename and newgpx together')
@@ -1592 +1590 @@
             """
         output = []
+        # loop through each tree entry. If it is more than one level (more than one item in the
+        # list of names) then it must be a histogram, unless labeled Phases or Restraints
         for obj in self.names:
-            if len(obj) > 1 and obj[0] != u'Phases':
+            if len(obj) > 1 and obj[0] != u'Phases' and obj[0] != u'Restraints':
                 output.append(self.histogram(obj[0]))
         return output
@@ -2346 +2346 @@
     def set_peakFlags(self,peaklist=None,area=None,pos=None,sig=None,gam=None):
         '''Set refinement flags for peaks
+        
         :param list peaklist: a list of peaks to change flags. If None (default), changes
           are made to all peaks.
@@ -3311 +3312 @@
 
 if __name__ == '__main__':
+    #fname='/tmp/corundum-template.gpx'
+    #prj = G2Project(fname)
     main()