source: trunk/sphinxdocs/build/html/index.html @ 1168

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

update imports to provide error messages

  • Property svn:mime-type set to text/html
File size: 18.0 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>GSAS-II Developer’s Documentation &mdash; GSAS-II 0.2.0 documentation</title>
12   
13    <link rel="stylesheet" href="_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '',
19        VERSION:     '0.2.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="_static/jquery.js"></script>
26    <script type="text/javascript" src="_static/underscore.js"></script>
27    <script type="text/javascript" src="_static/doctools.js"></script>
28    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
29    <link rel="top" title="GSAS-II 0.2.0 documentation" href="#" />
30    <link rel="next" title="GSAS-II Main Module" href="GSASII.html" /> 
31  </head>
32  <body>
33    <div class="related">
34      <h3>Navigation</h3>
35      <ul>
36        <li class="right" style="margin-right: 10px">
37          <a href="genindex.html" title="General Index"
38             accesskey="I">index</a></li>
39        <li class="right" >
40          <a href="py-modindex.html" title="Python Module Index"
41             >modules</a> |</li>
42        <li class="right" >
43          <a href="GSASII.html" title="GSAS-II Main Module"
44             accesskey="N">next</a> |</li>
45        <li><a href="#">GSAS-II 0.2.0 documentation</a> &raquo;</li> 
46      </ul>
47    </div> 
48
49    <div class="document">
50      <div class="documentwrapper">
51        <div class="bodywrapper">
52          <div class="body">
53           
54  <div class="section" id="gsas-ii-developer-s-documentation">
55<h1>GSAS-II Developer&#8217;s Documentation<a class="headerlink" href="#gsas-ii-developer-s-documentation" title="Permalink to this headline">¶</a></h1>
56<div class="toctree-wrapper compound">
57<ul>
58<li class="toctree-l1"><a class="reference internal" href="GSASII.html"><em>GSAS-II Main Module</em></a></li>
59<li class="toctree-l1"><a class="reference internal" href="GSASIIobj.html"><em>GSASIIobj: Data objects</em></a><ul>
60<li class="toctree-l2"><a class="reference internal" href="GSASIIobj.html#constraints-tree-item">Constraints Tree Item</a></li>
61<li class="toctree-l2"><a class="reference internal" href="GSASIIobj.html#covariance-tree-item">Covariance Tree Item</a></li>
62<li class="toctree-l2"><a class="reference internal" href="GSASIIobj.html#phase-tree-items">Phase Tree Items</a></li>
63<li class="toctree-l2"><a class="reference internal" href="GSASIIobj.html#rigid-body-objects">Rigid Body Objects</a></li>
64<li class="toctree-l2"><a class="reference internal" href="GSASIIobj.html#space-group-objects">Space Group Objects</a></li>
65<li class="toctree-l2"><a class="reference internal" href="GSASIIobj.html#atom-records">Atom Records</a></li>
66<li class="toctree-l2"><a class="reference internal" href="GSASIIobj.html#drawing-atom-records">Drawing Atom Records</a></li>
67<li class="toctree-l2"><a class="reference internal" href="GSASIIobj.html#powder-diffraction-tree-items">Powder Diffraction Tree Items</a></li>
68<li class="toctree-l2"><a class="reference internal" href="GSASIIobj.html#powder-reflection-data-structure">Powder Reflection Data Structure</a></li>
69<li class="toctree-l2"><a class="reference internal" href="GSASIIobj.html#single-crystal-tree-items">Single Crystal Tree Items</a></li>
70<li class="toctree-l2"><a class="reference internal" href="GSASIIobj.html#single-crystal-reflection-data-structure">Single Crystal Reflection Data Structure</a></li>
71<li class="toctree-l2"><a class="reference internal" href="GSASIIobj.html#classes-and-routines"><em>Classes and routines</em></a></li>
72</ul>
73</li>
74<li class="toctree-l1"><a class="reference internal" href="GSASIIutil.html"><em>GSAS-II Utility Modules</em></a><ul>
75<li class="toctree-l2"><a class="reference internal" href="GSASIIutil.html#gsasiidata-data-for-computations"><em>GSASIIdata: Data for computations</em></a></li>
76<li class="toctree-l2"><a class="reference internal" href="GSASIIutil.html#elementtable-periodic-table-data"><em>ElementTable: Periodic Table Data</em></a></li>
77<li class="toctree-l2"><a class="reference internal" href="GSASIIutil.html#formfactors-scattering-data"><em>FormFactors: Scattering Data</em></a></li>
78<li class="toctree-l2"><a class="reference internal" href="GSASIIutil.html#imagecalibrants-calibration-standards"><em>ImageCalibrants: Calibration Standards</em></a></li>
79<li class="toctree-l2"><a class="reference internal" href="GSASIIutil.html#gsasiipath-locations-updates"><em>GSASIIpath: locations &amp; updates</em></a></li>
80<li class="toctree-l2"><a class="reference internal" href="GSASIIutil.html#gsasiielem-functions-for-element-types"><em>GSASIIElem: functions for element types</em></a></li>
81<li class="toctree-l2"><a class="reference internal" href="GSASIIutil.html#gsasiilattice-unit-cells"><em>GSASIIlattice: Unit cells</em></a></li>
82<li class="toctree-l2"><a class="reference internal" href="GSASIIutil.html#gsasiispc-space-group-module"><em>GSASIIspc: Space group module</em></a></li>
83<li class="toctree-l2"><a class="reference internal" href="GSASIIutil.html#gltext-draw-opengl-text"><em>gltext: draw OpenGL text</em></a></li>
84</ul>
85</li>
86<li class="toctree-l1"><a class="reference internal" href="GSASIIGUIr.html"><em>GSAS-II GUI Routines</em></a><ul>
87<li class="toctree-l2"><a class="reference internal" href="GSASIIGUIr.html#gsasiigrid-basic-gui-routines"><em>GSASIIgrid: Basic GUI routines</em></a></li>
88<li class="toctree-l2"><a class="reference internal" href="GSASIIGUIr.html#gsasiiio-misc-i-o-routines"><em>GSASIIIO: Misc I/O routines</em></a></li>
89<li class="toctree-l2"><a class="reference internal" href="GSASIIGUIr.html#readmarccdframe-read-mar-files"><em>ReadMarCCDFrame: Read Mar Files</em></a></li>
90<li class="toctree-l2"><a class="reference internal" href="GSASIIGUIr.html#gsasiipy3-python-3-x-routines"><em>GSASIIpy3: Python 3.x Routines</em></a></li>
91</ul>
92</li>
93<li class="toctree-l1"><a class="reference internal" href="GSASIIGUI.html"><em>GSAS-II GUI Submodules</em></a><ul>
94<li class="toctree-l2"><a class="reference internal" href="GSASIIGUI.html#gsasiiphsgui-phase-gui"><em>GSASIIphsGUI: Phase GUI</em></a></li>
95<li class="toctree-l2"><a class="reference internal" href="GSASIIGUI.html#gsasiiddatagui-phase-diffraction-data-gui"><em>GSASIIddataGUI: Phase Diffraction Data GUI</em></a></li>
96<li class="toctree-l2"><a class="reference internal" href="GSASIIGUI.html#gsasiielemgui-gui-to-select-and-delete-element-lists"><em>GSASIIElemGUI: GUI to select and delete element lists</em></a></li>
97<li class="toctree-l2"><a class="reference internal" href="GSASIIGUI.html#gsasiiconstrgui-constraint-gui-routines"><em>GSASIIconstrGUI: Constraint GUI routines</em></a></li>
98<li class="toctree-l2"><a class="reference internal" href="GSASIIGUI.html#gsasiiimggui-image-gui"><em>GSASIIimgGUI: Image GUI</em></a></li>
99<li class="toctree-l2"><a class="reference internal" href="GSASIIGUI.html#gsasiipwdgui-powder-pattern-gui-routines"><em>GSASIIpwdGUI: Powder Pattern GUI routines</em></a></li>
100<li class="toctree-l2"><a class="reference internal" href="GSASIIGUI.html#gsasiirestrgui-restraint-gui-routines"><em>GSASIIrestrGUI: Restraint GUI routines</em></a></li>
101</ul>
102</li>
103<li class="toctree-l1"><a class="reference internal" href="GSASIIstruc.html"><em>GSAS-II Structure  Submodules</em></a><ul>
104<li class="toctree-l2"><a class="reference internal" href="GSASIIstruc.html#gsasiistrmain-main-structure-routine"><em>GSASIIstrMain: main structure routine</em></a></li>
105<li class="toctree-l2"><a class="reference internal" href="GSASIIstruc.html#gsasiistrmath-structure-math-routines"><em>GSASIIstrMath - structure math routines</em></a></li>
106<li class="toctree-l2"><a class="reference internal" href="GSASIIstruc.html#gsasiistrio-structure-i-o-routines"><em>GSASIIstrIO: structure I/O routines</em></a></li>
107</ul>
108</li>
109<li class="toctree-l1"><a class="reference internal" href="GSASIImapvars.html"><em>GSASIImapvars: Parameter constraints</em></a><ul>
110<li class="toctree-l2"><a class="reference internal" href="GSASIImapvars.html#external-routines"><em>External Routines</em></a></li>
111<li class="toctree-l2"><a class="reference internal" href="GSASIImapvars.html#global-variables"><em>Global Variables</em></a></li>
112<li class="toctree-l2"><a class="reference internal" href="GSASIImapvars.html#routines"><em>Routines</em></a></li>
113</ul>
114</li>
115<li class="toctree-l1"><a class="reference internal" href="GSASIIimage.html"><em>GSASIIimage: Image calc module</em></a></li>
116<li class="toctree-l1"><a class="reference internal" href="GSASIImath.html"><em>GSASIImath: computation module</em></a></li>
117<li class="toctree-l1"><a class="reference internal" href="GSASIIindex.html"><em>GSASIIindex: Cell Indexing Module</em></a></li>
118<li class="toctree-l1"><a class="reference internal" href="GSASIIplot.html"><em>GSASIIplot: plotting routines</em></a></li>
119<li class="toctree-l1"><a class="reference internal" href="GSASIIpwd.html"><em>GSASII powder calculation module</em></a></li>
120<li class="toctree-l1"><a class="reference internal" href="GSASIIscripts.html"><em>GSAS-II Scripts</em></a><ul>
121<li class="toctree-l2"><a class="reference internal" href="GSASIIscripts.html#testderiv-check-derivative-computation"><em>testDeriv: Check derivative computation</em></a></li>
122<li class="toctree-l2"><a class="reference internal" href="GSASIIscripts.html#gsasiitestplot-plotting-for-testderiv"><em>GSASIItestplot: Plotting for testDeriv</em></a></li>
123<li class="toctree-l2"><a class="reference internal" href="GSASIIscripts.html#scanccd-reduce-data-from-scanning-ccd"><em>scanCCD: reduce data from scanning CCD</em></a></li>
124<li class="toctree-l2"><a class="reference internal" href="GSASIIscripts.html#makemacapp-create-mac-applet"><em>makeMacApp: Create Mac Applet</em></a></li>
125<li class="toctree-l2"><a class="reference internal" href="GSASIIscripts.html#unit-tests-self-test-module"><em>unit_tests: Self-test Module</em></a></li>
126</ul>
127</li>
128<li class="toctree-l1"><a class="reference internal" href="exports.html"><em>GSAS-II Export Modules</em></a><ul>
129<li class="toctree-l2"><a class="reference internal" href="exports.html#module-g2export-examples-examples"><em>Module G2export_examples: Examples</em></a></li>
130<li class="toctree-l2"><a class="reference internal" href="exports.html#module-g2export-csv-spreadsheet-export"><em>Module G2export_csv: Spreadsheet export</em></a></li>
131<li class="toctree-l2"><a class="reference internal" href="exports.html#module-g2export-pdb-macromolecular-export"><em>Module G2export_PDB: Macromolecular export</em></a></li>
132<li class="toctree-l2"><a class="reference internal" href="exports.html#module-g2export-image-2d-image-data-export"><em>Module G2export_image: 2D Image data export</em></a></li>
133<li class="toctree-l2"><a class="reference internal" href="exports.html#module-g2export-map-map-export"><em>Module G2export_map: Map export</em></a></li>
134<li class="toctree-l2"><a class="reference internal" href="exports.html#module-g2export-shelx-examples"><em>Module G2export_shelx: Examples</em></a></li>
135<li class="toctree-l2"><a class="reference internal" href="exports.html#module-g2export-cif-cif-exports"><em>Module G2export_CIF: CIF Exports</em></a></li>
136</ul>
137</li>
138<li class="toctree-l1"><a class="reference internal" href="imports.html"><em>GSAS-II Import Modules</em></a><ul>
139<li class="toctree-l2"><a class="reference internal" href="imports.html#writing-an-import-routine">Writing an Import Routine</a><ul>
140<li class="toctree-l3"><a class="reference internal" href="imports.html#init">__init__()</a></li>
141<li class="toctree-l3"><a class="reference internal" href="imports.html#reader">Reader()</a><ul>
142<li class="toctree-l4"><a class="reference internal" href="imports.html#reader-return-values">Reader return values</a></li>
143<li class="toctree-l4"><a class="reference internal" href="imports.html#self-warnings">self.warnings</a></li>
144<li class="toctree-l4"><a class="reference internal" href="imports.html#self-errors">self.errors</a></li>
145<li class="toctree-l4"><a class="reference internal" href="imports.html#self-repeat">self.repeat</a></li>
146<li class="toctree-l4"><a class="reference internal" href="imports.html#support-routines"><em>support routines</em></a></li>
147</ul>
148</li>
149<li class="toctree-l3"><a class="reference internal" href="imports.html#contentsvalidator">ContentsValidator()</a><ul>
150<li class="toctree-l4"><a class="reference internal" href="imports.html#contentsvalidator-return-values">ContentsValidator return values</a></li>
151</ul>
152</li>
153</ul>
154</li>
155<li class="toctree-l2"><a class="reference internal" href="imports.html#currently-defined-phase-import-routines">Currently Defined Phase Import Routines</a><ul>
156<li class="toctree-l3"><a class="reference internal" href="imports.html#module-g2phase-pdb-and-exp"><em>Module G2phase: PDB and .EXP</em></a></li>
157<li class="toctree-l3"><a class="reference internal" href="imports.html#module-g2phase-gpx-import-phase-from-gsas-ii-project"><em>Module G2phase_GPX: Import phase from GSAS-II project</em></a></li>
158<li class="toctree-l3"><a class="reference internal" href="imports.html#module-g2phase-cif-coordinates-from-cif"><em>Module G2phase_CIF: Coordinates from CIF</em></a></li>
159</ul>
160</li>
161<li class="toctree-l2"><a class="reference internal" href="imports.html#currently-defined-powder-data-import-routines">Currently Defined Powder Data Import Routines</a><ul>
162<li class="toctree-l3"><a class="reference internal" href="imports.html#module-g2pwd-gpx-gsas-ii-projects"><em>Module G2pwd_GPX: GSAS-II projects</em></a></li>
163<li class="toctree-l3"><a class="reference internal" href="imports.html#module-g2pwd-fxye-gsas-data-files"><em>Module G2pwd_fxye: GSAS data files</em></a></li>
164<li class="toctree-l3"><a class="reference internal" href="imports.html#module-g2pwd-xye-topas-xye-data"><em>Module G2pwd_xye: Topas .xye data</em></a></li>
165<li class="toctree-l3"><a class="reference internal" href="imports.html#module-g2pwd-cif-cif-powder-data"><em>Module G2pwd_CIF: CIF powder data</em></a></li>
166</ul>
167</li>
168<li class="toctree-l2"><a class="reference internal" href="imports.html#currently-defined-single-crystal-data-import-routines">Currently Defined Single Crystal Data Import Routines</a><ul>
169<li class="toctree-l3"><a class="reference internal" href="imports.html#module-g2sfact-simple-hkl-import"><em>Module G2sfact: simple HKL import</em></a></li>
170<li class="toctree-l3"><a class="reference internal" href="imports.html#module-g2sfact-cif-cif-import"><em>Module G2sfact_CIF: CIF import</em></a></li>
171</ul>
172</li>
173</ul>
174</li>
175</ul>
176</div>
177<div class="section" id="required-packages">
178<h2><em>Required packages</em><a class="headerlink" href="#required-packages" title="Permalink to this headline">¶</a></h2>
179<p>Note that GSAS-II requires the Python extension packages</p>
180<ul class="simple">
181<li>wxPython (<a class="reference external" href="http://wxpython.org/docs/api/">http://wxpython.org/docs/api/</a>),</li>
182<li>NumPy (<a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/">http://docs.scipy.org/doc/numpy/reference/</a>),</li>
183<li>SciPy (<a class="reference external" href="http://docs.scipy.org/doc/scipy/reference/">http://docs.scipy.org/doc/scipy/reference/</a>),</li>
184<li>matplotlib (<a class="reference external" href="http://matplotlib.org/contents.html">http://matplotlib.org/contents.html</a>) and</li>
185<li>PyOpenGL (<a class="reference external" href="http://pyopengl.sourceforge.net/documentation">http://pyopengl.sourceforge.net/documentation</a>)</li>
186</ul>
187<p>These are not distributed
188as part of the Python standard library and must be obtained separately
189(or in a bundled Python package such as the Enthought Python
190Distribution/Canopy).
191The PyOpenGL package is installed into Python by GSAS-II if not found,
192so it does not need to be included in the Python bundle.</p>
193</div>
194</div>
195
196
197          </div>
198        </div>
199      </div>
200      <div class="sphinxsidebar">
201        <div class="sphinxsidebarwrapper">
202            <p class="logo"><a href="#">
203              <img class="logo" src="_static/G2_html_logo.png" alt="Logo"/>
204            </a></p>
205  <h3><a href="#">Table Of Contents</a></h3>
206  <ul>
207<li><a class="reference internal" href="#">GSAS-II Developer&#8217;s Documentation</a><ul>
208<li><a class="reference internal" href="#required-packages"><em>Required packages</em></a></li>
209</ul>
210</li>
211</ul>
212
213  <h4>Next topic</h4>
214  <p class="topless"><a href="GSASII.html"
215                        title="next chapter"><em>GSAS-II Main Module</em></a></p>
216  <h3>This Page</h3>
217  <ul class="this-page-menu">
218    <li><a href="_sources/index.txt"
219           rel="nofollow">Show Source</a></li>
220  </ul>
221<div id="searchbox" style="display: none">
222  <h3>Quick search</h3>
223    <form class="search" action="search.html" method="get">
224      <input type="text" name="q" />
225      <input type="submit" value="Go" />
226      <input type="hidden" name="check_keywords" value="yes" />
227      <input type="hidden" name="area" value="default" />
228    </form>
229    <p class="searchtip" style="font-size: 90%">
230    Enter search terms or a module, class or function name.
231    </p>
232</div>
233<script type="text/javascript">$('#searchbox').show(0);</script>
234        </div>
235      </div>
236      <div class="clearer"></div>
237    </div>
238    <div class="related">
239      <h3>Navigation</h3>
240      <ul>
241        <li class="right" style="margin-right: 10px">
242          <a href="genindex.html" title="General Index"
243             >index</a></li>
244        <li class="right" >
245          <a href="py-modindex.html" title="Python Module Index"
246             >modules</a> |</li>
247        <li class="right" >
248          <a href="GSASII.html" title="GSAS-II Main Module"
249             >next</a> |</li>
250        <li><a href="#">GSAS-II 0.2.0 documentation</a> &raquo;</li> 
251      </ul>
252    </div>
253    <div class="footer">
254        &copy; Copyright 2013, Von Dreele and Toby for Argonne National Laboratory.
255      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
256    </div>
257  </body>
258</html>
Note: See TracBrowser for help on using the repository browser.