diff --git a/README.md b/README.md index 86614d5..8ea5af8 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,37 @@ [![test](https://github.com/diffpy/diffpy.snmf/actions/workflows/main.yml/badge.svg)](https://github.com/diffpy/diffpy.snmf/actions/workflows/main.yml) [![codecov](https://codecov.io/gh/diffpy/diffpy.snmf/branch/main/graph/badge.svg)](https://codecov.io/gh/diffpy/diffpy.snmf) + + +_Snmf_ + + +## LICENSE + +This software is subject to license and copyright restrictions listed here. + + +## REQUIREMENTS + +Snmf is currently run from the command line, which requires opening and typing into a terminal window or a Windows +command prompt. It is recommended that you consult online resources and become somewhat familiar before using Snmf. + +SNMF can be run with Python 3.9 or higher. It makes use of several third party libraries that you'll need to run the app +and its components. +- NumPy - library for scientific computing with Python +- matplotlib - Python 2d plotting library +- SciPy - library for highly technical Python computing +- diffpy.utils - shard helper utilities for wx GUI +- numdifftools - library for numerical differentiation +- CVXPY - library for convex optimization + +These dependencies will be installed automatically if you use the conda installation procedure described below. + +## INSTALLATION +We + +## USING Snmf + +## DEVELOPMENT + +## Contacts \ No newline at end of file