Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add longer description in README.rst and remove redundant info in index.rst #70

Merged
merged 5 commits into from
Aug 13, 2024
Merged

Add longer description in README.rst and remove redundant info in index.rst #70

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
daf401d
Clean up index.rst with redundant info
bobleesj Aug 12, 2024
1e5050d
Add package description in README.rst
bobleesj Aug 12, 2024
50bf2fd
Fix typo from diff.pysnmf to diffpy.snmf
bobleesj Aug 12, 2024
4bc33e7
Update REAMDE longer description
bobleesj Aug 12, 2024
5446afd
Make a clear ref to the paper in readme
bobleesj Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

through applying the stretched nonnegative matrix factorization (sNMF) and spare stretched nonnegative matrix factorization
algorithms (ssNMF). The package seeks to answer the question: "What are the structural signals composing my measured signal at
each moment in time?"

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

Expand Down
4 changes: 2 additions & 2 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need a reference to the paper here?


This algorithm is designed to do an NMF factorization on a set of signals ignoring any uniform stretching of the signal
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually this looks good here, can't we just use this in the readme?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, pasted.

on the independent variable axis. For example, for powder diffraction data taken from samples containing multiple
Expand Down Expand Up @@ -54,7 +54,7 @@ by citing the following paper in your publication:
Authors
-------

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