| 1 | .. This lists all the sections of the documentation. Some of the below |
|---|
| 2 | .. reference a single file. Others reference multiple files. |
|---|
| 3 | |
|---|
| 4 | GSAS-II Developer's Documentation |
|---|
| 5 | ================================= |
|---|
| 6 | |
|---|
| 7 | .. toctree:: |
|---|
| 8 | |
|---|
| 9 | GSASII.rst |
|---|
| 10 | GSASIIobj.rst |
|---|
| 11 | GSASIIutil.rst |
|---|
| 12 | GSASIIGUIr.rst |
|---|
| 13 | GSASIIGUI.rst |
|---|
| 14 | GSASIIstruc.rst |
|---|
| 15 | GSASIImapvars.rst |
|---|
| 16 | GSASIIimage.rst |
|---|
| 17 | GSASIImath.rst |
|---|
| 18 | GSASIIindex.rst |
|---|
| 19 | GSASIIplot.rst |
|---|
| 20 | GSASIIpwd.rst |
|---|
| 21 | SAS.rst |
|---|
| 22 | GSASIIscriptable.rst |
|---|
| 23 | GSASIIscripts.rst |
|---|
| 24 | imports.rst |
|---|
| 25 | exports.rst |
|---|
| 26 | |
|---|
| 27 | *Required packages* |
|---|
| 28 | -------------------- |
|---|
| 29 | |
|---|
| 30 | GSAS-II requires a standard Python interpreter to be installed, as |
|---|
| 31 | well as several separately-developed packages. GSAS-II is being |
|---|
| 32 | developed using both Python 2.7 and Python 3.6, but some sections of |
|---|
| 33 | the code have not been exercised in Python 3 so bugs are to be |
|---|
| 34 | expected (please report them). Our |
|---|
| 35 | goal is to keep the code compliant with both Python 2.7 and 3.x for |
|---|
| 36 | the immediate future. |
|---|
| 37 | |
|---|
| 38 | Note that GSAS-II requires the Python extension packages |
|---|
| 39 | |
|---|
| 40 | * wxPython (http://wxpython.org/docs/api/). Note that GSAS-II has been tested with wxPython >=2.8, 3.0.x and 4.0.x |
|---|
| 41 | * NumPy (http://docs.scipy.org/doc/numpy/reference/), |
|---|
| 42 | * SciPy (http://docs.scipy.org/doc/scipy/reference/), |
|---|
| 43 | * matplotlib (http://matplotlib.org/contents.html) and |
|---|
| 44 | * 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. |
|---|
| 45 | |
|---|
| 46 | Several packages are used by some parts of the code, but are not |
|---|
| 47 | required. If these packages are not present warning messages may be |
|---|
| 48 | generated when needed, but the vast bulk of GSAS-II will function normally. |
|---|
| 49 | |
|---|
| 50 | * PIL (http://www.pythonware.com/products/pil/) or Pillow (https://pillow.readthedocs.org). This is used to save |
|---|
| 51 | and read certain types of images. |
|---|
| 52 | * h5py is the HDF5 interface and hdf5 is the support package. These |
|---|
| 53 | packages are (not surprisingly) required |
|---|
| 54 | to import images from HDF5 files. If these libraries are not present, |
|---|
| 55 | the HDF5 importer(s) will not appear in the import menu and a |
|---|
| 56 | warning message appears on GSAS-II startup. |
|---|
| 57 | * imageio is used to make movies. |
|---|
| 58 | * svn: When using Anaconda we also encourage installation of the |
|---|
| 59 | svn (subversion) conda package. This is not actually part of Python |
|---|
| 60 | and can be installed directly into your system's configuration. It is used by |
|---|
| 61 | GSAS-II to download updates to our code. |
|---|
| 62 | |
|---|
| 63 | Note that the packages listed above are not distributed as part of the Python standard |
|---|
| 64 | library. We use the free Anaconda Python (https://www.anaconda.com/) |
|---|
| 65 | distribution (and provide installers based on that), but there are |
|---|
| 66 | many other fine distributions, such as Enthought Inc.'s Canopy and |
|---|
| 67 | Python(x,y), see here: https://www.python.org/download/alternatives/. |
|---|
| 68 | We do some testing using the older Enthought Python Distribution |
|---|
| 69 | (EPD); this is known to have some problems with reading CIFs and |
|---|
| 70 | encourage updating from that. |
|---|
