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

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

doc/tutorial updates

File size: 2.7 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  imports.rst
25  exports.rst
26
27*Required packages*
28--------------------
29
30GSAS-II requires a standard Python interpreter to be installed, as
31well as several separately-developed packages. GSAS-II is being
32developed using both Python 2.7 and Python 3.6, but some sections of
33the code have not been exercised in Python 3 so bugs are to be
34expected (please report them). Our
35goal is to keep the code compliant with both Python 2.7 and 3.x for
36the immediate future.
37
38Note that GSAS-II requires the Python extension packages
39
40* wxPython (http://wxpython.org/docs/api/),
41  * note that GSAS-II has been tested with wxPython >=2.8, 3.0.x and 4.0.x
42* NumPy (http://docs.scipy.org/doc/numpy/reference/),
43* SciPy (http://docs.scipy.org/doc/scipy/reference/),
44* matplotlib (http://matplotlib.org/contents.html)  and
45* PyOpenGL (http://pyopengl.sourceforge.net/documentation)
46  * Note: a copy of this is distributed with GSAS-II at present and will be
47    installed if the Python setuptools package is present.
48
49Two packages are used by some parts of the code, but are not
50required. If these packages are not present warning messages may be
51generated but the vast bulk of GSAS-II will function normally.
52
53* PIL (http://www.pythonware.com/products/pil/) or Pillow (https://pillow.readthedocs.org). This is used to save
54  and read certain types of images.
55* h5py is the HDF5 support package. This is (not surprisingly) required
56  to import images from HDF5 files. If this library is not present,
57  the HDF5 importer(s) will not appear in the import menu and a
58  warning message appears on GSAS-II startup.
59
60* When using Anaconda we also encourage installation of the subversion
61  (svn) package. This is a separate package from Python and is used by
62  GSAS-II to download updates to our code. It can also be installed
63  separately.
64
65Note that the packages listed above are not distributed as part of the Python standard
66library. We use the free Anaconda Python (https://www.anaconda.com/)
67distribution (and provide installers based on that), but there are
68many other fine distributions, such as Enthought Inc.'s Canopy and
69Python(x,y), see here: https://www.python.org/download/alternatives/.
70We do some testing using the older Enthought Python Distribution
71(EPD); this is known to have some problems with reading CIFs and
72encourage updating.
Note: See TracBrowser for help on using the repository browser.