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

Last change on this file since 3187 was 3187, checked in by toby, 4 years ago

misc docs cleanups; add 1-ID metadata reader & new config variable

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