Changeset 3238

Timestamp:

Jan 22, 2018 3:20:40 PM (6 years ago)

Author:

toby

Message:

doc/tutorial updates

File:

• trunk/docs/source/index.rst (modified) (2 diffs)

trunk/docs/source/index.rst

@@ -28 +28 @@
 --------------------
 
+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.x and 3.0.x; It it expected to have problems with wxPython 4.x at present. 
+  * 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. 
 
 Two packages are used by some parts of the code, but are not
@@ -48 +58 @@
   warning message appears on GSAS-II startup. 
 
+* When using Anaconda we also encourage installation of the subversion
+  (svn) package. This is a separate package from Python and is used by
+  GSAS-II to download updates to our code. It can also be installed
+  separately. 
+
 Note that the packages listed above are not distributed as part of the Python standard
-library and must be obtained separately (or in a bundled Python
-package such as Continuum.io's Anaconda or Enthought Inc.'s Canopy; 
-we also do some testing using the older Enthought Python
-Distribution).  
-One exception is the PyOpenGL package. This will be installed into
-Python by GSAS-II if not found, so it does not need to be included in
-the Python bundle, but the setuptools package
-(https://pythonhosted.org/setuptools/) is needed by GSAS-II to install
-PyOpenGL.
+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.