Release PyGMT v0.13.0

[seisman]

Release: v0.13.0
Scheduled Date: 2024/09/05
Pull request due date: 2024/09/03
DOI: 10.5281/zenodo.13679420

Priority PRs/issues to complete prior to release

• Convert projection table from reStructuredText to Markdown #3363 @yvonnefroehlich
• Tutorial: Adding a data set on top of a topographic surface via "drapegrid" of "Figure.grdview" #3316 @yvonnefroehlich
• Make projection names consistent @yvonnefroehlich
  • DOC/projections: Simplify links in the projection table to use directly the titles of the examples #3407
  • upstream GMT PR DOC/projections: Make projection name consistent gmt#8567
• Use a different dataset in the gallery example "examples/gallery/lines/roads.py" #3320 @michaelgrund ?
• Let pygmt.show_versions show GDAL version #3364
• Fix typos in documentation and codes #3370

Before release:

• Check SPEC 0 to see if we need to bump the minimum supported versions of GMT, Python and core package dependencies (NumPy/Pandas/Xarray) SPEC 0: Bump minimum supported versions to xarray 2022.09 #3372 @seisman
• Check to ensure that:
  • All tests pass in the "GMT Legacy Tests" workflow Crashes but nothing we can do.
  • All tests pass in the "GMT Dev Tests" workflow
  • All tests pass in the "Doctests" workflow @seisman
  • Deprecations and related tests are removed for this version by running grep --include="*.py" -r 'remove_version="vX.Y.Z"' pygmt from the base of the repository @seisman
• Update warnings in pygmt.show_versions() as well as notes in Common installation issues
  and Testing your install regarding GMT-Ghostscript incompatibility @seisman
• Reserve a DOI on Zenodo by clicking on "New Version" 10.5281/zenodo.13679420 @seisman
• Review the "PyGMT Team" page
• Finish up 'Changelog entry for v0.x.x' Pull Request: Changelog entry for v0.13.0 #3425
  • Add a new entry in doc/_static/version_switch.js for documentation switcher
  • Update CITATION.cff and BibTeX at https://github.com/GenericMappingTools/pygmt#citing-pygmt
    • Update authorship list
    • Update DOI (and url for BibTeX)
    • Update version
    • Update date released
  • Add the documentation link doc/minversions.md
  • Add minimum required version information doc/minversions.md
  • Copy draft changelog from Release Drafter and edit it to look nice (see maintainers guide for details)
• Run make codespell to check common misspellings. If there are any, either fix them or add them to ignore-words-list in pyproject.toml

Release:

• At the PyGMT release page on GitHub:
  • Edit the draft release notes with the finalized changelog
  • Set the tag version and release title to vX.Y.Z
  • Make a release by clicking the 'Publish Release' button, this will automatically create a tag too
• Manually upload the pygmt-vX.Y.Z.zip and baseline-images.zip files to https://zenodo.org/deposit, ensure that it is filed under the correct reserved DOI

After release:

• Update conda-forge pygmt-feedstock [Done automatically by conda-forge's bot, but remember to pin SPEC0 versions]
• Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update) Bump to PyGMT v0.13.0 and also other dependencies try-gmt#54
• Announce the release on:
  • GMT forum (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status) https://hackmd.io/V54IxrZGRv2eLr7z6n-7yQ
  • ResearchGate (after forum announcement, add new version as research item via the code category, be sure to include the corresponding new Zenodo DOI) https://www.researchgate.net/publication/383826612_PyGMT_A_Python_interface_for_the_Generic_Mapping_Tools_v0130

---

• Party 🎉 (don't tick before all other checkboxes are ticked!)

[seisman]

It has been three months and more than 100 commits since PyGMT v0.12.0 (released on May 1st, 2024). Let us go with the PyGMT v0.13.0 release following our quarterly release plan. I expect to release PyGMT v0.13.0 in August and then v0.14.0 in December (pre-AGU or post-AGU).

[yvonnefroehlich]

Let us go with the PyGMT v0.13.0 release following our quarterly release plan. I expect to release PyGMT v0.13.0 in August [...]

Do you want to make the release already on the upcoming weekend 👀?

[seisman]

Let us go with the PyGMT v0.13.0 release following our quarterly release plan. I expect to release PyGMT v0.13.0 in August [...]

Do you want to make the release already on the upcoming weekend 👀?

I think not. The release date depends on the issues/PRs we want to address in v0.13.0. Personally, I want to refactor the data_kind and virtualfile_in functions in this release.

[weiji14]

How about mid-Aug, say 14th or 15th? I'll be travelling for two weeks afterwards until early Sep so might not have so much time.

Personally, I want to refactor the data_kind and virtualfile_in functions in this release.

Agree that we should get some of that wrapped up. Unfortunately my laptop is crashing a lot recently (trying to get it fixed, might be a hardware issue), so I might be super slow on reviews until next week at least. Doing as much as I can on mobile in the meantime.

[yvonnefroehlich]

Let us go with the PyGMT v0.13.0 release following our quarterly release plan. I expect to release PyGMT v0.13.0 in August [...]

Do you want to make the release already on the upcoming weekend 👀?

I think not. The release date depends on the issues/PRs we want to address in v0.13.0. Personally, I want to refactor the data_kind and virtualfile_in functions in this release.

Ah, that's good 🙂! For me, the upcoming weekend and starting of next week are already quite full. Maybe I can complete the tutorial for "draping a dataset on top of a topographic surface".

[seisman]

How about mid-Aug, say 14th or 15th?

Sounds good.

[seisman]

Personally, I want to refactor the data_kind and virtualfile_in functions in this release.

I just realized the virtualfile_in method was added in v0.12.0 (#3068). Initially, I thought it was added after v0.12.0, then it makes sense to make breaking changes before making the v0.13.0 release. Since it was added in v0.12.0, there's no point in rushing to make breaking changes before 0.13.0 is released.

I'll focus on some smaller PRs before the scheduled release date.

[michaelgrund]

Will submit a modified gallery example regarding #3320 during the week.

[seisman]

It seems @willschlitzer is no longer active in this project since one year ago (commits history at https://github.com/GenericMappingTools/pygmt/commits?author=willschlitzer). Perhaps we should move him to "Distinguished Contributors" on the "PyGMT team" page and also revoke some access permissions? It's also a good time for us to have an offboarding checklist, which is the reverse of our onboarding checklist.

@GenericMappingTools/pygmt-maintainers Please have a vote by 👍 or 👎, or leave your comments.

Of course, @willschlitzer you're always welcome to come back at any time.

[seisman]

@GenericMappingTools/gmt-maintainers I'll be traveling from Aug 14 to Aug 18 and may have little time on this release. Maybe release it earlier, like Aug 12?

[yvonnefroehlich]

@GenericMappingTools/gmt-maintainers I'll be traveling from Aug 14 to Aug 18 and may have little time on this release. Maybe release it earlier, like Aug 12?

Hm. For me, I am not sure how much time I will have this weekend and I am afraid the beginning of next week will be quite full.