Skip to content

Commit c2ff63e

Browse files
authored
chore: clean README (#279)
* fix: bring README up to current standards and add the manuscript * news
1 parent 811c86a commit c2ff63e

File tree

2 files changed

+30
-21
lines changed

2 files changed

+30
-21
lines changed

README.rst

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@
3838
Python package for manipulating and comparing diffraction data
3939

4040
``diffpy.morph`` is a Python software package designed to increase the insight
41-
researchers can obtain from measured diffraction data
41+
researchers can obtain from measured data including diffraction data
4242
and atomic pair distribution functions
43-
(PDFs) in a model-independent way. The program was designed to help a
43+
(PDFs) in a model-independent way. For example, the program was designed to help a
4444
researcher answer the question: "Has my material undergone a phase
4545
transition between these two measurements?"
4646

@@ -73,26 +73,12 @@ Citation
7373

7474
If you use diffpy.morph in a scientific publication, we would like you to cite this package as
7575

76-
diffpy.morph Package, https://github.com/diffpy/diffpy.morph
7776

78-
REQUIREMENTS
79-
------------------------------------------------------------------------
80-
81-
``diffpy.morph`` is currently run from the command line, which requires opening
82-
and typing into a terminal window or Windows command prompt. It is
83-
recommended that you consult online resources and become somewhat
84-
familiar before using ``diffpy.morph``.
85-
86-
``diffpy.morph`` can be run with Python 3.11 or higher. It makes use of several third party
87-
libraries that you'll need to run the app and its components.
88-
89-
* `NumPy` - library for scientific computing with Python
90-
* `matplotlib` - Python 2D plotting library
91-
* `SciPy` - library for highly technical Python computing
92-
* `diffpy.utils` - `shared helper utilities <https://github.com/diffpy/diffpy.utils/>`_ for wx GUI
93-
94-
These dependencies will be installed automatically if you use the conda
95-
installation procedure described below.
77+
"diffpy.morph: Python tools for model independent comparisons between sets of 1D functions" by
78+
Andrew Yang, Luis Kitsu Iglesias, Michael F. Toney, Samuel D. Marks, Joshua Safin, Vivian R. K. Wall,
79+
Katherine Page, Naomi S. Ginsberg, Dillon Hanlon, Nicholas Leonard, Samuel W. Teitelbaum,
80+
Timothy B. van Driel, Chia-Hao Liu, Soham Banerjee, Christopher L. Farrow, Pavol Juhas,
81+
Emil S. Bozin, Simon J. L. Billinge, to be published.
9682

9783
Installation
9884
------------

news/readme.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* No news added: simple doc clean
4+
5+
**Changed:**
6+
7+
* <news item>
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* <news item>
16+
17+
**Fixed:**
18+
19+
* <news item>
20+
21+
**Security:**
22+
23+
* <news item>

0 commit comments

Comments
 (0)