sgkit icon indicating copy to clipboard operation
sgkit copied to clipboard

Citation

Open fouerghi opened this issue 9 months ago • 4 comments

Hello! I'm not sure if this is already indicated elsewhere, but how do we cite the package?

fouerghi avatar Mar 12 '25 17:03 fouerghi

Hi @fouerghi :wave: Thanks for asking the question, it's not something we've really considered before!

If you're using bio2zarr/vcztools please cite the preprint

We don't have a publication for sgkit itself, and there's no immediate plans to make one, so we should come up with some recommended way of citing sgkit itself.

One approach we might take is to link the repository to Zenodo and then add a citation.cff file? It's slightly annoying that Zenodo issues a new DOI for every release, but I guess that's not so terrible.

@tomwhite any thoughts here?

jeromekelleher avatar Mar 13 '25 09:03 jeromekelleher

One approach we might take is to link the repository to Zenodo and then add a citation.cff file? It's slightly annoying that Zenodo issues a new DOI for every release, but I guess that's not so terrible.

I don't have any experience of doing this, but it looks like Zarr and Xarray both do this (and are both out of date since the DOI is per-release).

tomwhite avatar Mar 13 '25 09:03 tomwhite

It would be nice to get a DOI on every major version bump rather than every point release, that just seems excessive. I don't have much experience with it either, have always gone down the paper route for software that's worth citing.

jeromekelleher avatar Mar 13 '25 09:03 jeromekelleher

Hi guys, just a +1 to this. I have started using sgkit pretty regularly, and it would be great to be able to reference the package so that you get some of those sweet sweet citations. Perhaps even just a super-short note in arXiv if you didn't want to faff around with Zenodo?

tristanpwdennis avatar Jun 02 '25 22:06 tristanpwdennis