Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Zenodo for citations #1265

Merged
merged 2 commits into from
Aug 9, 2022
Merged

Add Zenodo for citations #1265

merged 2 commits into from
Aug 9, 2022

Conversation

varunagrawal
Copy link
Collaborator

This PR adds a link to GTSAM's Zenodo page where citation text is auto-generated. This way, one can cite GTSAM easily in academic work.

@varunagrawal varunagrawal added docs Update to docs or README without code changes quick-review Quick and easy PR to review labels Aug 4, 2022
@varunagrawal varunagrawal self-assigned this Aug 4, 2022
@varunagrawal varunagrawal linked an issue Aug 4, 2022 that may be closed by this pull request
@gchenfc
Copy link
Member

gchenfc commented Aug 4, 2022

This is cool but, personally, I think it's best @dellaert review this (not sure if you already coordinated with him independently or not), and make sure that this citation format:

  1. will be maintained long-term; I'm not sure how established zenodo is or not.
  2. is compatible / links with existing gtsam citations
  3. will citation trackers link different releases to the same citations? I feel like it would be strange to have 10 doi's with 10 citations each that don't get merged into one reference with 100 citations, but idk.

But these are just my personal thoughts. In any case, having an easy "please use this citation", either in text/bibtex/some form would be great.

@varunagrawal
Copy link
Collaborator Author

  1. Zenodo is used by CERN and lots of organizations in the sciences to archive software. GitHub itself endorses it, so I don't think it's going away anytime soon. I wouldn't have suggested using it if it wasn't well-established already.
  2. I believe current citations just use Frank's book? There has never been a citation for the software repo itself (unless you crafted one manually).
  3. Zenodo has something called Concept version which is a DOI to all the versions cumulatively. This should ensure we don't have issues with different versions having different citations. I'll double check and update the PR to ensure this is the case.

@varunagrawal varunagrawal merged commit ba6e91b into develop Aug 9, 2022
@varunagrawal varunagrawal deleted the zenodo branch August 9, 2022 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Update to docs or README without code changes quick-review Quick and easy PR to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add GTSAM citation
2 participants