Skip to content

Commit a0d4c2c

Browse files
committed
chore: Add instructions back to README.rst and revert history of CHANGELOG.rst
1 parent d6fc863 commit a0d4c2c

File tree

2 files changed

+84
-9
lines changed

2 files changed

+84
-9
lines changed

CHANGELOG.rst

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,71 @@ Release notes
33
=============
44

55
.. current developments
6+
7+
1.5.1
8+
=====
9+
10+
**Fixed:**
11+
12+
* Fixed `SystemError` and `MemoryError` for `redirect_stdout` on Windows with Python 3.13.
13+
14+
**Removed:**
15+
16+
* Removed `restore_stdout` function and wrapper.
17+
18+
19+
1.5.0
20+
=====
21+
22+
**Added:**
23+
24+
* Python 3.11, 3.12 support
25+
* Option to skip printing of introductory information when initializing the `PdfFit` class.
26+
* Added additional runtime linker flags in `CustomBuildExt.run` to embed the `RPATH` flags for the built extensions.
27+
* Support for retrieving GSL configuration from `CONDA_PREFIX`/ `GSL_PATH` on all platforms.
28+
* Separate installation instruction for macOS (Arm64) in READEM
29+
* Added `restore_stdout` function and wrapper.
30+
* Added Python 3.13 support.
31+
32+
**Changed:**
33+
34+
* Changed setup.py to lazy evaluate gsl installation.
35+
* Documentation brought up to date
36+
* Merged the GSL configuration logic in `setup.py`.
37+
* Changed `pytest` `capture_output` fixture. Now automatically restores `sys.stdout`.
38+
39+
**Fixed:**
40+
41+
* remove older conda-recipe files
42+
* moved the tests directory from src to the root using conftest.py.
43+
* fixed a circular import bug during " pip install ." in GitHub CI.
44+
* renamed .py files under tests to snake_case.
45+
* add PyPI packages under pip.txt
46+
* re-cookiecutter to group's package standard
47+
* Fix missing `__date__`, use PyPI release date.
48+
* Fixed `SystemError` when running `pytest` on Windows with Python 3.13.
49+
50+
**Removed:**
51+
52+
* Python <= 3.10 support
53+
* Six dependency and py2 support
54+
55+
56+
1.4.2
57+
=====
58+
59+
**Added:**
60+
61+
* Support for Python 3.11, 3.12
62+
63+
**Changed:**
64+
65+
* No notable functional changes from 1.4.1
66+
67+
1.4.4rc0
68+
========
69+
70+
**Fixed:**
71+
72+
* Code linted to group flake8 standards
73+
* Package structure moved to diffpy standard structure

README.rst

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ If you use diffpy.pdffit2 in a scientific publication, we would like you to cite
7979
Installation
8080
------------
8181

82+
diffpy.pdffit2 supports Python 3.11, 3.12, and 3.13.
83+
84+
Windows, macOS (non-Arm64), Linux
85+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
86+
8287
The preferred method is to use `Miniconda Python
8388
<https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
8489
and install from the "conda-forge" channel of Conda packages.
@@ -93,7 +98,16 @@ The following creates and activates a new environment named ``diffpy.pdffit2_env
9398
conda create -n diffpy.pdffit2_env diffpy.pdffit2
9499
conda activate diffpy.pdffit2_env
95100

96-
The output should print the latest version displayed on the badges above.
101+
To confirm that the installation was successful, type ::
102+
103+
python -c "import diffpy.pdffit2; print(diffpy.pdffit2.__version__)"
104+
105+
macOS (Arm64)
106+
~~~~~~~~~~~~~
107+
108+
Create a new conda environment ``diffpy.pdffit2_env``: ::
109+
110+
conda create -n diffpy.pdffit2_env python=3.13
97111

98112
If the above does not work, you can use ``pip`` to download and install the latest release from
99113
`Python Package Index <https://pypi.python.org>`_.
@@ -107,19 +121,12 @@ and run the following ::
107121

108122
pip install .
109123

110-
This package also provides command-line utilities. To check the software has been installed correctly, type ::
111-
112-
diffpy.pdffit2 --version
113124

114-
You can also type the following command to verify the installation. ::
125+
You can type the following command to verify the installation is successful. ::
115126

116127
python -c "import diffpy.pdffit2; print(diffpy.pdffit2.__version__)"
117128

118129

119-
To view the basic usage and available commands, type ::
120-
121-
diffpy.pdffit2 -h
122-
123130
Getting Started
124131
---------------
125132

0 commit comments

Comments
 (0)