Skip to content

Commit 5446afd

Browse files
committed
Make a clear ref to the paper in readme
1 parent 4bc33e7 commit 5446afd

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc/source/index.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ Welcome to SNMF's Documentation!
22
====================================
33

44
``SNMF``: This library implements the stretched non negative matrix factorization (sNMF) and sparse stretched NMF
5-
(ssNMF) algorithms.
5+
(ssNMF) algorithms described in the paper "Stretched Non-negative Matrix Factorization" by Ran Gu et al. (2023),
6+
which is referenced under the Citation section below.
67

78
This algorithm is designed to do an NMF factorization on a set of signals ignoring any uniform stretching of the signal
89
on the independent variable axis. For example, for powder diffraction data taken from samples containing multiple
@@ -54,7 +55,7 @@ by citing the following paper in your publication:
5455
Authors
5556
-------
5657

57-
``diffpy.snmf`` is developed by members of the Billinge Group at
58+
``snmf`` implements the algorithms described in ...., developed by members of the Billinge Group at
5859
Columbia University, Brookhaven National Laboratory, Stony Brook University, Nankai University, and Colorado State
5960
University including Ran Gu, Yevgeny Rakita, Ling Lan, Zach Thatcher, Gabrielle E. Kamm, Daniel O'Nolan, Brennan Mcbride,
6061
Jame R. Neilson, Karena W. Chapman, Qiang Du, and Simon J. L. Billinge.

0 commit comments

Comments
 (0)