Changeset 2832


Ignore:
Timestamp:
May 12, 2017 5:48:33 PM (5 years ago)
Author:
toby
Message:

documentation updates

Location:
trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/source/conf.py

    r2805 r2832  
    142142# General information about the project.
    143143project = u'GSAS-II'
    144 copyright = u'2013-2017, Von Dreele and Toby for Argonne National Laboratory'
     144copyright = u'2013-2017, R.B. Von Dreele and B.H. Toby for Argonne National Laboratory'
    145145
    146146# The version info for the project you're documenting, acts as replacement for
  • trunk/docs/source/index.rst

    r2479 r2832  
    3030
    3131* wxPython (http://wxpython.org/docs/api/),
     32  * note that GSAS-II has been tested with wxPython 2.x and 3.0.x; It
     33    it expected to have problems with wxPython 4.x at present.
    3234* NumPy (http://docs.scipy.org/doc/numpy/reference/),
    3335* SciPy (http://docs.scipy.org/doc/scipy/reference/),
     
    3537* PyOpenGL (http://pyopengl.sourceforge.net/documentation)
    3638
    37 Two packages are used by some parts of the code, but are not required:
     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.
    3842
    3943* PIL (http://www.pythonware.com/products/pil/) or Pillow (https://pillow.readthedocs.org). This is used to save
     
    4650Note that the packages listed above are not distributed as part of the Python standard
    4751library and must be obtained separately (or in a bundled Python
    48 package such as the Enthought Inc.'s Canopy or
    49 Continuum.io's anaconda; we also use the older Enthought Python
     52package such as Continuum.io's Anaconda or Enthought Inc.'s Canopy;
     53we also do some testing using the older Enthought Python
    5054Distribution). 
    5155One exception is the PyOpenGL package. This will be installed into
  • trunk/help/gsasII.html

    r2653 r2832  
    32243224     style='font-weight:normal'>Fitting individual peaks &amp; autoindexing </span></a></span></strong><span
    32253225     style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
    3226      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/FitPeaks/">exercise
     3226     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/FitPeaks/data">exercise
     3227     files</a>)<o:p></o:p></span></li>
     3228</ul>
     3229
     3230<p><i>Rietveld fitting</i></p>
     3231
     3232<ul type=disc>
     3233 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     3234     mso-list:l25 level1 lfo2;tab-stops:list .5in'><strong><span
     3235     style='mso-fareast-font-family:"Times New Roman"'><a
     3236     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/CWNeutron/Neutron%20CW%20Powder%20Data.htm"><span
     3237     style='font-weight:normal'>CW Neutron Powder fit for Yttrium-Iron Garnet </span></a></span></strong><span
     3238     style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
     3239     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/CWNeutron/data">exercise
     3240     files</a>)<o:p></o:p></span></li>
     3241 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     3242     mso-list:l25 level1 lfo2;tab-stops:list .5in'><strong><span
     3243     style='mso-fareast-font-family:"Times New Roman"'><a
     3244     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/LabData/Laboratory%20X.htm"><span
     3245     style='font-weight:normal'>Fitting laboratory X-ray powder data for
     3246     fluoroapatite </span></a></span></strong><span style='mso-fareast-font-family:
     3247     "Times New Roman"'>(Link to <a
     3248     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/LabData/data">exercise
     3249     files</a>)<o:p></o:p></span></li>
     3250 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     3251     mso-list:l25 level1 lfo2;tab-stops:list .5in'><strong><span
     3252     style='mso-fareast-font-family:"Times New Roman"'><a
     3253     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/CWCombined/Combined%20refinement.htm"><span
     3254     style='font-weight:normal'>Combined X-ray/CW-neutron refinement of PbSO4 </span></a></span></strong><span
     3255     style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
     3256     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/CWCombined/data">exercise
     3257     files</a>)<o:p></o:p></span></li>
     3258 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     3259     mso-list:l25 level1 lfo2;tab-stops:list .5in'><strong><span
     3260     style='mso-fareast-font-family:"Times New Roman"'><a
     3261     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/TOF-CW%20Joint%20Refinement/TOF%20combined%20XN%20Rietveld%20refinement%20in%20GSAS.htm"><span
     3262     style='font-weight:normal'>Combined X-ray/TOF-neutron Rietveld refinement </span></a></span></strong><span
     3263     style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
     3264     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/TOF-CW%20Joint%20Refinement/data">exercise
    32273265     files</a>)<o:p></o:p></span></li>
    32283266 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     
    32333271     Points </span></a></span></strong><span style='mso-fareast-font-family:
    32343272     "Times New Roman"'>(Link to <a
    3235      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/BkgFit/">exercise
     3273     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/BkgFit//data">exercise
    32363274     files</a>)<o:p></o:p></span></li>
    32373275</ul>
    32383276
    3239 <p><i>Rietveld fitting</i></p>
     3277<p><i>Large-scale Rietveld fitting</i></p>
    32403278
    32413279<ul type=disc>
    3242  <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
    3243      mso-list:l25 level1 lfo2;tab-stops:list .5in'><strong><span
    3244      style='mso-fareast-font-family:"Times New Roman"'><a
    3245      href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/CWNeutron/Neutron%20CW%20Powder%20Data.htm"><span
    3246      style='font-weight:normal'>CW Neutron Powder fit for Yttrium-Iron Garnet </span></a></span></strong><span
    3247      style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
    3248      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/CWNeutron">exercise
    3249      files</a>)<o:p></o:p></span></li>
    3250  <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
    3251      mso-list:l25 level1 lfo2;tab-stops:list .5in'><strong><span
    3252      style='mso-fareast-font-family:"Times New Roman"'><a
    3253      href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/LabData/Laboratory%20X.htm"><span
    3254      style='font-weight:normal'>Fitting laboratory X-ray powder data for
    3255      fluoroapatite </span></a></span></strong><span style='mso-fareast-font-family:
    3256      "Times New Roman"'>(Link to <a
    3257      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/LabData">exercise
    3258      files</a>)<o:p></o:p></span></li>
    3259  <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
    3260      mso-list:l25 level1 lfo2;tab-stops:list .5in'><strong><span
    3261      style='mso-fareast-font-family:"Times New Roman"'><a
    3262      href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/CWCombined/Combined%20refinement.htm"><span
    3263      style='font-weight:normal'>Combined X-ray/CW-neutron refinement of PbSO4 </span></a></span></strong><span
    3264      style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
    3265      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/CWCombined">exercise
    3266      files</a>)<o:p></o:p></span></li>
    3267  <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
    3268      mso-list:l25 level1 lfo2;tab-stops:list .5in'><strong><span
    3269      style='mso-fareast-font-family:"Times New Roman"'><a
    3270      href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/TOF-CW%20Joint%20Refinement/TOF%20combined%20XN%20Rietveld%20refinement%20in%20GSAS.htm"><span
    3271      style='font-weight:normal'>Combined X-ray/TOF-neutron Rietveld refinement </span></a></span></strong><span
    3272      style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
    3273      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/TOF-CW%20Joint%20Refinement">exercise
    3274      files</a>)<o:p></o:p></span></li>
    32753280 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
    32763281     mso-list:l25 level1 lfo2;tab-stops:list .5in'><strong><span
     
    32793284     style='font-weight:normal'>Sequential refinement of multiple datasets </span></a></span></strong><span
    32803285     style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
    3281      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/SeqRefine">exercise
     3286     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/SeqRefine/data">exercise
    32823287     files</a>)<o:p></o:p></span></li>
    32833288 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     
    32883293     Sequential Fits </span></a></span></strong><span style='mso-fareast-font-family:
    32893294     "Times New Roman"'>(no exercise files)<o:p></o:p></span></li>
     3295</ul>
     3296<p><i>Stacking Fault Modeling</i></p>
     3297
     3298<ul type=disc>
     3299   
     3300 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     3301     mso-list:l4 level1 lfo1;tab-stops:list .5in'><strong><span
     3302     style='mso-fareast-font-family:"Times New Roman"'><a
     3303     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/StackingFaults-I/Stacking Faults-I.htm"><span
     3304     style='font-weight:normal'>
     3305  Stacking fault simulations for diamond
     3306     </span></a></span></strong><span style='mso-fareast-font-family:
     3307     "Times New Roman"'>
     3308  <o:p></o:p></span></li>
     3309     
     3310 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     3311     mso-list:l4 level1 lfo1;tab-stops:list .5in'><strong><span
     3312     style='mso-fareast-font-family:"Times New Roman"'><a
     3313     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/StackingFaults-II/Stacking Faults II.htm"><span style='font-weight:normal'>
     3314     Stacking fault simulations for Keokuk kaolinite
     3315     </span></a></span></strong><span style='mso-fareast-font-family:
     3316     "Times New Roman"'>
     3317     (Link to <a href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/StackingFaults-II/data">exercise files</a>)<o:p></o:p></span></li>
     3318
     3319<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     3320     mso-list:l4 level1 lfo1;tab-stops:list .5in'><strong><span
     3321     style='mso-fareast-font-family:"Times New Roman"'><a
     3322     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/StackingFaults-III/Stacking Faults-III.htm"><span style='font-weight:normal'>
     3323     Stacking fault simulations for Georgia kaolinite
     3324     </span></a></span></strong><span style='mso-fareast-font-family:
     3325     "Times New Roman"'>(Link to <a
     3326     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/StackingFaults-III/data">exercise
     3327     files</a>)<o:p></o:p></span></li>
    32903328</ul>
    32913329
     
    33133351     data </span></a></span></strong><span style='mso-fareast-font-family:"Times New Roman"'>(Link
    33143352     to <a
    3315      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/TOF%20Charge%20Flipping">exercise
     3353     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/TOF%20Charge%20Flipping/data">exercise
    33163354     files</a>)<o:p></o:p></span></li>
     3355
     3356 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     3357     mso-list:l15 level1 lfo3;tab-stops:list .5in'><strong><span
     3358     style='mso-fareast-font-family:"Times New Roman"'><a
     3359     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/CFXraySingleCrystal/CFSingleCrystal.htm"><span
     3360     style='font-weight:normal'>Charge flipping with X-ray single crystal
     3361     data </span></a></span></strong><span style='mso-fareast-font-family:"Times New Roman"'>(Link
     3362     to <a
     3363     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/CFXraySingleCrystal/data/">exercise
     3364     files</a>)<o:p></o:p></span></li>
     3365
     3366     
    33173367 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
    33183368     mso-list:l15 level1 lfo3;tab-stops:list .5in'><strong><span
     
    33213371     style='font-weight:normal'>Monte-Carlo simulated annealing structure </span></a></span></strong><span
    33223372     style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
    3323      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/MCsimanneal">exercise
     3373     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/MCsimanneal/data">exercise
    33243374     files</a>)<o:p></o:p></span></li>
    33253375</ul>
     
    33343384     style='font-weight:normal'>Calibration of an area detector </span></a></span></strong><span
    33353385     style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
    3336      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/2DCalibration">exercise
     3386     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/2DCalibration/data">exercise
    33373387     files</a>)<o:p></o:p></span></li>
    33383388 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     
    33483398     style='font-weight:normal'>Calibration of a Neutron TOF diffractometer </span></a></span></strong><span
    33493399     style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
    3350      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/TOF%20Calibration">exercise
     3400     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/TOF%20Calibration/data">exercise
    33513401     files</a>)<o:p></o:p></span></li>
    33523402</ul>
     
    33613411     style='font-weight:normal'>Strain fitting of 2D data </span></a></span></strong><span
    33623412     style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
    3363      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/2DStrain">exercise
     3413     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/2DStrain/data">exercise
    33643414     files</a>)<o:p></o:p></span></li>
    33653415 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     
    33693419     style='font-weight:normal'>Texture analysis of 2D data </span></a></span></strong><span
    33703420     style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
    3371      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/2DTexture">exercise
     3421     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/2DTexture/data">exercise
    33723422     files</a>)<o:p></o:p></span></li>
    33733423</ul>
     
    33823432     style='font-weight:normal'>Image Processing of small angle x-ray data </span></a></span></strong><span
    33833433     style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
    3384      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/SAimages">exercise
     3434     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/SAimages/data">exercise
    33853435     files</a>)<o:p></o:p></span></li>
    33863436 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     
    33903440     style='font-weight:normal'>Fitting small angle x-ray data (alumina powder)
    33913441     </span></a></span></strong><span style='mso-fareast-font-family:"Times New Roman"'>(Link
    3392      to <a href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/SAfit">exercise
     3442     to <a href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/SAfit/data">exercise
    33933443     files</a>)<o:p></o:p></span></li>
    33943444 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     
    33993449     (alumina powder) </span></a></span></strong><span style='mso-fareast-font-family:
    34003450     "Times New Roman"'>(Link to <a
    3401      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/SAsize">exercise
     3451     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/SAsize/data">exercise
    34023452     files</a>)<o:p></o:p></span></li>
    34033453 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     
    34083458     scattering data </span></a></span></strong><span style='mso-fareast-font-family:
    34093459     "Times New Roman"'>(Link to <a
    3410      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/SAseqref">exercise
     3460     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/SAseqref/data">exercise
    34113461     files</a>)<o:p></o:p></span></li>
    34123462</ul>
     
    34213471     style='font-weight:normal'>Strain fitting of 2D data </span></a></span></strong><span
    34223472     style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
    3423      href="https://subversion.xray.aps.anl.gov/pyGSAS/Exercises/2DStrain">exercise
     3473     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/2DStrain/data">exercise
     3474     files</a>)<o:p></o:p></span></li>
     3475     
     3476 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     3477     mso-list:l33 level1 lfo7;tab-stops:list .5in'><strong><span
     3478     style='mso-fareast-font-family:"Times New Roman"'><a
     3479     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/MerohedralTwins/Merohedral twin refinement in GSAS.htm"><span
     3480     style='font-weight:normal'>Merohedral twin refinements</span></a></span></strong><span
     3481     style='mso-fareast-font-family:"Times New Roman"'> (Link to <a
     3482     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/MerohedralTwins/data">exercise
     3483     files</a>)<o:p></o:p></span></li>
     3484
     3485 <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
     3486     mso-list:l33 level1 lfo7;tab-stops:list .5in'><strong><span
     3487     style='mso-fareast-font-family:"Times New Roman"'><a
     3488     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/TOF Single Crystal Refinement/TOF single crystal refinement in GSAS.htm"><span
     3489     style='font-weight:normal'>Single crystal refinement from TOF data
     3490     </span></a></span></strong><span
     3491     style='mso-fareast-font-family:"Times New Roman"'>(Link to <a
     3492     href="https://subversion.xray.aps.anl.gov/pyGSAS/Tutorials/TOF Single Crystal Refinement/data">exercise
    34243493     files</a>)<o:p></o:p></span></li>
    34253494</ul>
     
    72147283<hr size=2 width="100%" align=center>
    72157284
    7216 <!-- hhmts start -->Last modified: Sat Jan 21 14:53:49 CST 2017 <!-- hhmts end -->
     7285<!-- hhmts start -->Last modified: Fri May 12 17:41:58 CDT 2017 <!-- hhmts end -->
    72177286
    72187287</div>
Note: See TracChangeset for help on using the changeset viewer.