Skip to content

doc: Update readme for new changes #310

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

Merged
sbillinge merged 2 commits into from
Jul 25, 2026
Merged

doc: Update readme for new changes #310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03c16cb
update citation to arxiv, update billinge email, fix typo in getting …
cadenmyers13 Jul 24, 2026
81b3f31
news
cadenmyers13 Jul 24, 2026
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
17 changes: 9 additions & 8 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,13 @@ Citation

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


"diffpy.morph: Python tools for model independent comparisons between sets of 1D functions" by
Andrew Yang, Luis Kitsu Iglesias, Michael F. Toney, Samuel D. Marks, Joshua Safin, Vivian R. K. Wall,
Katherine Page, Naomi S. Ginsberg, Dillon Hanlon, Nicholas Leonard, Samuel W. Teitelbaum,
Timothy B. van Driel, Chia-Hao Liu, Soham Banerjee, Christopher L. Farrow, Pavol Juhas,
Emil S. Bozin, Simon J. L. Billinge, to be published.
Yang, A., Farrow, C. L., Juhás, P., Iglesias, L. K., Liu, C.-H.,
Marks, S. D., Wall, V. R. K., Safin, J., Drewry, S. M., Myers, C.,
Hanlon, D. F., Leonard, N., Petrovic, C., Jeong, A., Talapin, D. V.,
Nazar, L. F., Zhou, H., Teitelbaum, S. W., van Driel, T. B.,
Banerjee, S., Bozin, E. S., Toney, M. F., Page, K., Ginsberg, N. S.,
and Billinge, S. J. L. (2026). *diffpy.morph: Python tools for model
independent comparisons between sets of 1D functions*. arXiv:2602.06987.

Installation
------------
Expand Down Expand Up @@ -132,7 +133,7 @@ For detailed instructions and full tutorial, see our `website <www.diffpy.org/di
Once the required software, including ``diffpy.morph`` is all installed, open
up a terminal and check installation has worked properly by running ::

source activate diffpy.morph_env #if the environment isn't already active
conda activate diffpy.morph_env #if the environment isn't already active
diffpy.morph -h #get some helpful information
diffpy.morph --version

Expand Down Expand Up @@ -183,7 +184,7 @@ Before contributing, please read our `Code of Conduct <https://github.com/diffpy
Contact
-------

For more information on diffpy.morph please visit the project `web-page <https://diffpy.github.io/>`_ or email Simon J.L. Billinge group at sb2896@columbia.edu.
For more information on diffpy.morph please visit the project `web-page <https://diffpy.github.io/>`_ or email Simon J.L. Billinge group at sbillinge@ucsb.edu.

Acknowledgements
----------------
Expand Down
23 changes: 23 additions & 0 deletions news/fix-readme-typos.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* No news needed: updates to the readme

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
Loading