Skip to content

Commit 4bc33e7

Browse files
committed
Update REAMDE longer description
1 parent 50bf2fd commit 4bc33e7

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.rst

+7-4
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,13 @@
3737

3838
A python package implementing the stretched NMF algorithm.
3939

40-
``diffpy.snmf`` is a Python package that increases the insight one can obtain from a measured series time-dependent signals
41-
through applying the stretched nonnegative matrix factorization (sNMF) and spare stretched nonnegative matrix factorization
42-
algorithms (ssNMF). The package seeks to answer the question: "What are the structural signals composing my measured signal at
43-
each moment in time?"
40+
``diffpy.snmf`` implements the stretched non negative matrix factorization (sNMF) and sparse stretched NMF
41+
(ssNMF) algorithms.
42+
43+
This algorithm is designed to do an NMF factorization on a set of signals ignoring any uniform stretching of the signal
44+
on the independent variable axis. For example, for powder diffraction data taken from samples containing multiple
45+
chemical phases where the measurements were done at different temperatures and the materials were undergoing thermal
46+
expansion.
4447

4548
For more information about the diffpy.snmf library, please consult our `online documentation <https://diffpy.github.io/diffpy.snmf>`_.
4649

0 commit comments

Comments
 (0)