diff --git a/README.rst b/README.rst index b3b8833..aa574de 100644 --- a/README.rst +++ b/README.rst @@ -37,7 +37,13 @@ A python package implementing the stretched NMF algorithm. -* LONGER DESCRIPTION HERE +``diffpy.snmf`` implements the stretched non negative matrix factorization (sNMF) and sparse stretched NMF +(ssNMF) algorithms. + +This algorithm is designed to do an NMF factorization on a set of signals ignoring any uniform stretching of the signal +on the independent variable axis. For example, for powder diffraction data taken from samples containing multiple +chemical phases where the measurements were done at different temperatures and the materials were undergoing thermal +expansion. For more information about the diffpy.snmf library, please consult our `online documentation `_. diff --git a/doc/source/index.rst b/doc/source/index.rst index 735ea36..1122b4f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,7 +2,8 @@ Welcome to SNMF's Documentation! ==================================== ``SNMF``: This library implements the stretched non negative matrix factorization (sNMF) and sparse stretched NMF -(ssNMF) algorithms described in ... +(ssNMF) algorithms described in the paper "Stretched Non-negative Matrix Factorization" by Ran Gu et al. (2023), +which is referenced under the Citation section below. This algorithm is designed to do an NMF factorization on a set of signals ignoring any uniform stretching of the signal on the independent variable axis. For example, for powder diffraction data taken from samples containing multiple