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.

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

change python version in README.rst #107

Merged
merged 5 commits into from
Sep 26, 2024
Merged

Conversation

stevenhua0320
Copy link
Contributor

change Python requirment version in README.rst, please merge that before releasing. Thanks!

@stevenhua0320 stevenhua0320 changed the title change python version in READNME.rst change python version in README.rst Sep 4, 2024
Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of this can just be deleted if the ookicuttering went to plan

README.rst Outdated
@@ -44,7 +44,7 @@ http://diffpy.github.io/diffpy.srmise.
Getting Started
=================

The diffpy.srmise package requires Python 2.6 or 2.7 and the following software:
The diffpy.srmise package requires Python 3.10, 3.11, or 3.12 and the following software:

* ``setuptools`` - software distribution tools for Python
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove these too. Please double check that the we are using the installation instructions from the cookie cutter and only keep things from the old readme that are needed.

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure we don't lose the description of the software, which should go where the LONG DESCRIPTION is written

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nicely done. One last thing, see inline

README.rst Outdated
When installing for MacPorts, make sure the MacPorts bin directory is the first
in the system PATH and that python27 is selected as the default Python version
in MacPorts::
diffpy.srmise Package, https://github.com/diffpy/diffpy.srmise
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one has a published paper to cite, so please replace (here and in the docs) this line with:
L. Granlund, Billinge, S. J. L., and P. M. Duxbury. “Algorithm for systematic peak extraction from atomic
pair distribution functions”. In: Acta Crystallogr. A 71.4 (2015), pp. 392–409. DOI:
10.1107/S2053273315005276.

@sbillinge sbillinge merged commit c856057 into diffpy:main Sep 26, 2024
3 checks passed
stevenhua0320 added a commit to stevenhua0320/diffpy.srmise that referenced this pull request Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants