search

materialsproject / matbench

Matbench: Benchmarks for materials science property prediction
https://matbench.materialsproject.org
MIT License
122 stars 47 forks source link

Citing matbench and automated archival of releases #156

Open ml-evs opened 2 years ago

ml-evs commented 2 years ago

Now there are quite a few papers popping up using the matbench leaderboard, perhaps it would be an idea to promote citation of the data as well as the paper.

I would suggest that every benchmark addition (or general change) increments the version number, and this whole repository gets automatically archived to Zenodo with a citable, versioned DOI.

Adding a CITATION.cff file to this repo would mean that you don't have to edit the Zenodo metadata every release, plus the contributors to the leaderboard for that version could be added to the dataset citation which may encourage more submissions (although software on Zenodo does not get picked up by e.g., CrossRef so it won't visibly enhance people's bibliometrics, if they are into that...).

Happy to help out with this if there is interest!

ardunn commented 2 years ago

I think this is an excellent idea. Realistically I would want some sort of script to do this version updating automatically (i.e., the cff gets checked and optionally updated every time docs are rebuilt). Let me look into this some more. Definitely could use some help sketching things out though!

ml-evs commented 2 years ago

Great! I can a make a PR for the initial cff file and we can go from there? I can also make a separate PR that expands on the citation guidelines in the README, pending archival on Zenodo.