search

ziotom78 / Healpix.jl

Healpix library written in Julia
GNU General Public License v2.0
51 stars 18 forks source link

Add bibtex or reference for citation purposes #65

Closed hsgg closed 2 years ago

hsgg commented 3 years ago

Hi, do you have a paper, bibtex file, arXiv link, or similar that I can use to cite Healpix.jl? I think that would be very useful for making it easy to properly credit the work you are doing.

ziotom78 commented 3 years ago

Hi @hsgg, thanks for having opened this issue and sorry for my late reply. I was discussing this very matter with @xzackli not long ago, and our initial idea was to submit a short paper to the Journal of Open Source Software (JOSS): in this way we might end with a DOI number and a careful review of the package installation and documentation.

However, I have checked JOSS rules, and Healpix.jl might be out of scope. Specifically, the JOSS guidelines state that «JOSS publishes articles about software that represent substantial scholarly effort on the part of the authors.» I am not sure that this package qualifies, as nearly all the functions implemented (apart from plotting) are derived from the C/C++ codebase.

Perhaps the best thing to do is to register this package in the Astrophysic Source Code Library (ASCL), as this would provide a DOI with no need to write papers. What's your opinion?

hsgg commented 3 years ago

Both JOSS and ASCL would certainly satisfy my desire (they are both in ads). However, I am not very familiar with either.

In my estimation the JOSS submission may indeed be out of scope. Would probably require something like running on GPUs or so. (But I think that might be more for libsharp?)

ziotom78 commented 3 years ago

Would probably require something like running on GPUs or so. (But I think that might be more for libsharp?)

I agree. Consider that Healpix 3.0 has the potential to keep maps on GPUs, thanks to @xzackli's pull request #26, but so far nobody has reported noteworthy applications or results.

I'll go with the ASCL route; this does not prevent us submitting a paper to JOSS later, but at least we fix this issue quickly.

lbenet commented 3 years ago

Is there any progress in the ASCL submission?

ziotom78 commented 3 years ago

Just yesterday I received an email from Alice Allen saying that she registered our package, its code is ascl:2109.028 (see the webpage). The reason why it took so long is that they could not find any reference to it in any published paper; at the end she was convinced because of the existence of this very GitHub issue.

I already changed the README with proper citing information, but I have not pushed it because I see that the ADS link is not working yet; the link is important because it provides the actual BibTeX entry to use in citations. However, I realized that for the moment I can create a PR and guessing up how the final BibTeX will look like; will merge it when ADS gets updated.

ziotom78 commented 3 years ago

Here is the link to the new section in the README: Citing Healpix.jl, which will appear in the front page once PR #66 is merged.

lbenet commented 3 years ago

Thanks a lot!

ziotom78 commented 2 years ago

It seems that Healpix.jl is now online on ADS: https://ui.adsabs.harvard.edu/abs/2021ascl.soft09028T/abstract

Once I get back to my laptop I'll update PR #66 and merge it.