Skip to content

Commit 1e5050d

Browse files
committed
Add package description in README.rst
1 parent daf401d commit 1e5050d

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

Diff for: README.rst

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

3838
A python package implementing the stretched NMF algorithm.
3939

40-
* LONGER DESCRIPTION HERE
40+
``diff.pysnmf`` 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?"
4144

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

0 commit comments

Comments
 (0)