Skip to content

Commit 2398451

Browse files
committed
Fix package versions and update doc, fix test dir
1 parent e66f884 commit 2398451

File tree

6 files changed

+25
-18
lines changed

6 files changed

+25
-18
lines changed

README.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -44,32 +44,32 @@ The BibTeX entry for the paper is:
4444
Installation
4545
------------
4646

47-
The program is a Python program. Thus, a working Python distribution is required for running it. It is designed
48-
to run under Python 2.7 and Python 3. Beside the Python interpreter it requires the following
47+
The program is a Python program. Thus, a working Python 3.X distribution is required for running it (support for Python
48+
2.X has been dropped since version 1.1.8). Beside the Python interpreter it requires the following
4949
packages:
5050

5151
* numpy (see `<www.numpy.org>`_)
5252
* scipy (see `<www.scipy.org>`_)
5353
* h5py (see `<www.hypy.org>`_)
5454
* pyFFTW is optional; speeds up the averaging (see `<https://pypi.python.org/pypi/pyFFTW>`_)
5555

56-
The package is tested with Python versions 2.7 and 3.5, numpy version 1.11.0, scipy version 0.18.0, h5py version 2.6.0
57-
and version PyFFTW 0.10.4.
56+
The package is tested with following Python versions:
57+
* Python 3.6, numpy 1.11, scipy 0.19, h5py 2.7, PyFFTW 0.10
58+
* Python 3.8, numpy 1.23, scipy 1.9, h5py 3.7, PyFFTW 0.13
5859

59-
The package can be most conveniently installed using the ``pip`` package manager. Make sure you have Python installed (either 2.X
60-
or 3.X) and the ``pip3`` program (``pip2`` for Python 2.X) is in your path. Go to the command line and execute (if you use Python 2.7 use ``pip2``
61-
instead of ``pip3``).
60+
The package can be most conveniently installed using the ``pip`` package manager. Make sure you have Python installed
61+
and the Python interpreter is in your path. Go to the command line and execute:
6262

6363
.. code-block:: none
6464
65-
pip3 install --upgrade holoaverage
65+
python3 -m pip install --upgrade holoaverage
6666
6767
Holoaverage leverages the pyFFTW package for speed. If pyfftw can not be installed you can still use holoaverage
68-
without problems. You can install pyFFTW by (with Python 2.7 again use ``pip2`` instead of ``pip3``)
68+
without problems. You can install pyFFTW by
6969

7070
.. code-block:: none
7171
72-
pip3 install --upgrade pyfftw
72+
python3 -m pip install --upgrade pyfftw
7373
7474
Up to date source versions can be found on the GitHub site: https://github.com/niermann/holoaverage
7575

@@ -88,7 +88,7 @@ License
8888
.. code-block:: none
8989
9090
Holoaverage, program for reconstruction and averaging of electron holograms
91-
Copyright (C) 2018 Tore Niermann
91+
Copyright (C) 2018-2022 Tore Niermann
9292
9393
This program is free software: you can redistribute it and/or modify
9494
it under the terms of the GNU General Public License as published by

docs/changelog.rst

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Changelog
66
Version 1.1.8
77
-------------
88

9+
* Dropped Python 2.X support
910
* Fix deprecated functions
1011

1112
Version 1.1.7

setup.py

-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@
3838
'Operating System :: OS Independent',
3939
'Programming Language :: Python',
4040
'Programming Language :: Python :: 3',
41-
'Programming Language :: Python :: 3.6',
4241
'Topic :: Scientific/Engineering :: Chemistry',
4342
'Topic :: Scientific/Engineering :: Physics',
4443
],

tests/test_example.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
import numpy as np
66

77
import warnings
8-
warnings.filterwarnings("error",category=DeprecationWarning)
9-
warnings.filterwarnings("error",category=PendingDeprecationWarning)
8+
warnings.filterwarnings("error", category=DeprecationWarning)
9+
warnings.filterwarnings("error", category=PendingDeprecationWarning)
1010

1111
from holoaverage.main import holoaverage, rescale_fourier
1212

tests/test_more.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
import numpy as np
66

77
import warnings
8-
warnings.filterwarnings("error",category=DeprecationWarning)
9-
warnings.filterwarnings("error",category=PendingDeprecationWarning)
8+
warnings.filterwarnings("error", category=DeprecationWarning)
9+
warnings.filterwarnings("error", category=PendingDeprecationWarning)
1010

1111
from holoaverage.main import holoaverage
1212

tox.ini

+9-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,14 @@ deps =
77
py36: numpy==1.13
88
py36: scipy==0.19
99
py36: h5py==2.7
10-
pyfftw>=0.10.4
10+
py36: pyfftw==0.10
11+
py38: numpy==1.23
12+
py38: scipy==1.9
13+
py38: h5py==3.7
14+
py38: pyfftw==0.13
1115

1216
commands =
13-
python3 -m pytest tests
17+
python3 -m pytest
18+
19+
[tool:pytest]
20+
testpaths = tests

0 commit comments

Comments
 (0)