Skip to content

SPEC 0: Set minimum supported versions to pandas>=1.5 and xarray>=2022.03 #3043

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
seisman merged 17 commits into from
Feb 18, 2024
Merged

SPEC 0: Set minimum supported versions to pandas>=1.5 and xarray>=2022.03 #3043

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
b762582
SPEC 0: Set minimum required version to pandas>=1.5 and xarray>=2022.…
seisman Feb 6, 2024
152b6a3
SPEC 0: Set minimum required version to pandas>=1.5 and xarray>=2022.…
seisman Feb 6, 2024
4561eb7
SPEC 0: Set minimum required version to pandas>=1.5 and xarray>=2022.…
seisman Feb 6, 2024
19a1957
Pin pandas and xarray versions in Tests workflow
seisman Feb 6, 2024
8f6aa13
Merge branch 'main' into spec0/pandas+xarray
seisman Feb 6, 2024
7341d05
List minimum supported pandas/xarray versions in doc/minversion.rst
seisman Feb 6, 2024
ca8981a
Apply suggestions from code review
seisman Feb 13, 2024
1d74314
Combine the PyGMT version and documentation columns
seisman Feb 15, 2024
d0e06a1
typo
seisman Feb 15, 2024
7fc2e61
Merge branch 'main' into spec0/pandas+xarray
seisman Feb 15, 2024
b15894c
fix
seisman Feb 15, 2024
462014e
Add a note about the dev version
seisman Feb 15, 2024
dc8d241
Simplify Documentation to Docs
seisman Feb 15, 2024
e759c71
typo
seisman Feb 17, 2024
5f22ecb
Separate columns for numpy/pandas/xarray
seisman Feb 17, 2024
52c8bc1
Centering the table
seisman Feb 17, 2024
33c8315
Fix the note
seisman Feb 17, 2024
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
13 changes: 9 additions & 4 deletions .github/workflows/ci_tests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,19 @@ jobs:
isDraft: true
- os: windows-latest
isDraft: true
# Pair Python 3.10 with NumPy 1.23 and Python 3.12 with NumPy 1.26
# Only install optional packages on Python 3.12/NumPy 1.26
# Pair Python 3.10 with the minimum supported versions of NumPy/Pandas/Xarray
# and Python 3.12 with the latest versions of NumPy/Pandas/Xarray
# Only install optional packages on Python 3.12
include:
- python-version: '3.10'
numpy-version: '1.23'
pandas-version: '1.5'
xarray-version: '2022.03'
optional-packages: ''
- python-version: '3.12'
numpy-version: '1.26'
pandas-version: '2.2'
xarray-version: '2024.01'
optional-packages: ' contextily geopandas ipython pyarrow rioxarray sphinx-gallery'

timeout-minutes: 30
Expand Down Expand Up @@ -107,8 +112,8 @@ jobs:
gmt=6.5.0
ghostscript=10.02.1
numpy=${{ matrix.numpy-version }}
pandas
xarray
pandas=${{ matrix.pandas-version }}
xarray=${{ matrix.xarray-version }}
netCDF4
packaging
build
Expand Down
26 changes: 14 additions & 12 deletions doc/minversions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,62 +15,64 @@ the rest of the Scientific Python ecosystem, and therefore:
- Documentation
- GMT
- Python
- NumPy
- Core package dependencies
Copy link
Member Author

@seisman seisman Feb 6, 2024

Choose a reason for hiding this comment

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

In #3037 (comment), @weiji14 proposed to add two more columns for pandas and xarray. I think this is not good, because the table is already too wide. I prefer to list the core dependencies in a single column. See https://pygmt-dev--3043.org.readthedocs.build/en/3043/minversions.html for preview.

I also prefer to combine the "Python version" and "Documentation" columns into a single column. The new table will look like:

image

Thoughts?

Copy link
Member

@weiji14 weiji14 Feb 11, 2024

Choose a reason for hiding this comment

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

I also prefer to combine the "Python version" and "Documentation" columns into a single column.

Yep, ok with this part. We can add a note at the bottom to say that 'Dev' reflects the main branch and is for the upcoming release.

In #3037 (comment), @weiji14 proposed to add two more columns for pandas and xarray. I think this is not good, because the table is already too wide. I prefer to list the core dependencies in a single column.

Once we combine the PyGMT and Docs columns, maybe there's enough space for separate numpy/pandas/xarray columns? Could you try splitting into individual columns to see how it looks?

Copy link
Member Author

@seisman seisman Feb 17, 2024

Choose a reason for hiding this comment

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

Done in 5f22ecb. Not bad. See preview at https://pygmt-dev--3043.org.readthedocs.build/en/3043/minversions.html.

* - `Dev <https://github.com/GenericMappingTools/pygmt/milestones>`_ (upcoming release)
- `Dev Documentation <https://www.pygmt.org/dev>`_ (reflects `main branch <https://github.com/GenericMappingTools/pygmt>`_)
- >=6.3.0
- >=3.10
- >=1.23
- - numpy>=1.23
- pandas>=1.5
- xarray>=2022.03
* - `v0.11.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.11.0>`_ (latest release)
- `v0.11.0 Documentation <https://www.pygmt.org/v0.11.0>`_
- >=6.3.0
- >=3.9
- >=1.23
- numpy>=1.23
* - `v0.10.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.10.0>`_
- `v0.10.0 Documentation <https://www.pygmt.org/v0.10.0>`_
- >=6.3.0
- >=3.9
- >=1.22
- numpy>=1.22
* - `v0.9.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.9.0>`_
- `v0.9.0 Documentation <https://www.pygmt.org/v0.9.0>`_
- >=6.3.0
- >=3.8
- >=1.21
- numpy>=1.21
* - `v0.8.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.8.0>`_
- `v0.8.0 Documentation <https://www.pygmt.org/v0.8.0>`_
- >=6.3.0
- >=3.8
- >=1.20
- numpy>=1.20
* - `v0.7.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.7.0>`_
- `v0.7.0 Documentation <https://www.pygmt.org/v0.7.0>`_
- >=6.3.0
- >=3.8
- >=1.20
- numpy>=1.20
* - `v0.6.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.6.1>`_
- `v0.6.1 Documentation <https://www.pygmt.org/v0.6.1>`_
- >=6.3.0
- >=3.8
- >=1.19
- numpy>=1.19
* - `v0.6.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.6.0>`_
- `v0.6.0 Documentation <https://www.pygmt.org/v0.6.0>`_
- >=6.3.0
- >=3.8
- >=1.19
- numpy>=1.19
* - `v0.5.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.5.0>`_
- `v0.5.0 Documentation <https://www.pygmt.org/v0.5.0>`_
- >=6.2.0
- >=3.7
- >=1.18
- numpy>=1.18
* - `v0.4.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.4.1>`_
- `v0.4.1 Documentation <https://www.pygmt.org/v0.4.1>`_
- >=6.2.0
- >=3.7
- >=1.17
- numpy>=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
- numpy>=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
4 changes: 2 additions & 2 deletions environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ dependencies:
# Required dependencies
- gmt=6.5.0
- numpy>=1.23
- pandas
- xarray
- pandas>=1.5
- xarray>=2022.03
- netCDF4
- packaging
# Optional dependencies
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ classifiers = [
]
dependencies = [
"numpy>=1.23",
"pandas",
"xarray",
"pandas>=1.5",
"xarray>=2022.03",
"netCDF4",
"packaging",
]
Expand Down
4 changes: 2 additions & 2 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Required packages
numpy>=1.23
pandas
xarray
pandas>=1.5
xarray>=2022.03
netCDF4
packaging