chore: improve CITATION.cff and add codemeta.json for FAIR4RS compliance#279
Open
siligam wants to merge 3 commits into
Open
chore: improve CITATION.cff and add codemeta.json for FAIR4RS compliance#279siligam wants to merge 3 commits into
siligam wants to merge 3 commits into
Conversation
- CITATION.cff: add type, abstract, version, license, repository-code, keywords; fix message to reference pycmor instead of ESM-Tools - codemeta.json: new file with full CodeMeta 2.0 metadata including authors with ORCIDs, DOI, keywords, programming language, and funder
Adds the Software Heritage snapshot identifier (swh:1:snp:e4d5216be639a8e2dd2be23be1e78981de3fc67d) captured 2026-06-16 to both machine-readable metadata files: - CITATION.cff: via the identifiers field (type: swh, CFF v1.2.0) - codemeta.json: expands identifier to array of PropertyValues (doi + swh)
- GitHub Actions workflow triggers SWH save on every published release and appends a reminder to the release notes - Release checklist issue template includes SWHID update as a required step - scripts/update_swhid.py fetches the latest snapshot SWHID from the SWH API and patches CITATION.cff and codemeta.json in-place
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improves software citation metadata to better comply with FAIR4RS principles and prepares for listing in the Helmholtz Research Software Directory (RSD).
CITATION.cff
messageto reference pycmor specifically (was: "ESM-Tools software")type: softwareabstract— concise description of what pycmor doesversion: 1.0.2license: MITrepository-code(distinct fromurlwhich now points to the docs)keywords(CMOR, CMORization, CMIP6, CMIP7, climate, NetCDF, CF-conventions, WCRP, etc.)codemeta.json (new file)
Why
These metadata files are machine-readable and picked up by:
Good citation metadata directly supports discoverability and reuse — core FAIR4RS goals.