usnistgov / pfhub

The CHiMaD Phase Field Community Website
https://pages.nist.gov/pfhub
Other
49 stars 40 forks source link

Start versioning benchmark specificiation notebooks using Zenodo DOI #1515

Open wd15 opened 1 year ago

wd15 commented 1 year ago

Ideas here is to use the Zenodo versioning to version our benchmarks rather than use our arbitrary fallible system. We submit each notebook to Zenodo and then update the same series of data with the new notebook when changes are made. Each version of the notebook will have a DOI and also there will be a DOI associated with all the versions.

The submission schema in pfhub-schema should point at the version DOI as well as having human readable benchmark number + zenodo version number. Benchmark versions are 1a.zenodo_doi, but mostly referred to as 1a for example. Get rid of the 1a.0 1a.1 etc. It's just confusing for people

Authors should be based on those that have edited the notebook and had names on the paper associated with the benchmark.

How to cite this benchmark should be at the top of each benchmark notebook

wd15 commented 1 year ago

@tkphd: what do you think?

tkphd commented 1 year ago

Sounds like a better approach than we're currently using. I like it!