doc: Move compatibility table from README to separate file #2862
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| Minimum Supported GMT/Python/NumPy Versions | ||
|
There was a problem hiding this comment. I'm debating if we should rename the file to There was a problem hiding this comment. I think I perfer |
||
| ------------------------------------------- | ||
|
|
||
| PyGMT has adopted `NEP29 <https://numpy.org/neps/nep-0029-deprecation_policy>`__ | ||
| alongside the rest of the Scientific Python ecosystem, and therefore supports: | ||
|
|
||
| * All minor versions of Python released 42 months prior to the project, and at minimum | ||
| the two latest minor versions. | ||
| * All minor versions of NumPy released in the 24 months prior to the project, and at | ||
| minimum the last three minor versions. | ||
|
|
||
| .. list-table:: | ||
| :widths: 25 30 15 20 15 | ||
| :header-rows: 1 | ||
|
|
||
| * - PyGMT Version | ||
| - Documentation | ||
| - GMT | ||
| - Python | ||
| - NumPy | ||
| * - `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.9 | ||
| - >=1.23 | ||
| * - `v0.10.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.10.0>`_ (latest release) | ||
| - `v0.10.0 Documentation <https://www.pygmt.org/v0.10.0>`_ | ||
| - >=6.3.0 | ||
| - >=3.9 | ||
| - >=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 | ||
| * - `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 | ||
| * - `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 | ||
| * - `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 | ||
| * - `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 | ||
| * - `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 | ||
| * - `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 | ||
| * - `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 | ||
| * - `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 | ||
| - >=3.7 | ||
| - | ||
| * - `v0.3.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.3.0>`_ | ||
| - `v0.3.0 Documentation <https://www.pygmt.org/v0.3.0>`_ | ||
| - >=6.1.1 | ||
| - >=3.7 | ||
| - | ||
| * - `v0.2.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.2.1>`_ | ||
| - `v0.2.1 Documentation <https://www.pygmt.org/v0.2.1>`_ | ||
| - >=6.1.1 | ||
| - >=3.6 | ||
| - | ||
| * - `v0.2.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.2.0>`_ | ||
| - `v0.2.0 Documentation <https://www.pygmt.org/v0.2.0>`_ | ||
| - >=6.1.1 | ||
| - 3.6 - 3.8 | ||
| - | ||
| * - `v0.1.2 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.2>`_ | ||
| - `v0.1.2 Documentation <https://www.pygmt.org/v0.1.2>`_ | ||
| - >=6.0.0 | ||
| - 3.6 - 3.8 | ||
| - | ||
| * - `v0.1.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.1>`_ | ||
| - `v0.1.1 Documentation <https://www.pygmt.org/v0.1.1>`_ | ||
| - >=6.0.0 | ||
| - 3.6 - 3.8 | ||
| - | ||
| * - `v0.1.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.0>`_ | ||
| - `v0.1.0 Documentation <https://www.pygmt.org/v0.1.0>`_ | ||
| - >=6.0.0 | ||
| - 3.6 - 3.8 | ||
| - | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -83,12 +83,16 @@ We recommend following the instructions further on to install GMT 6. | |
|
|
||
| PyGMT requires the following libraries to be installed: | ||
|
|
||
| - [numpy](https://numpy.org) | ||
|
There was a problem hiding this comment. After adopting SPEC 0 (#2863), we will also need to pin pandas and xarray. Removing the pinned version from the installation guides because most users don't care about them. For anyone who cares about the versions, we provide the link to the "compatibility table". |
||
| - [pandas](https://pandas.pydata.org) | ||
| - [xarray](https://xarray.dev/) | ||
| - [netCDF4](https://unidata.github.io/netcdf4-python) | ||
| - [packaging](https://packaging.pypa.io) | ||
|
|
||
| :::{note} | ||
| For the minimum supported versions of the dependencies, please see {doc}`compatibility`. | ||
| ::: | ||
|
|
||
| The following are optional dependencies: | ||
|
|
||
| - [IPython](https://ipython.org): For embedding the figures in Jupyter notebooks (recommended). | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section is not shown on the index page (https://pygmt-dev--2862.org.readthedocs.build/en/2862/index.html) but is shown in the README file.