Skip to content

Commit 7ff0ae6

Browse files
committed
added API links and documentation about diffpy.Structure.
1 parent 67c9425 commit 7ff0ae6

File tree

1 file changed

+39
-8
lines changed

1 file changed

+39
-8
lines changed

documentation.shtml

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,56 @@
1515
user manual formatted as
1616
<a href="doc/pdfgui/pdfgui.html">HTML</a>,
1717
<a href="doc/pdfgui/pdfgui.pdf">PDF</a>
18+
<br>
19+
tutorial files in a
20+
<a href="doc/pdfgui/pdfgui-tutorial.zip">zip archive</a>
21+
<br>
22+
auto-generated
23+
<a href="http://docs.danse.us/diffraction/diffpy.pdfgui/">API documentation</a>
1824
</td>
1925
</tr>
2026
<tr>
2127
<td colspan="2"> <img src="images/spacer.png" width="1" height="5" alt=""> </td>
2228
</tr>
29+
2330
<tr>
2431
<td width="100" valign="top">
2532
<strong>PDFfit2</strong>
2633
</td>
2734
<td>
28-
Documentation is not yet available besides built-in help system.
29-
Since commands and variable names are quite similar to the old PDFFIT,
30-
you can use this
35+
user manual not available.
36+
To get started, check the
37+
<a href="doc/pdffit2/pdffit2-examples.zip">examples</a>
38+
from the code distribution and the pdffit2 built-in help.
39+
For a complete reference, see the auto-generated
40+
<a href="http://docs.danse.us/diffraction/diffpy.pdffit2/">API</a>,
41+
especially for the class PdfFit.
42+
<p>
43+
Functions and variables are quite similar as
44+
in the old PDFFIT, so its
3145
<a href="doc/pdffit/pdf_man.pdf">manual</a>
3246
and
3347
<a href="doc/pdffit/pdf_cmd.pdf">command reference</a>
34-
to get started with the program.
48+
should help as well.
49+
</p>
50+
</td>
51+
</tr>
52+
<tr>
53+
<td colspan="2"> <img src="images/spacer.png" width="1" height="5" alt=""> </td>
54+
</tr>
55+
56+
<tr>
57+
<td width="100" valign="top">
58+
<strong>Structure</strong>
59+
</td>
60+
<td>
61+
user manual not available.
62+
To get started, see
63+
<a href="doc/Structure/Structure-examples.zip">examples</a>
64+
from the code distribution and the auto-generated
65+
<a href="http://docs.danse.us/diffraction/diffpy.Structure/">API</a>.
66+
For more information contact the developers or ask at the
67+
diffpy-users Google group.
3568
</td>
3669
</tr>
3770
</table>
@@ -49,15 +82,14 @@
4982

5083
<ol type="1">
5184
<li>
52-
C.&nbsp;L.&nbsp;Farrow, P.&nbsp;Juhas, J.&nbsp;W.&nbsp;Liu,
53-
D.&nbsp;Bryndin, E.&nbsp;S.&nbsp;Bozin,
85+
C.&nbsp;L.&nbsp;Farrow, P.&nbsp;Juhás, J.&nbsp;W.&nbsp;Liu,
86+
D.&nbsp;Bryndin, E.&nbsp;S.&nbsp;Božin,
5487
J.&nbsp;Bloch, Th.&nbsp;Proffen and
5588
S.&nbsp;J.&nbsp;L.&nbsp;Billinge,
5689
<a href="http://stacks.iop.org/0953-8984/19/335219">
5790
PDFfit2 and PDFgui: computer programs for studying
5891
nanostructure in crystals</a>,
5992
<i>J.&nbsp;Phys.: Condens. Matter</i> <b>19</b>, 335219 (2007)
60-
<p></p>
6193
</li>
6294

6395
<li>
@@ -66,7 +98,6 @@ Th.&nbsp;Proffen and S.&nbsp;J.&nbsp;L.&nbsp;Billinge,
6698
PDFFIT a program for full profile structural refinement of the atomic pair
6799
distribution function</a>, <i>J.&nbsp;Appl. Crystallogr.</i>
68100
<b>32</b>, 572 (1999)
69-
<p></p>
70101
</li>
71102
</ol>
72103

0 commit comments

Comments
 (0)