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

How to cite h5py? #743

Open
sliem opened this issue Jul 31, 2016 · 12 comments · May be fixed by #2393
Open

How to cite h5py? #743

sliem opened this issue Jul 31, 2016 · 12 comments · May be fixed by #2393

Comments

@sliem
Copy link

sliem commented Jul 31, 2016

I'm writing a paper and I would like to cite h5py but could not find the prefered way to do that. I did found an old Google group conversation pointing to a defunct website.

How should I cite h5py?

@andreabedini
Copy link
Contributor

Nothing is ever deleted on the internet! https://web.archive.org/web/20121225230132/http://code.google.com/p/h5py/wiki/FAQ

This made me think, should we arrange a way to get a DOI for h5py? https://guides.github.com/activities/citable-code/. Ping @andrewcollette. I have done this for a couple of my repos.

@aragilar
Copy link
Member

aragilar commented Aug 1, 2016

There's http://joss.theoj.org/ which is more "papery" than Zenodo/Figshare, which may or may not be useful. Depsy is also a thing.

@andreabedini
Copy link
Contributor

thanks for the links @aragilar, I knew depsy but not joss.

@pdebuyl
Copy link
Contributor

pdebuyl commented Sep 7, 2016

Alternatively

@Book{collette_python_hdf5_2014,
        keywords = {python, hdf5},
        year = {2013},
        publisher = {O'Reilly},
        title = {Python and HDF5},
        author = {Andrew Collette}
}

I used the book citation recently https://arxiv.org/abs/1608.04904 and it seemed a reasonable choice.

Given that h5py hsa its own domain http://www.h5py.org/, that is also a stable citation point.

But @andrewcollette might have an opinion.

@yarikoptic
Copy link
Contributor

For the majority of the projects I am involved with, regardless either there is some proper article (JOSS is IMHO a good venue) we link to zenodo to mint dois for every release. So I would strongly recommend zenodo as a quick and cheap solution until some ultimate citation appears, which would take some time regardless of the chosen publication venue.

@Helveg
Copy link
Contributor

Helveg commented Oct 18, 2022

Any update here? What to cite? :)

@kif
Copy link
Contributor

kif commented Oct 18, 2022

@Helveg
Copy link
Contributor

Helveg commented Oct 18, 2022

I guess whoever has the authority to decide this is the way to cite h5py could describe it in the docs (most scientific Python packages do this, cfr "citing numpy", "citing scipy", "citing mpi4py" Google results) and close this issue then :]

@pdebuyl
Copy link
Contributor

pdebuyl commented Oct 19, 2022

It's a long time since I contributed, so I don't know who maintains the project and would be able to provide a clear answer. A citing section in the doc would be nice to have indeed.

@pdebuyl
Copy link
Contributor

pdebuyl commented Oct 19, 2022

To contribute something more constructive, I propose possible citation points.

  • Andrew Collette's book. Does not reflect current h5py development. Simple to cite.
  • The website www.h5py.org . Does not play nice with citations. Requires little work.
  • A zenodo "dump" of the code. Datacite citations not as easy as crossref ones. Requires little work.
  • A dedicated article (such as JOSS). Requires some work. Simple to cite.

The comments are not a definitive judgement of the different solutions but a starting point for selecting something.

@erikhuck
Copy link

@pdebuyl I opened a pull request for this issue that provides your proposed text in a standard CITATION file. I hope that will at least begin to get this 8 year old issue taken care of.

@pdebuyl
Copy link
Contributor

pdebuyl commented Mar 11, 2024

Hello @erikhuck this is a good idea. As you mention in the PR what is needed is for the maintainers to pick a method. Is there any interest in this @takluyver @tacaswell @aragilar (hoping to have selected appropriately :-) )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
8 participants