Skip to content

Commit a04340d

Browse files
committed
chore: synchronize README and index of the docs with updated text from docs
1 parent 7568d4d commit a04340d

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,16 @@
3838
diffpy.utils Package
3939
========================================================================
4040

41-
General purpose shared utilities for the diffpy libraries.
42-
43-
The diffpy.utils package provides functions for extracting array data from
44-
variously formatted text files, an interpolation function based on the
45-
Whittaker-Shannon formula that can be used to resample a PDF or other profile
46-
function over a new grid, `DiffractionObject` for conveniently manipulating
47-
diffraction data, and some wx GUI utilities used by the PDFgui
48-
program.
41+
General utilities for analyzing diffraction data
42+
43+
The diffpy.utils package provides a number of functions and classes designed to help
44+
researchers analyze their diffraction data. It also includes some functionality for
45+
carrying out PDF analysis. Examples are parsers for reading common format diffraction
46+
data files, ``DiffractionObjects`` that allow you to do algebra on diffraction patterns,
47+
tools for better capture and propagation of metadata,
48+
diffraction-friendly interpolation routines, as well as some other tools used across
49+
diffpy libraries.
50+
4951

5052
Citation
5153
--------

0 commit comments

Comments
 (0)