Add PyGMT Zenodo BibTeX entry to main README.md

[weiji14]

Description of proposed changes

To ensure that people will cite PyGMT consistently in their research work, this PR adds a PyGMT BibTeX entry to the main README.md (copied from Zenodo at https://zenodo.org/record/4025418/export/hx).

Also point to https://www.generic-mapping-tools.org/cite for GMT specific modules.

Fixes #653

Reminders

• Run make format and make check to make sure the code follows the style guide.
• Add tests for new features or tests that would have caught the bug that you're fixing.
• Add new public functions/methods/classes to doc/api/index.rst.
• Write detailed docstrings for all functions/methods.
• If adding new functionality, add an example to docstrings or tutorials.

Notes

• You can write /format in the first line of a comment to lint the code automatically

[seisman]

What about a stand-alone CITATION.md file in the repository, see GenericMappingTools/gmt#115.

Question: Do we point to https://www.generic-mapping-tools.org/cite as well?

Yes, I think we should encourage users to cite both PyGMT and GMT6 if possible.

[weiji14]

What about a stand-alone CITATION.md file in the repository, see GenericMappingTools/gmt#115.

Don't think we need a dedicated page for this now since it's just one entry. We can point to https://pygmt-98df8j9um.vercel.app/#citing-pygmt (or https://pygmt.org/#citing-pygmt when this PR is merged) to instruct on how to cite PyGMT.

Yes, I think we should encourage users to cite both PyGMT and GMT6 if possible.

👌

[seisman]

The line breaks in the title and note are unnecessary:

[seisman]

Don't think we need a dedicated page for this now since it's just one entry. We can point to https://pygmt-98df8j9um.vercel.app/#citing-pygmt (or https://pygmt.org/#citing-pygmt when this PR is merged) to instruct on how to cite PyGMT.

I'm feeling that the README.md (or the website landing page) is a little too long, and readers may miss the citation information.

[weiji14]

Don't think we need a dedicated page for this now since it's just one entry. We can point to https://pygmt-98df8j9um.vercel.app/#citing-pygmt (or https://pygmt.org/#citing-pygmt when this PR is merged) to instruct on how to cite PyGMT.

I'm feeling that the README.md (or the website landing page) is a little too long, and readers may miss the citation information.

I suppose it depends on what's better for the search engine (e.g. results from "How to cite PyGMT"). There's some tips at http://citeas.org/modify-your-citation and http://citeas.org/sources. Currently looks like this at http://citeas.org/cite/pygmt:

It's a lot better for GMT at https://citeas.org/cite/gmt:

Personally I just do CTRL+F and type 'cite' or 'BibTeX' to find the citation info, but we'll need to optimize this for the machines 🤖 too 😄

[weiji14]

Another argument for having the BibTeX in the main README.md is that it will appear on PyPI as well 😉

[seisman]

Forgot to add "updating citation information" in the release checklist.

[weiji14]

Oh right, I'll merge in #673 first and we can do that, and probably start the changelog for PyGMT v0.2.1