Release PyGMT v0.11.0

[seisman]

Release: v0.11.0
Scheduled Date: 2024/02/01
Pull request due date: 2024/01/29

Priority PRs/issues to complete prior to release

• Planetary relief datasets from Add load_* functions to support more remote relief datasets #2431
• Bump to GMT 6.5.0 Bump to GMT 6.5.0 #2961
• Bump Ghostscript to 10.02.1 Bump ghostscript to 10.02.1 #2694
• Update baseline images to match GMT 6.5.0 + Ghostscript 10.02.1 Bump to GMT 6.5.0 #2961

Before release:

• Check NEP29 to see if we need to bump the minimum Python and NumPy versions
• Run make codespell to check common misspellings. If there are any, either fix them or add them to ignore-words-list in pyproject.toml
• Check to ensure that:
  • All tests pass in the "GMT Legacy Tests" workflow Fix failing tests for legacy GMT versions #3021
  • All tests pass in the "GMT Dev Tests" workflow (Release PyGMT v0.11.0 #2843 (comment))
  • 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
• Reserve a DOI on Zenodo by clicking on "New Version" 10.5281/zenodo.10578540
• Finish up 'Changelog entry for v0.x.x' Pull Request: Changelog entry for v0.11.0 #3022
  • 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 https://github.com/GenericMappingTools/pygmt#compatibility-with-gmtpythonnumpy-versions
  • Add compatibility information https://github.com/GenericMappingTools/pygmt#compatibility-with-gmtpythonnumpy-versions
  • Copy draft changelog from Release Drafter and edit it to look nice (see maintainers guide for details)

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 NEP29 versions] pygmt v0.11.0 conda-forge/pygmt-feedstock#29
• Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update) GenericMappingTools/try-gmt@53b4e7d
• Announce the release on:
  • GMT forum (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status) https://hackmd.io/UPCHs1S7SyCmnzvgcRKOUw
  • 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/377939031_PyGMT_A_Python_interface_for_the_Generic_Mapping_Tools_v0110

---

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

[weiji14]

Are we planning on releasing this after GMT 6.5.0 - GenericMappingTools/gmt#8017?

[seisman]

Hi @GenericMappingTools/pygmt-maintainers, we need to decide the most suitable release date for PyGMT v0.11.0:

