cms-analysis / HiggsAnalysis-CombinedLimit

CMS Higgs Combination toolkit.
https://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/latest
Apache License 2.0
75 stars 383 forks source link

Consider using CITATION.cff for making citation easier #942

Open matthewfeickert opened 5 months ago

matthewfeickert commented 5 months ago

https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/blob/4e53fc18d6348a41a71a0a46a3dda2769c0958cb/README.md?plain=1#L13

If you use a CITATION.cff file this makes it easier to communicate to people and programs how to cite software and associated papers.

c.f.:

nucleosynthesis commented 5 months ago

Thanks, it's a nice idea. Within CMS, we use a very specific format for the citation (which is what is currently in the README) for CMS publications so as long as the converters handle that it's fine. I would leave the citation as it is on the docs pages however

matthewfeickert commented 5 months ago

You control the information that is in the citation file, so it should be reproducible.

nucleosynthesis commented 5 months ago

The point is that users should cite the publication, and only the publication. It seems like it might be possible to use the various fields in the online creator to yield the same information, but on a first try it doesn't seem like it was really intended for this purpose.

If you would consider proposing a CITATION.cff based on : https://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/latest/#citation. that would be extremely helpful (though it will be updated once the paper is published).