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

Citation #1293

Open
fouerghi opened this issue Mar 12, 2025 · 3 comments
Open

Citation #1293

fouerghi opened this issue Mar 12, 2025 · 3 comments

Comments

@fouerghi
Copy link

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

@jeromekelleher
Copy link
Collaborator

Hi @fouerghi 👋 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?

@tomwhite
Copy link
Collaborator

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).

@jeromekelleher
Copy link
Collaborator

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.

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

No branches or pull requests

3 participants