Changeset 3857

Timestamp:

Mar 18, 2019 12:09:57 PM (4 years ago)

Author:

toby

Message:

Fix scriptable to work w/o wx & mpl; reorg of docs

Location:

trunk

Files:

• GSASIIimage.py (modified) (1 diff)
• GSASIIscriptable.py (modified) (2 diffs)
• docs/source/index.rst (modified) (2 diffs)
• docs/source/packages.rst (added)

trunk/GSASIIimage.py

@@ -26 +26 @@
 import GSASIIpath
 GSASIIpath.SetVersionNumber("$Revision$")
-import GSASIIplot as G2plt
+try:
+    import GSASIIplot as G2plt
+except ImportError, ModuleNotFoundError: # expected in scriptable w/o matplotlib and/or wx
+    pass
 import GSASIIlattice as G2lat
 import GSASIIpwd as G2pwd

trunk/GSASIIscriptable.py

@@ -1068 +1068 @@
     gsasii_version = str(GSASIIpath.GetVersionNumber())
     LoadG2fil()
-    import matplotlib as mpl
-    python_library_versions = G2fil.get_python_versions([mpl, np, sp])
+    try:
+        import matplotlib as mpl
+        python_library_versions = G2fil.get_python_versions([mpl, np, sp])
+    except ModuleNotFoundError:
+        python_library_versions = G2fil.get_python_versions([np, sp])
 
     controls_data = dict(G2obj.DefaultControls)
@@ -2812 +2815 @@
         try:
             import matplotlib.pyplot as plt
-            data = self.data['data'][1]
-            if Yobs:
-                plt.plot(data[0], data[1], label='Yobs')
-            if Ycalc:
-                plt.plot(data[0], data[3], label='Ycalc')
-            if Background:
-                plt.plot(data[0], data[4], label='Background')
-            if Residual:
-                plt.plot(data[0], data[5], label="Residual")
         except ImportError:
-            pass
+            print('Unable to import matplotlib, skipping plot')
+            return
+        data = self.data['data'][1]
+        if Yobs:
+            plt.plot(data[0], data[1], label='Yobs')
+        if Ycalc:
+            plt.plot(data[0], data[3], label='Ycalc')
+        if Background:
+            plt.plot(data[0], data[4], label='Background')
+        if Residual:
+            plt.plot(data[0], data[5], label="Residual")
 
     def get_wR(self):

trunk/docs/source/index.rst

@@ -5 +5 @@
 =================================
 
+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
+using the API (:mod:`GSASIIscriptable`).
+
+Contents
+---------
+
 .. toctree::
 
+  packages.rst
   GSASII.rst
   GSASIIobj.rst
@@ -25 +34 @@
   exports.rst
 
-*Required packages*
---------------------
-
-GSAS-II requires a standard Python interpreter to be installed, as
-well as several separately-developed packages. GSAS-II is being
-developed using both Python 2.7 and Python 3.6, but some sections of
-the code have not been exercised in Python 3 so bugs are to be
-expected (please report them). Our
-goal is to keep the code compliant with both Python 2.7 and 3.x for
-the immediate future. 
-
-Note that GSAS-II requires the Python extension packages 
-
-* wxPython (http://wxpython.org/docs/api/). Note that GSAS-II has been tested with wxPython >=2.8, 3.0.x and 4.0.x
-* NumPy (http://docs.scipy.org/doc/numpy/reference/), 
-* SciPy (http://docs.scipy.org/doc/scipy/reference/),
-* matplotlib (http://matplotlib.org/contents.html)  and
-* 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
-required. If these packages are not present warning messages may be
-generated when needed, but the vast bulk of GSAS-II will function normally. 
-
-* PIL (http://www.pythonware.com/products/pil/) or Pillow (https://pillow.readthedocs.org). This is used to save
-  and read certain types of images.
-* h5py is the HDF5 interface and hdf5 is the support package. These
-  packages are (not surprisingly) required
-  to import images from HDF5 files. If these libraries are not present,
-  the HDF5 importer(s) will not appear in the import menu and a
-  warning message appears on GSAS-II startup. 
-* imageio is used to make movies. 
-* svn: When using Anaconda we also encourage installation of the
-  svn (subversion) conda package. This is not actually part of Python
-  and can be installed directly into your system's configuration. It is used by
-  GSAS-II to download updates to our code.
-
-Note that the packages listed above are not distributed as part of the Python standard
-library. We use the free Anaconda Python (https://www.anaconda.com/)
-distribution (and provide installers based on that), but there are
-many other fine distributions, such as Enthought Inc.'s Canopy and
-Python(x,y), see here: https://www.python.org/download/alternatives/. 
-We do some testing using the older Enthought Python Distribution
-(EPD); this is known to have some problems with reading CIFs and
-encourage updating from that.