• GMT 6.5.0 is planned to be released in a few days (Release GMT 6.5.0 gmt#8017)
• 11-15 Dec is the AGU meeting week
• 25 Dec is the Christmas holiday
• 1 Jan 2024 is the New Year holiday

We will wait for the GMT 6.5.0 release, then the best dates may be 16-24 Dec and 26-31 Dec?

[weiji14]

We will wait for the GMT 6.5.0 release, then the best dates may be 16-24 Dec and 26-31 Dec?

Ok with either, will let others decide on what's a good release time.

I can help with some of the ghostscript 10.02 and CI-related updates once GMT 6.5.0 lands 🙈

[yvonnefroehlich]

Hi @GenericMappingTools/pygmt-maintainers, we need to decide the most suitable release date for PyGMT v0.11.0:

• GMT 6.5.0 is planned to be released in a few days (Release GMT 6.5.0 gmt#8017)
• 11-15 Dec is the AGU meeting week

For me AGU is not relevant.

• 25 Dec is the Christmas holiday

At least in Germany 25 Dec and 26 Dec are both public Christmas holidays 😆.

• 1 Jan 2024 is the New Year holiday

Upon 29 or 30 Dec I am probably not available for a few days.

We will wait for the GMT 6.5.0 release, then the best dates may be 16-24 Dec and 26-31 Dec?

Not sure how realistic it is that people have time to finish and review PRs in the week before Christmas 😅.

[weiji14]

GMT 6.5.0 release should be close 🤞, shall we set a new schedule date for PyGMT v0.11.0? I'm back to work next week, and away for a conference around 18-21 Jan, but could help for a release around end of Jan 2024?

[Esteban82]

I think that the pygmt releases should also be announced on instagram. I could do it.

[seisman]

Ping @GenericMappingTools/pygmt-maintainers I think it's time to prepare for the v0.11.0 release, which was planned to be released on Jan, 1, 2024 and haven't been postponed due to the GMT 6.5.0 release. Now the new target release date is Feb 1, 2024. Helps are welcomed.

[seisman]

There are 4 failures in the "GMT Dev workflow" (see https://github.com/GenericMappingTools/pygmt/actions/runs/7676761841/job/20924687559?pr=3019). The 4 failures are because OpenMP support is not enabled for the GMT dev builds. I've tried to enable openmp support in #3011, but it turns out more difficult than I initially expected. So, let's address the OpenMP support issue after v0.11.0 release.

[seisman]

• Reserve a DOI on Zenodo by clicking on "New Version"

@weiji14 Not sure what's happening. I can create a new version for GMT, but can't do it for PyGMT.

For GMT:

For PyGMT:

[seisman]

I've created an initial release announcement (with contents copied from v0.10.0) at https://hackmd.io/UPCHs1S7SyCmnzvgcRKOUw.

[yvonnefroehlich]

I've created an initial release announcement (with contents copied from v0.10.0) at https://hackmd.io/UPCHs1S7SyCmnzvgcRKOUw.

Thanks @seisman for pushing the release forward. I started to adjust the content of the release announcement for v0.11.0.

[yvonnefroehlich]

• Add load_* functions to support more remote relief datasets #2431

We are not planning to add all remote datasets listed at #2431 (comment) for v0.11.0, or? If we focus on the planetary reliefs, only Mercury and Pluto are missing.

[seisman]

[ ] 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

@weiji14 Need your help here.

[seisman]

• GMT forum (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status) https://hackmd.io/UPCHs1S7SyCmnzvgcRKOUw

Thanks @yvonnefroehlich for drafting the announcement. It looks good to me.

[weiji14]

[ ] 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

@weiji14 Need your help here.

Ok, done at https://doi.org/10.5281/zenodo.10578540!

[yvonnefroehlich]

• GMT forum (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status) https://hackmd.io/UPCHs1S7SyCmnzvgcRKOUw

Thanks @yvonnefroehlich for drafting the announcement. It looks good to me.

So, I can do the forum announcement if everybody else is happy with the draft. Or does somebody else want to do it?

[weiji14]

• GMT forum (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status) https://hackmd.io/UPCHs1S7SyCmnzvgcRKOUw

Thanks @yvonnefroehlich for drafting the announcement. It looks good to me.

So, I can do the forum announcement if everybody else is happy with the draft. Or does somebody else want to do it?

Sure, go ahead! I just changed some links from /dev to /v0.11.0, and a couple of typos, and it looks good to me now.

@michaelgrund, do you want to do the ResearchGate post/announcement afterwards?

[yvonnefroehlich]

• GMT forum (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status) https://hackmd.io/UPCHs1S7SyCmnzvgcRKOUw

Thanks @yvonnefroehlich for drafting the announcement. It looks good to me.

So, I can do the forum announcement if everybody else is happy with the draft. Or does somebody else want to do it?

Sure, go ahead! I just changed some links from /dev to /v0.11.0, and a couple of typos, and it looks good to me now.

Thanks @weiji14 for adjusting the links. I have posted the announcement on the GMT forum, please see https://forum.generic-mapping-tools.org/t/pygmt-v0-11-0-released/4667.

[michaelgrund]

• GMT forum (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status) https://hackmd.io/UPCHs1S7SyCmnzvgcRKOUw

Thanks @yvonnefroehlich for drafting the announcement. It looks good to me.

So, I can do the forum announcement if everybody else is happy with the draft. Or does somebody else want to do it?

Sure, go ahead! I just changed some links from /dev to /v0.11.0, and a couple of typos, and it looks good to me now.

@michaelgrund, do you want to do the ResearchGate post/announcement afterwards?

Sure, will make the post in RG later 😉 .

UPDATE: Annoucement is done on RG (https://www.researchgate.net/publication/377939031_PyGMT_A_Python_interface_for_the_Generic_Mapping_Tools_v0110).

[seisman]

Thanks everybody for the efforts and help with this release 🎉!