Repository navigation
Release PyGMT v0.8.0 #2244
Description
Release: v0.8.0
Scheduled Date: 2022/12/28 -> 2022/12/30
Pull request due date: 2022/12/26
Priority PRs/issues to complete prior to release
- In some functions, G is aliased as "fill" but shown "color" in docstrings #1617
-
beachball offsetting doesn't work for pandas/dict/ndarray input #2016- Figure.meca: Fix beachball offsetting with dict/pandas inputs #2202 @seisman
- Figure.meca: Fix line and circle of offset parameter for dict/pandas input #2226 @yvonnefroehlich
Fix offset for ndarray input, see comment beachball offsetting doesn't work for pandas/dict/ndarray input #2016 (comment) @seisman
- Missing colorbars in examples #2030
- Incorrect build documentation due to identical file names of examples #2250
- Add support for Python 3.11 #2172 @seisman
- NEP29: Test PyGMT on NumPy 1.24 #2256 @seisman
- Use environmental variable GITHUB_OUTPUT instead of the deprecated set-output command #2263 @seisman
- Link Checker Report on 2022-12-18 #2255
- Link Checker Report on 2022-12-25 #2271
- load_earth_relief now returns grid-registrated grids when registration is not specified #1929
- load_earth_relief() now returns gridline-registrated grids by default in GMT 6.4 #2052 @seisman
- Set gridline (if available) as the default grid registration for remote datasets #2266 @willschlitzer
- Update the order of datasets and grid registrations #2276 @seisman
-
Add IPython to GMT Legacy Tests CI environment #2283 @weiji14 - Update the doctest output due to changes in the default grid registration #2284 @seisman
- Improve the load_earth_relief and load_earth_age functions #2225
- Add load_earth_vertical_gravity_gradient function for Earth vertical gravity gradient dataset #2240 @willschlitzer
- Add WDMAM dataset to load_earth_magnetic_anomaly #2241 @willschlitzer
- Use consistently 1-D, 2-D, or 3-D (with hyphen and capitalized) #2252 @yvonnefroehlich
- Inconsistent syntax for projections in documentation #2059
-
Add function to load raster tile maps using contextily #2125 @weiji14 - Add gallery example for Figure.ternary method #2138 @michaelgrund
- Please note problem raised in comment Add gallery example for Figure.ternary method #2138 (comment)
- GMT PR #7171
- GMT PR #7172
- Figure.ternary: Fix the crash for pd.DataFrame input with GMT 6.3-6.4 #2274 @seisman
- Update instructions for checking README syntax for release #2173
Before release:
- Run
grep --include="*.py" -r 'remove_version="vX.Y.Z"' pygmtfrom the base of the repository to check if any deprecations and related tests should be removed in this version - Reserve a DOI on Zenodo by clicking on "New Version" @weiji14
10.5281/zenodo.7481934 - Finish up 'Changelog entry for v0.x.x' Pull Request Changelog entry for v0.8.0 #2272:
- Add a new entry in
doc/_static/version_switch.jsfor documentation switcher - Update
CITATION.cffand 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)
- Add a new entry in
Release:
- At the PyGMT release page on GitHub: does NOT require maintain permission
- 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 @weiji14
After release:
- Update conda-forge pygmt-feedstock [Done automatically by conda-forge's bot, but remember to pin NEP29 versions] pygmt v0.8.0 conda-forge/pygmt-feedstock#25
- Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update) Bump pygmt from 0.7.0 to 0.8.0 try-gmt#43
- Announce the release on:
- GMT forum (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status)
- ResearchGate (after forum announcement)
- Twitter (after forum announcement) https://twitter.com/gmt_dev/status/1609219118435033088
- Party 🎉 (don't tick before all other checkboxes are ticked!)
Activity
seisman commentedon Dec 13, 2022
@yvonnefroehlich We plan to make the v0.8.0 release at the end of this month. Would you like to be the release manager? The release process should be pretty smooth and we'll guide you through it if you need any help.
yvonnefroehlich commentedon Dec 14, 2022
Thanks for asking me!
Currently, I am not sure about what people exactly expect me to do as a release manager and what the workload of this is.
Does this mean working through the checklist given above in this issue? There is also a section regarding making a release in the Maintainers Guide https://www.pygmt.org/dev/maintenance.html#making-a-release. Furthermore, I roughly looked at the corresponding issues of the previous releases:
So, in general I am interested in helping (and learning ...), but I will need some help with this.
seisman commentedon Dec 18, 2022
@yvonnefroehlich Thanks for offering your help. The first thing we need to do is to decide the PRs/issues that should be finished before the release.
yvonnefroehlich commentedon Dec 20, 2022
@GenericMappingTools/pygmt-maintainers I added a check list under the section "Priority PRs/issues to complete prior to release" of the release notes at the beginning of this issue. It is based on the issues and PRs listed under the 0.8.0 millstone. Please, feel free to edit and modify it that it fit your conventions.
maxrjones commentedon Dec 20, 2022
Thanks for managing the release @yvonnefroehlich! I'll be able to work on the README syntax checking instructions tomorrow and will triage any other issues/PRs that I have open. Really appreciate you and the team keeping PyGMT moving forward this fall!
willschlitzer commentedon Dec 20, 2022
Merged the conflicts on #2240 and #2241, and added inline examples for
load_earth_free_air_anomaly(#2257),load_earth_geoid(#2258), andload_earth_magnetic_anomaly(#2259).seisman commentedon Dec 21, 2022
I'd like to draw your attention to this PR #1929 and hopefully we can have a solution before making the v0.8.0 release.
yvonnefroehlich commentedon Dec 25, 2022
@weiji14 from the previous releases I got, that only you can reserve a DOI on Zenodo. Can you please do this for the v0.8.0 release.
weiji14 commentedon Dec 25, 2022
Yep, here it is:
10.5281/zenodo.7481934yvonnefroehlich commentedon Dec 27, 2022
Hm. I feel it would be great if we can find a consensus for PR #2260.
weiji14 commentedon Dec 28, 2022
Getting close, thanks @yvonnefroehlich for keeping on top of things! This is probably one of our biggest releases yet 😆
We might need to push the release out to 29 Dec (UTC time) to get the last pieces in. There are some GMT 6.3 compatibility fixes we might want as mentioned by @seisman in #2281 (comment), and @willschlitzer last dataset PR at #2241 should be almost ready too.
10 remaining items
yvonnefroehlich commentedon Dec 29, 2022
Thanks for guiding me through it @seisman and @weiji14 🙂!
seisman commentedon Dec 30, 2022
We still need to draft the announcement on hackmd.io and make the announcement, but I'm having technical difficulties (unstable VPN) accessing the hackmd site recently, so can't help with it.
yvonnefroehlich commentedon Dec 30, 2022
@GenericMappingTools/pygmt-maintainers you can finde the draft annoncement on hackmd.io/@pygmt at https://hackmd.io/-F4DsAVuRYCkoWNkWGQNig. I used the structure of the previous announcements as orientation. Please feel free to add more text 🙂.
weiji14 commentedon Dec 31, 2022
Thanks @yvonnefroehlich! I've added some thumbnails for the dataset loaders and gallery example. If someone can take another look and give it the ok, you can go ahead and post it to https://forum.generic-mapping-tools.org/c/news/8 (I think you should have permissions as moderator?). Ok too if you want to post on ResearchGate. Twitter will have to be me, or @maxrjones I think.
michaelgrund commentedon Dec 31, 2022
From my side the announcement looks good as is. Thanks all for the efforts in the last few days/weeks/months.
yvonnefroehlich commentedon Dec 31, 2022
Thanks @weiji14 for adding the thumbnails and @michaelgrund for proof reading.
I have posted the announcement in GMT forum (please see https://forum.generic-mapping-tools.org/t/pygmt-v0-8-0-released/3577).
weiji14 commentedon Dec 31, 2022
Great! I've edited the forum post slightly so that the images are a bit smaller and fit side by side. Have also made a post on Twitter at https://twitter.com/gmt_dev/status/1609219118435033088. Considering whether we should get an account on Mastodon (e.g. https://fosstodon.org) too actually.
I think @Esteban82 is planning to make an Instagram post too at https://www.instagram.com/genericmappingtools. And we'll still need a post on ResearchGate. Who wants to volunteer? I've got these screenshots you can use to post:
yvonnefroehlich commentedon Dec 31, 2022
Thanks. I am sorry, I could not figure out how to do this in Markdown, and used instead html to reduce the figures size. Good to know for next time 🙂.
Great! Thanks @weiji14!
Great! Thanks @Esteban82!
I posted the announcement on ResearchGate (please see https://www.researchgate.net/project/PyGMT-A-Python-interface-for-the-Generic-Mapping-Tools/update/63b06ca123e35630acd945bc). Hope it is fine with everybody. I used the figures by @weiji14.
Esteban82 commentedon Dec 31, 2022
I just post it on instagram.
BTW, for the image I use a screnshot of Max's talk.
I think Instragram only wants images with these proportions (4:5, 1:1 and 16:9). So I couldn't use weiji14 screenshots.
yvonnefroehlich commentedon Dec 31, 2022
Seems like there is also interest regarding this on the GMT forum, please see https://forum.generic-mapping-tools.org/t/pygmt-v0-8-0-released/3577/2?u=yvonnefroehlich.
seisman commentedon Jan 1, 2023
Great work everyone! Thanks @yvonnefroehlich for leading this release!
Closing the issue since all the boxes are checked.
Please discuss the possible Mastodon account on the forum instead, since the account will be used for the whole GMT family, not just PyGMT.
yvonnefroehlich commentedon Jan 2, 2023
Thanks everybody for the efforts and help with this release 😊! Great job 🎉! Thanks @seisman and @weiji14 for guiding me through it. Thanks also to Paul Wessel for the rapid fix of the issue with the ternary module / method.
maxrjones commentedon Jan 4, 2023
Congrats and great work on this release!