Skip to content

Commit

Permalink
NEP29: Set minimum required version to NumPy 1.18+ (#1430)
Browse files Browse the repository at this point in the history
Following NEP29 policy. Bumps minimum supported
NumPy version to 1.18 in the setup.py, requirements.txt
and environment.yml files. Also update installation
documentation and set CI tests to run on NumPy 1.18.

* List NumPy >= 1.18 in compatibility table on main README.rst
* Mention dev docs directly in compatibility table

Co-authored-by: Meghan Jones <[email protected]>
  • Loading branch information
weiji14 and maxrjones authored Aug 11, 2021
1 parent 975ab3b commit ebbb0cc
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 11 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci_tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ jobs:
# - os: ubuntu-latest
# python-version: 3.7
# isDraft: true
# Pair Python 3.7 with NumPy 1.17 and Python 3.9 with NumPy 1.21
# Pair Python 3.7 with NumPy 1.18 and Python 3.9 with NumPy 1.21
# Only install optional packages on Python 3.9/NumPy 1.21
include:
- python-version: 3.7
numpy-version: '1.17'
numpy-version: '1.18'
optional-packages: ''
- python-version: 3.9
numpy-version: '1.21'
Expand Down
12 changes: 7 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -228,16 +228,21 @@ Compatibility with GMT/Python/NumPy versions
- GMT
- Python
- Numpy
* - `v0.5.0 <https://github.com/GenericMappingTools/pygmt/milestone/8>`_ (upcoming release)
- `Dev Documentation <https://www.pygmt.org/dev>`_ (reflects `main branch <https://github.com/GenericMappingTools/pygmt>`_)
- >=6.2.0
- >=3.7
- >=1.18
* - `v0.4.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.4.1>`_ (latest release)
- `v0.4.1 Documentation <https://www.pygmt.org/v0.4.1>`_
- >=6.2.0
- >=3.7
- >=1.17.0
- >=1.17
* - `v0.4.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.4.0>`_
- `v0.4.0 Documentation <https://www.pygmt.org/v0.4.0>`_
- >=6.2.0
- >=3.7
- >=1.17.0
- >=1.17
* - `v0.3.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.3.1>`_
- `v0.3.1 Documentation <https://www.pygmt.org/v0.3.1>`_
- >=6.1.1
Expand Down Expand Up @@ -273,6 +278,3 @@ Compatibility with GMT/Python/NumPy versions
- >=6.0.0
- 3.6 - 3.8
-

The unstable development documentation, which reflects the `main branch <https://github.com/GenericMappingTools/pygmt>`_
on GitHub, can be found at https://www.pygmt.org/dev/.
2 changes: 1 addition & 1 deletion doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Dependencies

PyGMT requires the following libraries to be installed:

* `numpy <https://numpy.org>`__ (>= 1.17)
* `numpy <https://numpy.org>`__ (>= 1.18)
* `pandas <https://pandas.pydata.org>`__
* `xarray <https://xarray.pydata.org>`__
* `netCDF4 <https://unidata.github.io/netcdf4-python>`__
Expand Down
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ dependencies:
# Required dependencies
- pip
- gmt=6.2.0
- numpy>=1.17
- numpy>=1.18
- pandas
- xarray
- netCDF4
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Required packages
numpy>=1.17
numpy>=1.18
pandas
xarray
netCDF4
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
]
PLATFORMS = "Any"
PYTHON_REQUIRES = ">=3.7"
INSTALL_REQUIRES = ["numpy>=1.17", "pandas", "xarray", "netCDF4", "packaging"]
INSTALL_REQUIRES = ["numpy>=1.18", "pandas", "xarray", "netCDF4", "packaging"]
# Configuration for setuptools-scm
SETUP_REQUIRES = ["setuptools_scm"]
USE_SCM_VERSION = {"local_scheme": "node-and-date", "fallback_version": "unknown"}
Expand Down

0 comments on commit ebbb0cc

Please sign in to comment.