Add longer description in README.rst and remove redundant info in index.rst #70
Conversation
|
I feel we are pretty close to the end of the whole cookiecutting process... Update: I received feedback from Tieqiong. I will reflect them in the following PR |
README.rst
Outdated
| @@ -37,7 +37,10 @@ | |||
|
|
|||
| A python package implementing the stretched NMF algorithm. | |||
|
|
|||
| * LONGER DESCRIPTION HERE | |||
| ``diffpy.snmf`` is a Python package that increases the insight one can obtain from a measured series time-dependent signals | |||
There was a problem hiding this comment.
Please can you have another go, maybe pulling from the paper or the synopsis or professional summary in the regolith citations database in billingegroup/rh-db-public?
| @@ -2,7 +2,7 @@ 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. | |||
|
|
|||
| This algorithm is designed to do an NMF factorization on a set of signals ignoring any uniform stretching of the signal | |||
There was a problem hiding this comment.
Actually this looks good here, can't we just use this in the readme?
| @@ -2,7 +2,7 @@ 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. | |||
|
|
|||
| This algorithm is designed to do an NMF factorization on a set of signals ignoring any uniform stretching of the signal | |||
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
Great we have a bot. @sbillinge |
doc/source/index.rst
Outdated
| @@ -2,7 +2,7 @@ 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. | |||
There was a problem hiding this comment.
I think we need a reference to the paper here?
Addressed: