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