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

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

make the two frame version the trunk as we hit version 3000

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