From b9f386d2b287d3180edd1a66a567c62ba22651a9 Mon Sep 17 00:00:00 2001 From: Adeolu Ajayi Date: Sun, 13 Aug 2023 09:26:08 -0500 Subject: [PATCH 1/2] initial commit --- README.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..d1340d7 --- /dev/null +++ b/README.rst @@ -0,0 +1,25 @@ +.. image::https://github.com/diffpy/diffpy.snmf/actions/workflows/main.yml/badge.svg)](https://github.com/diffpy/diffpy.snmf/actions/workflows/main.yml + :target: +[![codecov](https://codecov.io/gh/diffpy/diffpy.snmf/branch/main/graph/badge.svg)](https://codecov.io/gh/diffpy/diffpy.snmf) + +Diffpy.snmf +======================================================================================================================== + +LICENSE +------------------------------------------------------------------------------------------------------------------------ + +REQUIREMENTS +------------------------------------------------------------------------------------------------------------------------ + +INSTALLATION +------------------------------------------------------------------------------------------------------------------------ + +USING Snmf +------------------------------------------------------------------------------------------------------------------------ + +DEVELOPMENT +------------------------------------------------------------------------------------------------------------------------ + +CONTACTS +------------------------------------------------------------------------------------------------------------------------ + From f0198f6d627ca6da190091d23fac44ffcd51c85d Mon Sep 17 00:00:00 2001 From: Adeolu Ajayi Date: Mon, 14 Aug 2023 13:10:59 -0500 Subject: [PATCH 2/2] added "Requirements" to README.md --- README.md | 34 ++++++++++++++++++++++++++++++++++ README.rst | 25 ------------------------- 2 files changed, 34 insertions(+), 25 deletions(-) delete mode 100644 README.rst 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 diff --git a/README.rst b/README.rst deleted file mode 100644 index d1340d7..0000000 --- a/README.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. image::https://github.com/diffpy/diffpy.snmf/actions/workflows/main.yml/badge.svg)](https://github.com/diffpy/diffpy.snmf/actions/workflows/main.yml - :target: -[![codecov](https://codecov.io/gh/diffpy/diffpy.snmf/branch/main/graph/badge.svg)](https://codecov.io/gh/diffpy/diffpy.snmf) - -Diffpy.snmf -======================================================================================================================== - -LICENSE ------------------------------------------------------------------------------------------------------------------------- - -REQUIREMENTS ------------------------------------------------------------------------------------------------------------------------- - -INSTALLATION ------------------------------------------------------------------------------------------------------------------------- - -USING Snmf ------------------------------------------------------------------------------------------------------------------------- - -DEVELOPMENT ------------------------------------------------------------------------------------------------------------------------- - -CONTACTS ------------------------------------------------------------------------------------------------------------------------- -