diff --git a/README.rst b/README.rst index 520d402..cc86c81 100644 --- a/README.rst +++ b/README.rst @@ -38,14 +38,16 @@ diffpy.utils Package ======================================================================== -General purpose shared utilities for the diffpy libraries. - -The diffpy.utils package provides functions for extracting array data from -variously formatted text files, an interpolation function based on the -Whittaker-Shannon formula that can be used to resample a PDF or other profile -function over a new grid, `DiffractionObject` for conveniently manipulating -diffraction data, and some wx GUI utilities used by the PDFgui -program. +General utilities for analyzing diffraction data + +The diffpy.utils package provides a number of functions and classes designed to help +researchers analyze their diffraction data. It also includes some functionality for +carrying out PDF analysis. Examples are parsers for reading common format diffraction +data files, ``DiffractionObjects`` that allow you to do algebra on diffraction patterns, +tools for better capture and propagation of metadata, +diffraction-friendly interpolation routines, as well as some other tools used across +diffpy libraries. + Citation -------- diff --git a/news/readme.rst b/news/readme.rst new file mode 100644 index 0000000..978de17 --- /dev/null +++ b/news/readme.rst @@ -0,0 +1,23 @@ +**Added:** + +* no news needed: just a chore of no import + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* diff --git a/pyproject.toml b/pyproject.toml index 4f9238a..9056036 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -11,7 +11,7 @@ authors = [ maintainers = [ { name="Simon J.L. Billinge group", email="simon.billinge@gmail.com" }, ] -description = "Shared utilities for diffpy packages" +description = "General utilities for analyzing diffraction data" keywords = ["text data parsers", "wx grid", "diffraction objects"] readme = "README.rst" requires-python = ">=3.11, <3.14"