Skip to content

Commit d8ee2b0

Browse files
committed
chore: keep the old index.rst
1 parent d57fbcc commit d8ee2b0

File tree

1 file changed

+55
-17
lines changed

1 file changed

+55
-17
lines changed

doc/source/index.rst

Lines changed: 55 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,7 @@
77
``diffpy.pdfgui`` - Graphical user interface program for structure refinements to the atomic pair distribution function.
88

99
| Software version |release|
10-
| Last updated |today|.
11-
12-
===============
13-
Getting started
14-
===============
15-
16-
Welcome to the ``diffpy.pdfgui`` documentation!
10+
| Last updated |today|
1711
1812
For users who do not have the expertise or necessity for command
1913
line analysis, PDFgui is a convenient and easy to use graphical front
@@ -22,38 +16,82 @@ fitting of the atomic pair distribution function (PDF) derived from x-ray
2216
or neutron diffraction data and comes with built in graphical and structure
2317
visualization capabilities.
2418

25-
To get started, please visit the :ref:`Getting started <getting-started>` page.
19+
PDFgui is a friendly interface to the PDFfit2 refinement engine, with many
20+
powerful extensions. To get started, please open the :ref:`manual`
21+
(:download:`pdf <pdfgui.pdf>`) from the help menu or follow the :ref:`tutorial`.
2622

2723
=======
2824
Authors
2925
=======
3026

31-
``diffpy.pdfgui`` is developed by Simon J.L. Billinge group. The maintainer for this project is Simon J.L. Billinge group. For a detailed list of contributors see
27+
DiffPy was initiated as part of the Distributed Data Analysis of Neutron
28+
Scattering Experiments (DANSE) project, funded by the National Science
29+
Foundation under grant DMR-0520547. Any opinions, findings, and conclusions or
30+
recommendations expressed in this material are those of the author(s)
31+
and do not necessarily reflect the views of the NSF.
32+
33+
The main contributors to this package were
34+
35+
Chris Farrow,
36+
Jiwu Liu,
37+
Pavol Juhas,
38+
Dmitriy Bryndin
39+
40+
Other current and former contributors of the DiffPy project include
41+
42+
Simon Billinge,
43+
Chris Farrow,
44+
Emil Bozin,
45+
Wenduo Zhou,
46+
Peng Tian
47+
48+
The DiffPy team is part of the Billinge Group at Columbia University in New York,
49+
within the Department of Applied Physics and Applied Mathematics.
50+
51+
For a detailed list of contributors see
3252
https://github.com/diffpy/diffpy.pdfgui/graphs/contributors.
3353

54+
=========
55+
Reference
56+
=========
57+
58+
If you use this program for a scientific research that leads to publication,
59+
we ask that you acknowledge use of the program by citing the following paper
60+
in your publication:
61+
62+
C L Farrow, P Juhas, J W Liu, D Bryndin, E S Božin,
63+
J Bloch, Th Proffen and S J L Billinge, `PDFfit2 and PDFgui:
64+
computer programs for studying nanostructure in crystals <https://doi.org/10.1088/0953-8984/19/33/335219>`_,
65+
J. Phys.: Condens. Matter 19 (2007) 335219.
66+
3467
============
3568
Installation
3669
============
3770

3871
See the `README <https://github.com/diffpy/diffpy.pdfgui#installation>`_
3972
file included with the distribution.
4073

41-
================
42-
Acknowledgements
43-
================
74+
========
75+
Tutorial
76+
========
77+
78+
The tutorial for the package can be found here:
79+
80+
.. toctree::
4481

45-
``diffpy.pdfgui`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.
82+
tutorial
4683

4784
=================
4885
Table of contents
4986
=================
5087
.. toctree::
51-
:maxdepth: 2
88+
:titlesonly:
5289

53-
getting-started
54-
Package API <api/diffpy.pdfgui>
55-
release
90+
examples
91+
extras
5692
license
93+
release
94+
Package API <api/diffpy.pdfgui>
5795

5896
=======
5997
Indices

0 commit comments

Comments
 (0)