search

glass-dev / glass

Generator for Large Scale Structure
https://glass.readthedocs.io
MIT License
35 stars 9 forks source link

Change `CITATION.md` to `CITATION.cff` #175

Closed paddyroddy closed 1 month ago

paddyroddy commented 2 months ago

It's a dedicated file format designed to promote code as research https://citation-file-format.github.io, but can also promote papers using the preferred syntax

ntessore commented 2 months ago

I don't find .cff files at all useful, since no one in our field would know what to do with them. Let's do a .bib file with bibtex from ADS: https://ui.adsabs.harvard.edu/abs/2023OJAp....6E..11T/exportcitation

Saransh-cpp commented 2 months ago

The .cff format will enable copy-pastable citation in a dropdown menu on github, offering both APA and BibTex formats -

image

This has become a standard for software citations, but I'll also be happy to convert the .md file to a .bib file.

ntessore commented 2 months ago

That's pretty cool, but I would rather not lose the extra metadata from the ADS entry,

Saransh-cpp commented 2 months ago

Oh I see, .bib sounds good then!

paddyroddy commented 2 months ago

The .cff format will enable copy-pastable citation in a dropdown menu on github, offering both APA and BibTex formats -

image

This has become a standard for software citations, but I'll also be happy to convert the .md file to a .bib file.

Wouldn't a CITATION.cff, which only refers to the paper, be useful to benefit from this GitHub feature? An easy way to get a citation that you might not get otherwise. Can always also include a paper citation in the README like this.

Saransh-cpp commented 1 month ago

Having a BibTex entry in the README and a .cff file to enable GitHub's feature sounds better imo. PyBaMM (BibTex in README, .cff file for GitHub) does the same too. I'll reopen this issue for more discussion.

paddyroddy commented 1 month ago

Discussed in meeting and will adapt to CITATION.cff