Add PyGMT Zenodo BibTeX entry to main README.md#678
Conversation
|
What about a stand-alone
Yes, I think we should encourage users to cite both PyGMT and GMT6 if possible. |
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.
👌 |
|
The line breaks in the title and note are unnecessary: |
I'm feeling that the README.md (or the website landing page) is a little too long, and readers may miss the citation information. |
Co-Authored-By: Dongdong Tian <seisman.info@gmail.com>
0faadd1 to
434f671
Compare
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 |
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
|
Another argument for having the BibTeX in the main README.md is that it will appear on PyPI as well 😉 |
|
Forgot to add "updating citation information" in the release checklist. |
|
Oh right, I'll merge in #673 first and we can do that, and probably start the changelog for PyGMT v0.2.1 |
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
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Notes
/formatin the first line of a comment to lint the code automatically