Changeset 3858

Timestamp:

Mar 19, 2019 9:18:53 AM (4 years ago)

Author:

toby

Message:

stupid Py3 syntax error; docs updates

Location:

trunk

Files:

• GSASII.py (modified) (1 diff)
• GSASIIimage.py (modified) (1 diff)
• docs/source/index.rst (modified) (1 diff)
• docs/source/packages.rst (modified) (5 diffs)

trunk/GSASII.py

@@ -10 +10 @@
 ########### SVN repository information ###################
 '''
-*GSAS-II GUI Script*
+*GSAS-II GUI*
 =====================
 
-Script to start the GSAS-II graphical user interface. This script imports GSASIIpath,
-sets a few misc. values and then launches :func:`GSASIIdataGUI.GSASIImain`, which
-creates a wx.Application which in turns creates the GUI. 
+This is the script to start the GSAS-II graphical user interface (GUI). 
+This script imports GSASIIpath, does some minor initialization 
+and then launches :func:`GSASIIdataGUI.GSASIImain`, 
+which creates a wx.Application that in turns creates the GUI. 
+If the GSAS-II binaries are not installed or are incompatible with
+the OS/Python packages, the user is asked if they should be updated
+from the subversion site. 
 '''
 

trunk/GSASIIimage.py

@@ -28 +28 @@
 try:
     import GSASIIplot as G2plt
-except ImportError, ModuleNotFoundError: # expected in scriptable w/o matplotlib and/or wx
+except (ImportError, ModuleNotFoundError): # expected in scriptable w/o matplotlib and/or wx
     pass
 import GSASIIlattice as G2lat

trunk/docs/source/index.rst

@@ -7 +7 @@
 The following documentation is intended for those wishing to code
 withing the GSAS-II framework, those planning to understand how
-GSAS-II works or for people wishing to develop scripting applications
+GSAS-II works, or for people wishing to develop scripting applications
 using the API (:mod:`GSASIIscriptable`).
 

trunk/docs/source/packages.rst

@@ -1 @@
-*Required packages*
+Required packages
 ====================
 
@@ -5 +5 @@
 well as several separately-developed packages. GSAS-II is being
 developed using Python 2.7, 3.6 and 3.7. At this point we think that 
-most sections of the code have not been exercised in Python 2 and 3,
+most sections of the code have been exercised in Python 2 and 3,
 but  bugs are still expected (please report them). Our
 goal is to keep the code compliant with both Python 2.7 and 3.x for
@@ -19 +19 @@
 encourage updating from that. 
 
-GUI Use
---------
+GUI Requirements
+----------------
 
 When using the GSAS-II graphical user interface (GUI), the following
 Python extension packages are required:
 
-* wxPython (http://wxpython.org/docs/api/). Note that GSAS-II has been tested with wxPython >=2.8, 3.0.x and 4.0.x
+* wxPython (http://wxpython.org/docs/api/). Note that GSAS-II has been tested with wxPython 2.8.x, 3.0.x and 4.0.x. We encourage use of 3.0 with Python 2.7 and 4.x with Python 3.x. 
 * NumPy (http://docs.scipy.org/doc/numpy/reference/), 
 * SciPy (http://docs.scipy.org/doc/scipy/reference/),
@@ -31 +31 @@
 * PyOpenGL (http://pyopengl.sourceforge.net/documentation). Note: a copy of this is distributed with GSAS-II (at present) and will be installed if the Python setuptools package is present. 
 
-Several packages are used by some parts of the code, but are not
+Several packages are used in sections of the code, but are not
 required. If these packages are not present, warning messages may be
-generated when needed, but the vast bulk of GSAS-II will function normally. 
+generated if they would be needed, but the vast bulk of GSAS-II will function normally. 
 
 * Pillow (https://pillow.readthedocs.org) or PIL (http://www.pythonware.com/products/pil/). This is used to save
@@ -49 +49 @@
 
 
-Scripting  Use
----------------
+Scripting  Requirements
+--------------------
 
 When using the GSAS-II scripting interface (:mod:`GSASIIscriptable`),