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 all 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
8 changes: 7 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,13 @@

A python package implementing the stretched NMF algorithm.

* LONGER DESCRIPTION HERE
``diffpy.snmf`` implements the stretched non negative matrix factorization (sNMF) and sparse stretched NMF
(ssNMF) algorithms.

This algorithm is designed to do an NMF factorization on a set of signals ignoring any uniform stretching of the signal
on the independent variable axis. For example, for powder diffraction data taken from samples containing multiple
chemical phases where the measurements were done at different temperatures and the materials were undergoing thermal
expansion.

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

Expand Down
3 changes: 2 additions & 1 deletion doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ 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 described in the paper "Stretched Non-negative Matrix Factorization" by Ran Gu et al. (2023),
which is referenced under the Citation section below.

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
Loading