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 information #240

Merged
merged 10 commits into from
Jul 22, 2024
Merged

Add citation information #240

merged 10 commits into from
Jul 22, 2024

Conversation

adamltyson
Copy link
Member

@adamltyson adamltyson commented Jul 17, 2024

This PR:

  • Adds a citation CFF file
  • Adds a citation section to the readme
  • Adds a DOI badge
  • Adds citation sentence to website

I've tried to make this as simple as maintain as possible. The DOI is the "general" one that represents all versions, and will resolve to the latest one. I've also kept version numbers out of it.

In terms of authors, I just used everyone who had contributed to the software, in the order suggested by Zenodo. The final publication may be different to this, but it seemed a good place to start. I suggest we don't try to hyper-optimise this, and just include everyone. The only maintenance needed will be to add new authors to this list as and when needed. Unfortunately this is in three places, but not sure if that's an issue?

I plonked the citation info on the index page of the website. It could go under "community", but I think we want it to be a bit more obvious than that?

Closes #232

@adamltyson adamltyson requested a review from niksirbi July 17, 2024 10:45
@adamltyson adamltyson marked this pull request as draft July 17, 2024 10:47
@adamltyson adamltyson marked this pull request as ready for review July 17, 2024 10:53
Copy link

codecov bot commented Jul 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.71%. Comparing base (b27d7a2) to head (0f3eaf1).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #240   +/-   ##
=======================================
  Coverage   99.71%   99.71%           
=======================================
  Files          13       13           
  Lines         702      702           
=======================================
  Hits          700      700           
  Misses          2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@niksirbi niksirbi left a comment

Choose a reason for hiding this comment

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

It all looks good, I made a few changes:

  • I validated the cff file via cffinit and discovered that some fields were invalid, or only valid for specific versions. I've rectified these and I've added more info to the .cff file (e.g. keywords, in case it helps with discoverability).
  • I've deleted the 2nd "2024" from the citation sentence, because zenodo populated that from the release date field, which according to the cff spec is version-specific, so I've removed it.
  • I used the include directive to directly fetch the citation sentence from README, to be included in index.md. So we have to update 2 places instead of 3.
  • I noticed that the author list in pyproject.toml included only me and Chang Huan (because I hadn't touched it in ages). I don't know whether it's important to have the same authors there and in the cff, but probably not. I took the liberty of adding @sfmig there, because I'd say she's as much part of the core dev team as we two are.

CITATION.CFF Outdated Show resolved Hide resolved
Copy link

sonarcloud bot commented Jul 18, 2024

@niksirbi niksirbi added this pull request to the merge queue Jul 22, 2024
Merged via the queue into main with commit 292a374 Jul 22, 2024
27 checks passed
@niksirbi niksirbi deleted the citation branch July 22, 2024 08:36
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.

Archive on zenodo & add citation instructions
2 participants