-
Notifications
You must be signed in to change notification settings - Fork 767
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
Added *.bib file and started adding citations to README.md #789
Conversation
README.md
Outdated
|
||
## GTSAM Citation | ||
|
||
Use the following to cite GTSAM: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
?
references.bib
Outdated
@@ -0,0 +1,9 @@ | |||
@misc{gtsam, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add the main papers as well? See my publications page, also include the IMU pre-integration papers.
Okay so #581 is irrelevant to this PR. @njayakumar3 can you please finish this up? Would love to get this merged in. |
Did we need to link this with Zenodo first? |
Nope. Zenodo is tangential. |
Papers being added: Should iSAM papers be added? Any others to add? |
Those two should be enough for now. We can add more later as needed since I want you to land this PR @njayakumar3 :) |
Just making sure before I push the updates, I am creating Bibtex citations for the mentioned papers in the README for others' use, correct? Not citing the papers in the README? |
Hi @njayakumar3, yes you are correct. We'd like to have citations that others can copy and paste into their own bibtex managers or papers. |
README.md
Outdated
title={IMU preintegration on Manifold for Efficient Visual-Inertial Maximum-a-Posteriori Estimation}, | ||
year={2015} | ||
} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please delete this extra space.
publisher={Foundations and Trends in Robotics, Vol. 6}, | ||
url={http://www.cs.cmu.edu/~kaess/pub/Dellaert17fnt.pdf} | ||
} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please delete this extra space.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this looks great other than the request to remove extra empty lines.
README.md
Outdated
|
||
``` | ||
@software{gtsam, | ||
author = {Frank Dellaert and Richard Roberts and Varun Agrawal and Alex Cunningham and Chris Beall and Duy-Nguyen Ta and Fan Jiang and lucacarlone and nikai and Jose Luis Blanco-Claraco and Stephen Williams and ydjian and John Lambert and Andy Melim and Zhaoyang Lv and Akshay Krishnan and Jing Dong and Gerry Chen and Krunal Chande and balderdash-devil and DiffDecisionTrees and Sungtae An and mpaluri and Ellon Paiva Mendes and Mike Bosse and Akash Patel and Ayush Baid and Paul Furgale and matthewbroadwaynavenio and roderick-koehle}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am ready to merge this PR but there are github usernames in here. I propose to change in README to {Frank Dellaert and GTSAM Contributors}. I know this is grandiose of me, but it will render well in a paper ([Dellaert et. al 2022] as opposed to [GTSAM Contributors, 2022]) and I think it accurately reflects my 10 years of constancy in this project.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's fair. Projects like TensorFlow have a similar laundry list of authors, so I didn't think this was wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also with just 2 names, {Frank Dellaert and GTSAM Contributors}, it won't render as Dellaert et. al.
, rather as Dellaert & Contributors
. Hopefully that works.
README.md
Outdated
title = {borglab/gtsam}, | ||
month = may, | ||
year = 2022, | ||
publisher = {Zenodo}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would change to
publisher = {Georgia Tech Borg Lab}
version = {4.2a8},
url = {https://github.com/borglab/gtsam)},
README.md
Outdated
} | ||
``` | ||
|
||
You can also get the latest citation available from Zenodo below: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd remove reference to Zenodo. It does not seem do useful because of the username issue?
@dellaert please approve and merge at will. @njayakumar3 thank you for your contribution. :) |
Added bibtex for the citations.