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

Jump to bottom

readme.rst #47

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

readme.rst #47

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b9f386d
initial commit
aajayi-21 Aug 13, 2023
f0198f6
added "Requirements" to README.md
aajayi-21 Aug 14, 2023
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
34 changes: 34 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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 will make this open source, so let's give it a BSD-3 clause license.



## 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
25 changes: 0 additions & 25 deletions README.rst
View file
Open in desktop

This file was deleted.