Release PyGMT v0.3.0

[willschlitzer]

Release: v0.3.0
Scheduled Date: 2021/02/15
Pull request due date: 2021/02/13

Priority PRs/issues to complete prior to release

• Wrap subplot (Wrap subplot using with statement #822)
• Wrap grd2cpt (Wrap grd2cpt #803)
• Wrap grdinfo aliases (Wrap grdinfo aliases #799)
• Move plotting functions to separate modules (Move plotting functions to separate modules #808)
• Add affiliation and ORCID to AUTHORS.md (Add affiliation and ORCID to AUTHORS.md #857)
• Fail to install the dev version following the install instructions (Fail to install the dev version following the install instructions #856)

Before release:

• Reserve a DOI on Zenodo by clicking on "New Version" (@weiji14)
• Update Changelog (Changelog entry for v0.3.0 #887) (@willschlitzer)
• Add a new entry in doc/_static/version_switch.js for documentation switcher
• Update citation information https://github.com/GenericMappingTools/pygmt#citing-pygmt

Release:

• Go to GitHub Release and make a release, this will automatically create a tag too (@willschlitzer)
• Manually upload the pygmt-vX.Y.Z.zip file to https://zenodo.org/deposit, make sure you file it under the correct reserved DOI (@weiji14)

After release:

• Update conda-forge pygmt-feedstock [Usually done automatically by conda-forge's bot] (pygmt v0.3.0 conda-forge/pygmt-feedstock#14)
• Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (@seisman) (GenericMappingTools/try-gmt@bd8090c)
• Announce the release on:
  • GMT forum (https://forum.generic-mapping-tools.org/t/pygmt-v0-3-0-released)
  • GMT website (News) (@michaelgrund) (Update index.rst to announce release of PyGMT 0.3.0 website#95)
  • ResearchGate link
  • Twitter (feel free to tweet the release anyone!)

---

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

[weiji14]

Cool, cheers for taking this up @willschlitzer! This v0.3.0 seems much bigger one than the previous v0.2.1 (#665), and looking through the draft changelog at https://github.com/GenericMappingTools/pygmt/releases (viewable only to PyGMT team members), I think we might need to reduce the number of items by adding skip-changelog labels to trim out less important commits, particularly for the non-user facing 'maintenance' ones.

Once those last features are wrapped up (hopefully by Monday/Tuesday), please start curating a changelog (see previous one at #683), and give a shoutout if you need any help with things.

[willschlitzer]

@GenericMappingTools/python For updating the citation info, what do I put in place for "uieda_leonardo_2020_4025418"? I'm assuming this is some sort of DOI-like reference that @leouieda set up; will it be different for the new package? Also, what is the proper order to put the authors in? I know that AUTHORS.md uses alphabetical order, but this doesn't seem to do that.

[weiji14]

@GenericMappingTools/python For updating the citation info, what do I put in place for "uieda_leonardo_2020_4025418"? I'm assuming this is some sort of DOI-like reference that @leouieda set up; will it be different for the new package?

I've reserved a new doi at doi.org/10.5281/zenodo.4522136, so it should be uieda_leonardo_2021_4522136 for v0.3.0.

Also, what is the proper order to put the authors in? I know that AUTHORS.md uses alphabetical order, but this doesn't seem to do that.

It's roughly by order of commits/lines of code/outreach contributions. Leo's definitely first since he started it, and Paul the guru is last, but the rest we can discuss in #726.

P.S. The 12 Feb date is looking a bit too optimistic. Maybe push it out to 16 Feb or so.

[willschlitzer]

@GenericMappingTools/python For updating the citation info, what do I put in place for "uieda_leonardo_2020_4025418"? I'm assuming this is some sort of DOI-like reference that @leouieda set up; will it be different for the new package?

I've reserved a new doi at doi.org/10.5281/zenodo.4522136, so it should be uieda_leonardo_2021_4522136 for v0.3.0.

Just so I understand it, when I upload the PyGMT zip (that's just downloading the entire repository, correct?) to Zenodo, I'll list the DOI as "10.5281/zenodo.4522136", correct?

Also, what is the proper order to put the authors in? I know that AUTHORS.md uses alphabetical order, but this doesn't seem to do that.

It's roughly by order of commits/lines of code/outreach contributions. Leo's definitely first since he started it, and Paul the guru is last, but the rest we can discuss in #726.
I'll discuss the author order over at #726. Regarding the ORCID, it seems like I can copy everyone from the previous release, and just add myself and @michaelgrund. Is there anything else I'm forgetting?

P.S. The 12 Feb date is looking a bit too optimistic. Maybe push it out to 16 Feb or so.

Is this delay mostly because of wrapping subplot? I'm fine with a delay, but I do want PyGMT v0.3 done before the GMT 6.2 release. My personal preference is that it is released on 15 Feb (a US holiday) at the latest, otherwise I may have some delays during the week and not get it done until the following weekend.

[weiji14]

Just so I understand it, when I upload the PyGMT zip (that's just downloading the entire repository, correct?) to Zenodo, I'll list the DOI as "10.5281/zenodo.4522136", correct?

Yes, but I'm actually the only one who can do the upload to Zenodo (see #601). You can still list the DOI in the changelog though.

Is this delay mostly because of wrapping subplot? I'm fine with a delay, but I do want PyGMT v0.3 done before the GMT 6.2 release. My personal preference is that it is released on 15 Feb (a US holiday) at the latest, otherwise I may have some delays during the week and not get it done until the following weekend.

Ok, 15 Feb (UTC) is fine (it'll be 16 Feb for me in NZ :P). Just didn't want to overwork Dongdong over CNY ;)

[willschlitzer]

Just so I understand it, when I upload the PyGMT zip (that's just downloading the entire repository, correct?) to Zenodo, I'll list the DOI as "10.5281/zenodo.4522136", correct?

Yes, but I'm actually the only one who can do the upload to Zenodo (see #601). You can still list the DOI in the changelog though.

Sounds good! I'll send you the ORCIDs for @michaelgrund and me. Do you need anything else from me for this?

Is this delay mostly because of wrapping subplot? I'm fine with a delay, but I do want PyGMT v0.3 done before the GMT 6.2 release. My personal preference is that it is released on 15 Feb (a US holiday) at the latest, otherwise I may have some delays during the week and not get it done until the following weekend.

Ok, 15 Feb (UTC) is fine (it'll be 16 Feb for me in NZ :P). Just didn't want to overwork Dongdong over CNY ;)

Sounds good!

[seisman]

15 Feb sounds a good time to me.

[seisman]

I've reserved a new doi at doi.org/10.5281/zenodo.4522136, so it should be uieda_leonardo_2021_4522136 for v0.3.0.

Are there any rules for the bibtex name? Is it better to use pygmt_2021_4522136?

[weiji14]

I've reserved a new doi at doi.org/10.5281/zenodo.4522136, so it should be uieda_leonardo_2021_4522136 for v0.3.0.

Are there any rules for the bibtex name? Is it better to use pygmt_2021_4522136?

The uieda_leonardo_* name is just copied from https://zenodo.org/record/4253459/export/hx, but it's also completely arbitrary and people might change it in their reference manager anyway I guess. Using pygmt_2021_4522136 sounds good.

[michaelgrund]

I've reserved a new doi at doi.org/10.5281/zenodo.4522136, so it should be uieda_leonardo_2021_4522136 for v0.3.0.

Are there any rules for the bibtex name? Is it better to use pygmt_2021_4522136?

As @weiji14 mentioned the bibtex name is completely arbitrary, in principle it's possible to select what ever you want but I agree that pygmt_2021_4522136 (and for future releases pygmt_202X_*) would be a good choice.

[weiji14]

Ok, subplot wrapper is finally done (woohoo)! I realize there's a lot of really good documentation improvements in the pipeline, and I'm happy for one or two to sneak in, but let's not waste time with the changelog at #887.

We can always make a 'quick' v0.3.1 release once #631 is fixed, and throw in a couple of minor bug fixes along the way.

[weiji14]

Ok, changelog merged and published at https://www.pygmt.org/dev/changes.html#release-v0-3-0-2021-02-15! @willschlitzer, once you publish the release, I'll work on the Zenodo zipfile upload, and then it'll be the post release announcements.