Skip to content

Commit

Permalink
Document the support policy for optional packages (#3616)
Browse files Browse the repository at this point in the history
Co-authored-by: Wei Ji <[email protected]>
  • Loading branch information
seisman and weiji14 authored Nov 15, 2024
1 parent 7bf2c81 commit 09802b0
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 17 deletions.
15 changes: 4 additions & 11 deletions README.md
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
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.
- 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

0 comments on commit 09802b0

Please sign in to comment.