Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add citation metadata in machine-parsable formats #852

Merged
merged 1 commit into from
Jul 4, 2023

Conversation

alvorithm
Copy link
Contributor

This adds two popular citation metadata formats, based on the templates offered by the Astrophysics Source Code Library, see recent entry added for sbi at https://ascl.net/2306.002 (https://ascl.net/2306.002/CITATION.cff, https://ascl.net/2306.002/codemeta.json).

These citation files pertain to the software, but they encourage to cite the paper. There are best practices about citing the software directly that result in nuances in these files (e.g. use of 'preferred citation') that I have not investigated.

The paper citations are encouraged to occur not via the ASCL or the JOSS URLs but as advised by ASCL engineer Alice Allen through the DOI resolver URL.

Finally, note that this PR does not deal with CI updates to this metadata (notably concerning version numbers and release dates). See

@codecov
Copy link

codecov bot commented Jul 3, 2023

Codecov Report

Merging #852 (51d8b41) into main (4e29490) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #852   +/-   ##
=======================================
  Coverage   74.60%   74.60%           
=======================================
  Files          80       80           
  Lines        6238     6238           
=======================================
  Hits         4654     4654           
  Misses       1584     1584           
Flag Coverage Δ
unittests 74.60% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link
Contributor

@janfb janfb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's great, thanks for adding it!

@janfb janfb merged commit 96d65e8 into sbi-dev:main Jul 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants