DOC/website: Move citiation information from README to separate file and subsection "citing" - #4784
Conversation
yvonnefroehlich
added
documentation
yvonnefroehlich
changed the title
yvonnefroehlich
added
the
needs review
yvonnefroehlich
changed the title
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
| @@ -3,10 +3,11 @@ | |||
| We are an international team dedicated to building a Pythonic API for the Generic Mapping | |||
There was a problem hiding this comment.
There are four paragraphs of long text on this page. We probably need to shortern them, but in a separate PR.
| month = jul, | ||
| year = 2026, | ||
| publisher = {Zenodo}, | ||
| version = {0.19.0}, |
There was a problem hiding this comment.
Should we include the "v"? At Zenodo it is included, please see https://doi.org/10.5281/zenodo.3781524:
Tian, D., Leong, W. J., Fröhlich, Y., Grund, M., Schlitzer, W., Jones, M., Toney, L., Yao, J., Tong, J.-H., Magen, Y., Materna, K., Belem, A., Newton, T., Anant, A., Ziebarth, M., Quinn, J., He, X., Uieda, L.& Wessel, P. (2026). PyGMT: A Python interface for the Generic Mapping Tools (Version v0.19.0) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.19398871
There was a problem hiding this comment.
In our Zenodo records, we set the version field to "v0.19.0" rather than "0.19.0", but Zenodo suggests using a semantic version string.
According to the semver site, v0.19.0 is NOT a semantic version, 0.19.0 is (xref: https://semver.org/#is-v123-a-semantic-version). In other words, we should use 0.19.0 in the version field.
There was a problem hiding this comment.
OK. This means we should update the metadata of the Zenodo uploads.
There was a problem hiding this comment.
I believe we already had some similar discussions on this "v" during one release but could not find it at the moment in the release issues or changelog PRs.
Edit: I found it #2272 (comment) and #2272 (comment). For release 0.8.0, we decided to drop the "v" in the BibTeX entry in the README to be consistent with the CITIATION.cff file (https://github.com/GenericMappingTools/pygmt/pull/2272/changes#diff-7b3ed02bc73dc06b7db906cf97aa91dec2b2eb21f2d92bc5caa761df5bbc168f).
Currently we use the "v" in the GitHub releases and tags (https://github.com/GenericMappingTools/pygmt/tags) and the file name for the Zenodo archive as well as in the table for the Minimum Supported Versions. Probably need to add some note to the Maintainers Guide.
There was a problem hiding this comment.
Maybe open an issue so that we can discuss it in detail
There was a problem hiding this comment.
Agree, better to have a separate issue for more detailed discussions, please see #4790.
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
seisman
added
final review call
seisman
removed
the
final review call
2 participants
Description of proposed changes
Related to #4746
Third PR related to comment https://github.com/GenericMappingTools/pygmt/pull/4762/changes#r3663485282
Preview
Guidelines
Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash command is:
/format: automatically format and lint the code