source: trunk/docs/source/packages.rst @ 4658

Last change on this file since 4658 was 4658, checked in by toby, 12 months ago

implement package version checking; fix broken mpl pick code

File size: 3.2 KB
Line 
1Required packages
2====================
3
4GSAS-II requires a standard Python interpreter to be installed, as
5well as several separately-developed packages. GSAS-II is being
6developed using Python 2.7, 3.6 and 3.7. At this point we think that
7most sections of the code have been exercised in Python 2 and 3,
8but  bugs are still expected (please report them). Our
9goal is to keep the code compliant with both Python 2.7 and 3.x for
10the immediate future.
11
12Note that the packages listed below are not distributed as part of the Python standard
13library. We use the free Anaconda Python (https://www.anaconda.com/)
14distribution (and provide installers based on that), but there are
15many other fine distributions, such as Enthought Inc.'s Canopy and
16Python(x,y), see here: https://www.python.org/download/alternatives/.
17We do some testing using the older Enthought Python Distribution
18(EPD); this is known to have some problems with reading CIFs and
19encourage updating from that.
20
21More details on allowed and prefered package versions can be found in
22the documentation for variable :attr:`GSASIIdataGUI.versionDict`.
23
24GUI Requirements
25----------------
26
27When using the GSAS-II graphical user interface (GUI), the following
28Python extension packages are required:
29
30* 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.
31* NumPy (http://docs.scipy.org/doc/numpy/reference/),
32* SciPy (http://docs.scipy.org/doc/scipy/reference/),
33* matplotlib (http://matplotlib.org/contents.html)  and
34* 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.
35
36Several packages are used in sections of the code, but are not
37required. If these packages are not present, warning messages may be
38generated if they would be needed, but the vast bulk of GSAS-II will function normally.
39
40* Pillow (https://pillow.readthedocs.org) or PIL (http://www.pythonware.com/products/pil/). This is used to save
41  and read certain types of images.
42* h5py is the HDF5 interface and hdf5 is the support package. These
43  packages are (not surprisingly) required
44  to import images from HDF5 files. If these libraries are not present,
45  the HDF5 importer(s) will not appear in the import menu and a
46  warning message appears on GSAS-II startup.
47* imageio is used to make movies.
48* svn: When using Anaconda we also encourage installation of the
49  svn (subversion) conda package. This is not actually part of Python
50  and can be installed directly into your system's configuration. It is used by
51  GSAS-II to download updates to our code.
52
53
54Scripting  Requirements
55-----------------------
56
57When using the GSAS-II scripting interface (:mod:`GSASIIscriptable`),
58only the following Python extension packages are required:
59
60* NumPy (http://docs.scipy.org/doc/numpy/reference/),
61* SciPy (http://docs.scipy.org/doc/scipy/reference/).
62
63Note that some sections of the code may require matplotlib (http://matplotlib.org/contents.html), Pillow
64(https://pillow.readthedocs.org) (or PIL,
65http://www.pythonware.com/products/pil/), or h5py + hdf5 to function
66but scripts will load and run without these.
Note: See TracBrowser for help on using the repository browser.