diff --git a/README.rst b/README.rst index 59edf60..58f2269 100644 --- a/README.rst +++ b/README.rst @@ -37,7 +37,13 @@ Tool for visualizing 3D diffraction and PDF Images. -* LONGER DESCRIPTION HERE +* Diffpy.fourigui is a tool to visualize and process 3D data sets written with the Python programming language. +Diffpy.fourigui always displays one slice perpendicular to one axis and allows scrolling through the 3D data set along +the given axis with a slider. It shows feedback values such as global and local maxima, minima or NAN ratios. +The matplotlib panel e.g. for zooming and saving figures is featured. Diffpy.fourigui is designed for the processing of 3D +atomic pair distribution functions (PDFs). One can load a 3D reciprocal space scattering volume which can be Fourier +transformed to the 3D PDF. Thereby, one can apply cut off frequencies beyond and below given Q values, compare the +results and switch between the scattering volume in reciprocal space and 3D PDF in real space. For more information about the diffpy.fourigui library, please consult our `online documentation `_. @@ -46,7 +52,10 @@ Citation If you use diffpy.fourigui in a scientific publication, we would like you to cite this package as - diffpy.fourigui Package, https://github.com/diffpy/diffpy.fourigui + S. Y. Harouna-Mayer, S. Tao, Z. Gong, M. V. Zimmermann, D. Koziej, A.-C. Dippel, and S. J. L. Billinge, + `Real-Space Texture and Pole-Figure Analysis Using the 3D Pair Distribution + Function on a Platinum Thin Film `_. *IUCrJ* **9 (5)**, 594–603 (2022). + Installation ------------ diff --git a/news/description.rst b/news/description.rst new file mode 100644 index 0000000..ae942cc --- /dev/null +++ b/news/description.rst @@ -0,0 +1,23 @@ +**Added:** + +* Added longer description to README along with proper citation for `diffpy.fourigui` + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*