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

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

revise plot update code; add plotting docs & cleanup; always use last phase tab

File size: 2.7 KB
1.. This lists all the sections of the documentation. Some of the below
2.. reference a single file. Others reference multiple files.
4GSAS-II Developer's Documentation
7.. toctree::
9  GSASII.rst
10  GSASIIobj.rst
11  GSASIIutil.rst
12  GSASIIGUIr.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
27*Required packages*
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.
38Note that GSAS-II requires the Python extension packages
40* wxPython ( Note that GSAS-II has been tested with wxPython >=2.8, 3.0.x and 4.0.x
41* NumPy (,
42* SciPy (,
43* matplotlib (  and
44* PyOpenGL ( Note: a copy of this is distributed with GSAS-II (at present) and will be installed if the Python setuptools package is present.
46Two packages are used by some parts of the code, but are not
47required. If these packages are not present warning messages may be
48generated but the vast bulk of GSAS-II will function normally.
50* PIL ( or Pillow ( This is used to save
51  and read certain types of images.
52* h5py is the HDF5 support package. This is (not surprisingly) required
53  to import images from HDF5 files. If this library is not present,
54  the HDF5 importer(s) will not appear in the import menu and a
55  warning message appears on GSAS-II startup.
57* When using Anaconda we also encourage installation of the subversion
58  (svn) package. This is a separate package from Python and is used by
59  GSAS-II to download updates to our code. It can also be installed
60  separately.
62Note that the packages listed above are not distributed as part of the Python standard
63library. We use the free Anaconda Python (
64distribution (and provide installers based on that), but there are
65many other fine distributions, such as Enthought Inc.'s Canopy and
66Python(x,y), see here:
67We do some testing using the older Enthought Python Distribution
68(EPD); this is known to have some problems with reading CIFs and
69encourage updating.
Note: See TracBrowser for help on using the repository browser.