source: trunk/docs/source/index.rst @ 2479

Last change on this file since 2479 was 2479, checked in by toby, 5 years ago

Rework plotting to refresh after refinements

File size: 1.8 KB
Line 
1.. This lists all the sections of the documentation. Some of the below
2.. reference a single file. Others reference multiple files.
3
4GSAS-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  GSASIIscripts.rst
23  exports.rst
24  imports.rst
25
26*Required packages*
27--------------------
28
29Note that GSAS-II requires the Python extension packages
30
31* wxPython (http://wxpython.org/docs/api/),
32* NumPy (http://docs.scipy.org/doc/numpy/reference/),
33* SciPy (http://docs.scipy.org/doc/scipy/reference/),
34* matplotlib (http://matplotlib.org/contents.html)  and
35* PyOpenGL (http://pyopengl.sourceforge.net/documentation)
36
37Two packages are used by some parts of the code, but are not required:
38
39* PIL (http://www.pythonware.com/products/pil/) or Pillow (https://pillow.readthedocs.org). This is used to save
40  and read certain types of images.
41* h5py is the HDF5 support package. This is (not surprisingly) required
42  to import images from HDF5 files. If this library is not present,
43  the HDF5 importer(s) will not appear in the import menu and a
44  warning message appears on GSAS-II startup.
45
46Note that the packages listed above are not distributed as part of the Python standard
47library and must be obtained separately (or in a bundled Python
48package such as the Enthought Inc.'s Canopy or
49Continuum.io's anaconda; we also use the older Enthought Python
50Distribution). 
51One exception is the PyOpenGL package. This will be installed into
52Python by GSAS-II if not found, so it does not need to be included in
53the Python bundle, but the setuptools package
54(https://pythonhosted.org/setuptools/) is needed by GSAS-II to install
55PyOpenGL.
Note: See TracBrowser for help on using the repository browser.