Add pyOpenSci citation to GitHub profile description

[akhilkrishnar0]

Hi,​

I noticed that while pyOpenSci has a formal citation:​

Trizna, M., Wasser, L., & Nicholson, D. (2021). pyOpenSci: Open and reproducible research, powered by Python. Biodiversity Information Science and Standards, 5, e75688. https://doi.org/10.3897/biss.5.75688​

this citation isn't included in the GitHub profile description.​

Including this citation in the profile description would:​

Enhance visibility of the citation.

Make it easier for users to properly cite pyOpenSci in their work.

Highlight the academic recognition of the project.​

I believe this small addition could be beneficial for both the community and the project's contributors.

[coatless]

Are you looking for this to be added here:

https://github.com/pyOpenSci/software-submission/blob/main/README.md

Or in its own CITATION file on this repository?

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

Or should we incorporate this into the peer review guide?

https://www.pyopensci.org/software-peer-review/index.html

Though, this already has a zenodo DOI: https://zenodo.org/records/7101778

[akhilkrishnar0]

Yes, the second option, creating a CITATION.cff file in the root of the software-submission repository — would be ideal, as it allows GitHub to automatically display a citation widget in the sidebar (e.g., see pandas-dev/pandas).

Additionally, it would be also beneficial to include a brief “Citation” section in the README.md to make the reference more visible to users browsing the repository.

[lwasser]

hey there @akhilkrishnar0 @coatless thank you for this issue. we have a standing open issue here: pyOpenSci/handbook#112 based on this issue

pyOpenSci/handbook#73

Regarding how to cite pyOpenSci. My one concern with the citation you have selected is it's a very old citation that was presented prior to pyOpenSci having the structure that we have now. with that said, i'm not sure what citation is the most appropriate to use for an organization

I'm wondering if one of the talks I gave more recently is a better fit for citing pyOpenSci. There are here in our Zenodo community:

https://zenodo.org/communities/pyopensci/records?q=&l=list&p=2&s=10&sort=newest

what do you all think?

[akhilkrishnar0]

Hi @lwasser
You're absolutely right, and thank you for pointing that out!
I do have a small doubt though — is it possible (or appropriate) to cite both the older publication and the recent talk. I’m not entirely sure how that’s typically handled.

Also, apologies for missing the issues pyOpenSci/handbook#112 and pyOpenSci/handbook#73 — thanks for linking them!

[lwasser]

No worries at all! I wouldn't expect you to look at every repository that we have to find open issues :)

Are you on our Slack? We are discussing this in a short thread. Someone suggested using https://ror.org/about/ is more appropriate than an actual citation, given we are an organization with many moving parts. But a ROR identifier would be a unique identifier for our org atleast.

Can people cite an organization using a ROR? @coatless do you know by chance? This is uncharted territory for me!

[coatless]

ROR is new to me. Maybe someone from/leading the RSE community on Slack could further elaborate?