From a04340df7c7aeac199f43d861711dd3e4be96535 Mon Sep 17 00:00:00 2001 From: Simon Billinge Date: Wed, 1 Jan 2025 16:37:02 -0500 Subject: [PATCH 1/3] chore: synchronize README and index of the docs with updated text from docs --- README.rst | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 520d4029..cc86c81e 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 -------- From 622c335c45f3395dada02d4e426ac2c1cea886cb Mon Sep 17 00:00:00 2001 From: Simon Billinge Date: Wed, 1 Jan 2025 16:38:09 -0500 Subject: [PATCH 2/3] news --- news/readme.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 news/readme.rst diff --git a/news/readme.rst b/news/readme.rst new file mode 100644 index 00000000..978de17c --- /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:** + +* From f0350aa7e058b63c31b8ae4c3d8fcb75ae638361 Mon Sep 17 00:00:00 2001 From: Simon Billinge Date: Wed, 1 Jan 2025 16:48:24 -0500 Subject: [PATCH 3/3] shynch pyproject.toml --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 4f9238ae..90560367 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"