Skip to content

Commit c471a89

Browse files
committed
add longer description and citation
1 parent acf714f commit c471a89

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.rst

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,13 @@
3737

3838
Tool for visualizing 3D diffraction and PDF Images.
3939

40-
* LONGER DESCRIPTION HERE
40+
* Diffpy.fourigui is a tool to visualize and process 3D data sets written with the Python programming language.
41+
Diffpy.fourigui always displays one slice perpendicular to one axis and allows scrolling through the 3D data set along
42+
the given axis with a slider. It shows feedback values such as global and local maxima, minima or NAN ratios.
43+
The matplotlib panel e.g. for zooming and saving figures is featured. Diffpy.fourigui is designed for the processing of 3D
44+
atomic pair distribution functions (PDFs). One can load a 3D reciprocal space scattering volume which can be Fourier
45+
transformed to the 3D PDF. Thereby, one can apply cut off frequencies beyond and below given Q values, compare the
46+
results and switch between the scattering volume in reciprocal space and 3D PDF in real space.
4147

4248
For more information about the diffpy.fourigui library, please consult our `online documentation <https://diffpy.github.io/diffpy.fourigui>`_.
4349

@@ -46,7 +52,10 @@ Citation
4652

4753
If you use diffpy.fourigui in a scientific publication, we would like you to cite this package as
4854

49-
diffpy.fourigui Package, https://github.com/diffpy/diffpy.fourigui
55+
S. Y. Harouna-Mayer, S. Tao, Z. Gong, M. v Zimmermann, D. Koziej, A.-C. Dippel, and S. J. L. Billinge
56+
`Real-Space Texture and Pole-Figure Analysis Using the 3D Pair Distribution
57+
Function on a Platinum Thin Film <https://doi.org/10.1107/S2052252522006674>`. IUCrJ 2022, 9 (5), 594–603.
58+
5059

5160
Installation
5261
------------

0 commit comments

Comments
 (0)