Add CITATION.cff in Citation File Format
Description
During the JOSS paper review, one of the reviewers suggested adding information on how to cite DORiE. They suggested Citation File Format and CodeMeta data. I think a Citation File Format CITATION.cff
file would suit our needs perfectly, see the format specification. It allows specifying metadata on the software as well as adding a list of references. Using a Python converter, the CFF file can be converted into Bibtex and also CodeMeta files.
Proposal
Add a CITATION.cff
file to the repository. The top-level metadata should identify the latest release version of DORiE. When new versions are released, the earlier releases can be moved to the references
section. Add the JOSS paper to the references
. It is already citable via a DOI.
Mention the CITATION.cff
in the README.md
.
Add instructions on when/how to update the CITATION.cff
CITATION.cff
Draft for cff-version: 1.1.0
message: "If you use this software, please at least cite the JOSS publication referenced below."
authors:
# Authors list
title: "DORiE -- The DUNE-Operated Richards Equation Solving Environment"
version: 2.0.0
date-released: 2020-05-14
doi: # DOI of Zenodo repo
references:
- type: article
title: "DORiE: A discontinuous Galerkin solver for soil water flow and passive solute transport based on DUNE"
authors:
# Paper authors
doi: # Paper DOI
How to test the implementation?
- There seems to be a validator for CFF files, but I could not find it yet (link is missing from the CFF homepage).
- Use the CFF file converter to create Bibtex files in a CI job (or is that too elaborate?).
Related issues
See the original proposal.