Set minimum supported version to GMT>=6.4.0 #3450

seisman · 2024-09-24T07:41:13Z

Description of proposed changes

In commit 539f3e8, I removed the codes for compatibility with GMT 6.3.0. After that, I manually triggered the "GMT Legacy Tests" workflow at https://github.com/GenericMappingTools/pygmt/actions/runs/11010826577. The CI job for GMT 6.3 no longer works because API_BIN_VERSION was added in GMT 6.4.0.

Error: ession [ERROR]: Unrecognized keyword API_BIN_VERSION
Traceback (most recent call last):
  File "<string>", line 1, in <module>
  File "/home/runner/work/pygmt/pygmt/pygmt/_show_versions.py", line [13](https://github.com/GenericMappingTools/pygmt/actions/runs/11010826577/job/30573600010#step:6:14)7, in show_versions
    lines.extend([f"  {key}: {val}" for key, val in _get_clib_info().items()])
  File "/home/runner/work/pygmt/pygmt/pygmt/_show_versions.py", line 29, in _get_clib_info
    return ses.info
  File "/home/runner/work/pygmt/pygmt/pygmt/clib/session.py", line 202, in info
    self._info["binary version"] = self.get_default("API_BIN_VERSION")
  File "/home/runner/work/pygmt/pygmt/pygmt/clib/session.py", line 500, in get_default
    raise GMTCLibError(msg)
pygmt.exceptions.GMTCLibError: Error getting value for 'API_BIN_VERSION' (error code 68).
make: *** [Makefile:35: _runtest] Error 1

The initial plan is to drop GMT 6.3 support in PyGMT v0.14.0, so we should remove any GMT 6.3 compatibility codes and GMT 6.3 from the CI matrix.

Then, the question is, do we want to revert changes in pygmt/clib/session.py so that most PyGMT functionality still works with GMT 6.3? In this case, GMT 6.3 is still allowed for future PyGMT versions, but there is no guarantee that all PyGMT functionalities work as expected. [Edit: Partially reverted in b0e6c69].

In b0e6c69, I updated pygmt/clib/session.py so that PyGMT works for GMT 6.3-6.5 (also have to temporarily revert test_grdfill.py in c6860b2 because it's known to crash with GMT 6.3). In the CI runs at https://github.com/GenericMappingTools/pygmt/actions/runs/11013102550, most tests still pass, except a few that are expected to fail.

In 33c1061, I removed GMT 6.3 for the testing CI matrix so GMT 6.3 is no longer tested, although PyGMT is still compatible with it. Then the question is whether we want to drop GMT 6.3 support completely. I think we have three options:

Bump required_gmt_version from 6.3.0 to 6.4.0, which means that people who use GMT 6.3 will see the GMTVersionError exception
Keep required_gmt_version="6.3.0" and add a note like "PyGMT requires GMT>=6.3.0 but only GMT 6.4-6.5 are fully tested" on the installation page.
Have two variables like required_gmt_version="6.4.0" and minimum_required_version="6.3.0", and raise the GMTVersionError for GMT<6.3.0 and raise an warning like "GMT 6.3.0 is not fully tested." for GMT=6.3.0.

Thoughts?

This reverts commit c6860b2.

seisman · 2024-09-26T06:07:27Z

3. Have two variables like required_gmt_version="6.4.0" and minimum_required_version="6.3.0", and raise the GMTVersionError for GMT<6.3.0 and raise an warning like "GMT 6.3.0 is not fully tested." for GMT=6.3.0.

I'm inclined to option 3. What do you think @GenericMappingTools/pygmt-maintainers?

weiji14 · 2024-09-29T04:38:14Z

Have two variables like required_gmt_version="6.4.0" and minimum_required_version="6.3.0", and raise the GMTVersionError for GMT<6.3.0 and raise an warning like "GMT 6.3.0 is not fully tested." for GMT=6.3.0.

I'm inclined to option 3. What do you think @GenericMappingTools/pygmt-maintainers?

Ok with this in principle, but I'm thinking of the variable names. How about:

minimum_required_gmt_version="6.3.0" or minimum_supported_gmt_version="6.3.0"?
recommended_gmt_version="6.4.0"?

References:

https://en.wikipedia.org/wiki/System_requirements#Recommended_system_requirements
Rust has a concept called Minimum Supported Rust Version (MSRV) for libraries/crates

Slightly off-topic, but I suppose we'll also set a requirement for gmt >=6.4.0,<7.0 on PyGMT's conda-forge package here at https://github.com/conda-forge/pygmt-feedstock/blob/e34ae5af8fced8600a9c05f5298c7e224e251530/recipe/meta.yaml#L25 for the PyGMT v0.14.0 release? So users would really need to install GMT 6.3.0 manually (not through conda) to get it to work with PyGMT v0.14.0?

seisman · 2024-09-29T05:01:44Z

minimum_required_gmt_version="6.3.0" or minimum_supported_gmt_version="6.3.0"?

I prefer to minimum_required_gmt_version since GMT 6.3.0 is no longer officially supported.

recommended_gmt_version="6.4.0"?

It reads like we recommend 6.4.0 and don't recommend 6.5.0. What about minimum_recommended_gmt_version?

Slightly off-topic, but I suppose we'll also set a requirement for gmt >=6.4.0,<7.0 on PyGMT's conda-forge package here at https://github.com/conda-forge/pygmt-feedstock/blob/e34ae5af8fced8600a9c05f5298c7e224e251530/recipe/meta.yaml#L25 for the PyGMT v0.14.0 release? So users would really need to install GMT 6.3.0 manually (not through conda) to get it to work with PyGMT v0.14.0?

Yes, I agree.

seisman · 2024-09-29T12:44:44Z

I think we have three options:

Bump required_gmt_version from 6.3.0 to 6.4.0, which means that people who use GMT 6.3 will see the GMTVersionError exception

Keep required_gmt_version="6.3.0" and add a note like "PyGMT requires GMT>=6.3.0 but only GMT 6.4-6.5 are fully tested" on the installation page.

Have two variables like required_gmt_version="6.4.0" and minimum_required_version="6.3.0", and raise the GMTVersionError for GMT<6.3.0 and raise an warning like "GMT 6.3.0 is not fully tested." for GMT=6.3.0.

After thinking twice, maybe we should go for option 1 for now to reduce our maintenance burden and revisit option 3 when we release PyGMT v1.0.

weiji14

In doc/install.md, change this line:

pygmt/doc/install.md

Line 311 in f8db417

- Ghostscript 9.53-9.56 for GMT 6.3.0/6.4.0

to "- Ghostscript 9.53-9.56 for GMT 6.4.0 (or below)"

weiji14 · 2024-10-01T01:01:58Z

pygmt/clib/session.py

@@ -198,16 +197,9 @@ def info(self):
                "library path": self.get_default("API_LIBRARY"),
                "cores": self.get_default("API_CORES"),
                "grid layout": self.get_default("API_GRID_LAYOUT"),
+                "image layout": self.get_default("API_IMAGE_LAYOUT"),


I'm getting a blank value with this as mentioned at #3468 (comment). Are you getting any output?

import pygmt with pygmt.clib.Session() as lib: print(lib.info["image layout"]) # API_IMAGE_LAYOUT

output from lib.info dict:

{'version': '6.5.0', 'padding': '2', 'share dir': '~/mambaforge/envs/pygmt/share/gmt', 'plugin dir': '~/mambaforge/envs/pygmt/lib/gmt/plugins', 'library path': '~/mambaforge/envs/pygmt/lib/libgmt.so', 'cores': '16', 'grid layout': 'rows', 'image layout': '', 'binary version': '6.5.0'}

weiji14

Thanks @seisman! There are some comments on this PR, but are more just questions that can be addressed separately.

weiji14 · 2024-10-02T03:00:58Z

pygmt/tests/test_datasets_load_remote_datasets.py

    # Can't access the cpt attribute using virtual files
-    # if Version(__gmt_version__) >= Version("6.4.0"):
-    #    assert data.attrs["cpt"] == "@earth_age.cpt"
+    # assert data.attrs["cpt"] == "@earth_age.cpt"


Is this something that could be obtained from the GMT_GRID struct somehow?

No, the cpt information is stored in the private, hidden structure GMT_GRID_HEADER_HIDDEN:

https://github.com/GenericMappingTools/gmt/blob/426abad288ef4b87c2cecf4c9633fd849866e45d/src/gmt_hidden.h#L163

We can't access it unless we decide to wrap the non-public GMT structure.

Drop support for GMT 6.3

539f3e8

seisman force-pushed the spec0/gmt branch from 652144a to 539f3e8 Compare September 24, 2024 09:19

seisman added 5 commits September 24, 2024 18:15

Minor fix docstring of Figure.timestamp

bd390ee

Add the GMT 6.3 compatibility codes back to pygmt/clib/session.py

b0e6c69

Temporarily revert the changes in test_grdfill.py

c6860b2

Revert "Temporarily revert the changes in test_grdfill.py"

66e5c76

This reverts commit c6860b2.

Remove the GMT 6.3 CI matrix from the 'GMT Legacy Tests' workflow

33c1061

seisman added the needs review This PR has higher priority and needs review. label Sep 25, 2024

seisman requested a review from a team September 25, 2024 00:10

seisman added this to the 0.14.0 milestone Sep 25, 2024

seisman added the deprecation Deprecating a feature label Sep 25, 2024

seisman added 2 commits September 26, 2024 14:04

Improve the comments in pygmt/clib/session.py

23a7a78

Merge branch 'main' into spec0/gmt

de347be

seisman added 2 commits September 27, 2024 08:23

Merge branch 'main' into spec0/gmt

d278ee8

Merge branch 'main' into spec0/gmt

53dabfc

seisman added 5 commits September 30, 2024 13:28

Merge branch 'main' into spec0/gmt

c0ab12f

Bump minimum required version to GMT>=6.4.0

71a0b36

Refactor the Session.info method since we now requires GMT>=6.4.0

4abf4f5

Update one comment about GMT 6.3

9a2983a

Remove the sentence from doc/contributing.md

770b011

seisman changed the title ~~WIP: Drop support for GMT 6.3~~ Set minimum supported version to GMT>=6.4.0 Sep 30, 2024

Merge branch 'main' into spec0/gmt

a8cfd25

weiji14 mentioned this pull request Oct 1, 2024

WIP: Implement virtualfile_from_image #3468

Draft

10 tasks

weiji14 reviewed Oct 1, 2024

View reviewed changes

seisman added 2 commits October 1, 2024 09:06

Fix the description about gs

5ab519c

Merge branch 'main' into spec0/gmt

530013f

weiji14 approved these changes Oct 2, 2024

View reviewed changes

seisman removed the needs review This PR has higher priority and needs review. label Oct 2, 2024

seisman merged commit 2d1a8cc into main Oct 2, 2024
21 checks passed

seisman deleted the spec0/gmt branch October 2, 2024 03:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set minimum supported version to GMT>=6.4.0 #3450

Set minimum supported version to GMT>=6.4.0 #3450

seisman commented Sep 24, 2024 •

edited

Loading

seisman commented Sep 26, 2024

weiji14 commented Sep 29, 2024

seisman commented Sep 29, 2024

seisman commented Sep 29, 2024

weiji14 left a comment

weiji14 Oct 1, 2024

weiji14 left a comment

weiji14 Oct 2, 2024

seisman Oct 2, 2024

Set minimum supported version to GMT>=6.4.0 #3450

Set minimum supported version to GMT>=6.4.0 #3450

Conversation

seisman commented Sep 24, 2024 • edited Loading

seisman commented Sep 26, 2024

weiji14 commented Sep 29, 2024

seisman commented Sep 29, 2024

seisman commented Sep 29, 2024

weiji14 left a comment

Choose a reason for hiding this comment

weiji14 Oct 1, 2024

Choose a reason for hiding this comment

weiji14 left a comment

Choose a reason for hiding this comment

weiji14 Oct 2, 2024

Choose a reason for hiding this comment

seisman Oct 2, 2024

Choose a reason for hiding this comment

seisman commented Sep 24, 2024 •

edited

Loading