Create CITATION.cff

[banesullivan]

This utilizes a nifty feature of GitHub where the citation will be automatically generated in the sidebar:

In a test repo, this looks like:

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

Which renders as:

Sullivan, B., & Kaszynski, A. (2019). PyVista: 3D plotting and mesh analysis through a streamlined interface for the Visualization Toolkit (VTK). Journal of Open Source Software, 4(). https://doi.org/10.21105/joss.01450

@article{Sullivan_PyVista_3D_plotting_2019,
author = {Sullivan, Bane and Kaszynski, Alexander},
doi = {10.21105/joss.01450},
journal = {Journal of Open Source Software},
month = {5},
title = {{PyVista: 3D plotting and mesh analysis through a streamlined interface for the Visualization Toolkit (VTK)}},
url = {https://github.com/pyvista/pyvista},
volume = {4},
year = {2019}
}

These do not perfectly match the citations we have in CITATION.rst which were copied directly from JOSS. Perhaps a JOSS editor could help us make sure this is done right? cc @leouieda

---

Additionally, I updated my name in the citation from "C. Bane Sullivan" to "Bane Sullivan" for consistency and the fact that I want it to forever be a mystery what the C stands for... could be "Cowboy", could be "Coolasacucumber", could be "Charles".... you'll never know, and I plan on keeping it that way.

[codecov]

Codecov Report

Merging #2218 (a3c7747) into main (135fedc) will decrease coverage by 0.06%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2218      +/-   ##
==========================================
- Coverage   93.37%   93.30%   -0.07%     
==========================================
  Files          75       75              
  Lines       15602    15602              
==========================================
- Hits        14568    14558      -10     
- Misses       1034     1044      +10     

[adeak]

Nifty!

If you're worried that the citation gets parsed in a weird way, why not just use the bibtex format? That's what Matplotlib did https://github.com/matplotlib/matplotlib/blob/main/CITATION.bib

I suspect the 4() comes from the missing issue number. The JOSS website displays ... Journal of Open Source Software, 4(37), 1450 where the end is {volume}({number}), {year}. So we can probably change number to issue in the .cff file to hack the right render. Even in the second github example the issue in the .cff file seems to be converted to number in the .bib file.

[banesullivan]

Ah! I totally missed the part that a .bib file could be used instead 🤦🏻‍♂️ thanks for pointing that out @adeak!

Though I think I nailed this in my latest commit... the only thing that is different/left out is the publisher filed when generating the BibTex:

Sullivan, B., & Kaszynski, A. (2019). PyVista: 3D plotting and mesh analysis through a streamlined interface for the Visualization Toolkit (VTK). Journal of Open Source Software, 4(37), 1450. https://doi.org/10.21105/joss.01450

@article{Sullivan_PyVista_3D_plotting_2019,
author = {Sullivan, Bane and Kaszynski, Alexander},
doi = {10.21105/joss.01450},
journal = {Journal of Open Source Software},
month = {May},
number = {37},
pages = {1450},
title = {{PyVista: 3D plotting and mesh analysis through a streamlined interface for the Visualization Toolkit (VTK)}},
url = {https://github.com/pyvista/pyvista},
volume = {4},
year = {2019}
}

[banesullivan]

Opened an issue about the publisher field: citation-file-format/ruby-cff#104

[adeak]

Looks good to me, thanks

[leouieda]

Hey @banesullivan I think this looks good to me. Should get this done for all my projects as well 🙂 Thanks for the inspiration! I'll definitely use this PR as a template.

Are you planning on keeping the Zenodo part up to date with every release?