Citing satpy

[leifdenby]

Feature Request

I'd like to cite satpy in a paper I'm writing. Having satpy has been a huge help and improved my work a lot. What should I put as the citation? I had look through the documentation and source code, but couldn't find anything

Describe the solution you'd like
It would be handy with a file called CITATION like pytorch does it. And maybe a mention in the documentation?

[mraspaud]

Welcome @leifdenby, I'm glad you find satpy useful :) This a good idea, although we don't have an article for satpy alone at the moment. But we could add the pytroll one maybe: https://journals.ametsoc.org/doi/full/10.1175/BAMS-D-17-0277.1 ?

[djhoese]

@leifdenby You could also point to the zenodo entry for the software package. It is described here: https://zenodo.org/record/3250583

On this page on the right it mentions that you can use https://doi.org/10.5281/zenodo.596324 to represent all versions of Satpy.

[leifdenby]

Great! Thanks for the quick replies @mraspaud and @djhoese. I'll go with the zenode reference then.

I could create a pull request with a CITATION file containing:

@misc{martin_raspaud_2019_3250583,
  author       = {Martin Raspaud and
                  David Hoese and
                  Panu Lahtinen and
                  Adam Dybbroe and
                  Stephan Finkensieper and
                  William Roberts and
                  Lars Ørum Rasmussen and
                  Simon Proud and
                  Sauli Joro and
                  Rohan Daruwala and
                  Gerrit Holl and
                  Tommy Jasmin and
                  BENR0 and
                  Thomas Leppelt and
                  Ulrik Egede and
                  R.K.Garcia and
                  Mikhail Itkin and
                  LTMeyer and
                  Eysteinn Sigurðsson and
                  Radar, Satellite and Nowcasting Division and
                  Trygve Aspenes and
                  hazbottles and
                  ColinDuff and
                  joleenf and
                  Cody and
                  lorenzo clementi and
                  Marc Honnorat and
                  Hauke Schulz and
                  Bertil Hatt and
                  Antonio Valentino},
  title        = {pytroll/satpy: Version 0.16.0},
  month        = jun,
  year         = 2019,
  doi          = {10.5281/zenodo.3250583},
  url          = {https://doi.org/10.5281/zenodo.3250583}
}

If not someone will find this issue at least for future reference :) Thanks again

P.s. that came from here

[djhoese]

@leifdenby Is this CITATION file standard? I know you mentioned pytorch but I'm wondering if this is used by any service or is standard by some working group?

Otherwise we could follow some of the stuff that came up in the pytorch conversations and add the zenodo badge to the README as mentioned at the bottom of https://guides.github.com/activities/citable-code/

[mraspaud]

The zenodo badge would we really nice, as it doesn't become obsolete

[mraspaud]

@leifdenby, would #833 work for you ?

[mraspaud]

@leifdenby Feel free to reopen this of you need something different :)