source: sphinxdocs/source/index.rst @ 1708

Last change on this file since 1708 was 1527, checked in by toby, 9 years ago

discuss dependencies more completely

File size: 1.3 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) 
35* PIL or Pillow (https://pillow.readthedocs.org) and
36* PyOpenGL (http://pyopengl.sourceforge.net/documentation)
37
38These packages are not distributed as part of the Python standard
39library and must be obtained separately (or in a bundled Python
40package such as the Enthought Python Distribution/Canopy or
41Continuum.io's anaconda).  The PyOpenGL package will be installed into
42Python by GSAS-II if not found, so it does not need to be included in
43the Python bundle, but the setuptools package
44(https://pythonhosted.org/setuptools/) is needed by GSAS-II to install
45PyOpenGL.
Note: See TracBrowser for help on using the repository browser.