Release PyGMT v0.10.0

[weiji14]

Release: v0.10.0
Scheduled Date: 2023/09/01
Pull request due date: 2023/08/30

Priority PRs/issues to complete prior to release

• Add gallery example for plotting an RGB image from an xarray.DataArray #2641
• Figure.text: Support non-ASCII characters in the 'text' parameter #2638
• Fix tests for Aug 2023 updated remote datasets #2636
• Add gallery example to show usage of dcw parameter in Figure.coast #2428
• Add tutorial to explain naming of PyGMT figure elements #2383
• pygmt.select: Add aliases for "C", "F", and "L" #2466
• Add ResearchGate version upload to Release checklist #2642

Before release:

• Check NEP29 to see if we need to bump the minimum Python and NumPy versions
• Check to ensure that:
  • All tests pass in the "GMT Legacy Tests" workflow
  • All tests pass in the "GMT Dev Tests" workflow
  • 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.8303186
• Finish up 'Changelog entry for v0.x.x' Pull Request: Changelog entry for v0.10.0 #2651
  • 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.10.0 conda-forge/pygmt-feedstock#28
• Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update) Bump to PyGMT v0.10.0 try-gmt#51
• Announce the release on:
  • GMT forum (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status) https://forum.generic-mapping-tools.org/t/pygmt-v0-10-0-released/4223
  • 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/373659077_PyGMT_A_Python_interface_for_the_Generic_Mapping_Tools_v0100
  • Twitter (after forum announcement)

---

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

[weiji14]

Starting to draft forum announcement at https://hackmd.io/@pygmt/v0-10-0_announcement

• All tests pass in the "GMT Legacy Tests" workflow

Last run on 29 Aug 2023 failed with 19 tests at https://github.com/GenericMappingTools/pygmt/actions/runs/6006384122/job/16290821746. Should have been fixed with #2636, though I haven't tested this manually.

• All tests pass in the "GMT Dev Tests" workflow

Dev Tests are not running now due to an AttributeError: np.unicode_was removed in the NumPy 2.0 release. Usenp.str_ instead. when importing xarray with numpy 2.0. See logs at https://github.com/GenericMappingTools/pygmt/actions/runs/6043991082/job/16401918043#step:16:40 and upstream bug report at pydata/xarray#8133. Run from last week on 25 Aug 2023 (see https://github.com/GenericMappingTools/pygmt/actions/runs/5970439928/job/16198037215) failed with the 19 remote dataset tests.

Shall we just assume that things are good enough and skip those checkmarks for this PyGMT v0.10.0 release?

[seisman]

• All tests pass in the "GMT Legacy Tests" workflow

Last run on 29 Aug 2023 failed with 19 tests at https://github.com/GenericMappingTools/pygmt/actions/runs/6006384122/job/16290821746. Should have been fixed with #2636, though I haven't tested this manually.

Looks good to me.

• All tests pass in the "GMT Dev Tests" workflow

Dev Tests are not running now due to an AttributeError: np.unicode_was removed in the NumPy 2.0 release. Usenp.str_ instead. when importing xarray with numpy 2.0. See logs at https://github.com/GenericMappingTools/pygmt/actions/runs/6043991082/job/16401918043#step:16:40 and upstream bug report at pydata/xarray#8133. Run from last week on 25 Aug 2023 (see https://github.com/GenericMappingTools/pygmt/actions/runs/5970439928/job/16198037215) failed with the 19 remote dataset tests.

Shall we just assume that things are good enough and skip those checkmarks for this PyGMT v0.10.0 release?

Looks good.

[weiji14]

Ok, Zenodo upload is up at https://doi.org/10.5281/zenodo.8303186 🎉 Now to wait for the conda-forge bot and all that. If someone can work on the forum announcement draft (https://hackmd.io/@pygmt/v0-10-0_announcement) in the meantime, that would be great. No rush though, we can post it on Monday.

[seisman]

Great work @weiji14. I just made some edits to the announcement draft.

[seisman]

PyGMT has been updated to v0.10.0 on conda-forge and try-gmt!

[yvonnefroehlich]

@weiji14 the forum announcement draft looks already very good 🙂. So far I just made same edits regarding consistency.
Edit: I added issue 2627 to the "Documentation improvements" subsection, and fixed a typo and added uncertaintycolor to uncertaintyfill for Figure.velo in the "Upcoming deprecations" section.

[EJFielding]

The conda-forge version worked for me to run conda update pygmt. Thanks for all the work folks have done!

[weiji14]

Awesome, cheers everyone for updating the draft announcement. Will post it later today if there aren't any extra things to add.

On the workshops/conferences section, I put a note that we don't have anything planned yet, but is anyone interested in running one for EGU24 next year (short course session proposal deadline is 14 Sep 2023), AGU, or some other conference? We can discuss more on the forum if anyone is interested.

[weiji14]

Ok, forum announcement is at https://forum.generic-mapping-tools.org/t/pygmt-v0-10-0-released/4223. Can someone do the ResearchGate announcement/post? I'll try to post this on Twitter later too...