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.

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

Jump to bottom

Document the support policy for optional packages #3616

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+21 −17
Open

Document the support policy for optional packages #3616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0a95f37
Document the support policy for optional packages
seisman Nov 13, 2024
7549e35
Also simplify the policy in README to avoid duplication
seisman Nov 13, 2024
31f74a1
Update doc/minversions.md
seisman Nov 13, 2024
2c7a5a9
Rewording
seisman Nov 13, 2024
d0cbc7e
Add a note about the policy
seisman Nov 14, 2024
dcf4176
Apply suggestions from code review
seisman Nov 14, 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
15 changes: 4 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,14 +191,7 @@ Other official wrappers for GMT:
## Minimum supported versions

PyGMT has adopted [SPEC 0](https://scientific-python.org/specs/spec-0000/) alongside the
rest of the scientific Python ecosystem, and therefore:

- Support for Python versions be dropped 3 years after their initial release.
- Support for core package dependencies (NumPy, pandas, Xarray) be dropped 2 years after
their initial release.

Similarly, the PyGMT team has decided to discontinue support for GMT versions 3 years
after their initial release.

Please see [Minimum Supported Versions](https://www.pygmt.org/dev/minversions.html) for
the minimum supported versions of GMT, Python and core package dependencies.
rest of the scientific Python ecosystem, and made a few extensions based on the needs of
the project. Please see [Minimum Supported Versions](https://www.pygmt.org/dev/minversions.html)
for the detailed policy and the minimum supported versions of GMT, Python and core
package dependencies.
23 changes: 17 additions & 6 deletions doc/minversions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,25 @@ myst:
# Minimum Supported Versions

PyGMT has adopted [SPEC 0](https://scientific-python.org/specs/spec-0000/) alongside the
rest of the scientific Python ecosystem, and therefore:
rest of the scientific Python ecosystem, and will therefore:

- Support for Python versions be dropped 3 years after their initial release.
- Support for core package dependencies (NumPy, pandas, Xarray) be dropped 2 years after
their initial release.
- Drop support for Python versions 3 years after their initial release.
- Drop support for core package dependencies (NumPy, pandas, Xarray) 2 years after their
initial release.

Similarly, the PyGMT team has decided to discontinue support for GMT versions 3 years
after their initial release.
In addition to the above, the PyGMT team has also decided to:

- Drop support for GMT versions 3 years after their initial release, while ensuring at
least two latest minor versions remain supported.
Comment on lines +29 to +30
Copy link
Member Author

Choose a reason for hiding this comment

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

ensuring at least two latest minor versions remain supported.

I've added this sentence to the GMT support policy.

- Maintain support for [optional dependencies](/ecosystem.md#pygmt-dependencies) for at
least 1 year after their initial release. Users are encouraged to use the most
up-to-date optional dependencies where possible.

:::{note}
The SPEC 0 policy is enforced on a best-effort basis, and the PyGMT team may decide to
drop support for core (and optional) package dependencies earlier than recommended for
compatibility reasons.
:::

| PyGMT Version | GMT | Python | NumPy | pandas | Xarray |
|---|---|---|---|---|---|
Expand Down