diffpy.stretched-nmf 0.3.0

Citation

If you use diffpy.stretched-nmf in a scientific publication, we would like you to cite this package as

Ran Gu, Yevgeny Rakita, Ling Lan, Zach Thatcher, Gabrielle E. Kamm, Daniel O’Nolan, Brennan McBride, Allison Wustrow, James R. Neilson, Karena W. Chapman, Qiang Du, and Simon J. L. Billinge, Stretched Non-negative Matrix Factorization, npj Comput Mater 10, 193 (2024).

Installation

The preferred method is conda:

conda config --add channels conda-forge
conda create -n diffpy.stretched-nmf_env diffpy.stretched-nmf
conda activate diffpy.stretched-nmf_env

For interactive plotting with show_plots=True, use a GUI-capable desktop environment. Conda installs use matplotlib-base, which is sufficient for plotting but still depends on an available interactive Matplotlib backend.

Alternatively, install from PyPI with pip:

pip install diffpy.stretched-nmf

For source installs (after cloning the repo):

pip install .

Quick check:

snmf --version
python -c "import diffpy.stretched_nmf; print(diffpy.stretched_nmf.__version__)"

To view the basic usage and available commands, type

snmf -h

Getting Started

You may consult our online documentation for tutorials and API references.

Support and Contribute

If you see a bug or want to request a feature, please report it as an issue and/or submit a fix as a PR.

Feel free to fork the project and contribute. To install diffpy.stretched-nmf in a development mode, with its sources being directly used by Python rather than copied to a package directory, use the following in the root directory

pip install -e .

To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit hooks.

1. Install pre-commit in your working environment by running conda install pre-commit.

2. Initialize pre-commit (one time only) pre-commit install.

Thereafter your code will be linted by black and isort and checked against flake8 before you can commit. If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should pass after they are modified). If the flake8 test fails please see the error messages and fix them manually before trying to commit again.

Improvements and fixes are always appreciated.

Before contributing, please read our Code of Conduct.

Contact

For more information on diffpy.stretched-nmf please visit the project web-page or email Simon Billinge at sbillinge@ucsb.edu.

Acknowledgements

diffpy.stretched-nmf is built and maintained with scikit-package.