CITATION.cff file

[navidcy]

It'd be nice if there was a CITATION.cff file to suggest how people should cite this repo.

[Alexander-Barth]

Thank you for bringing that up. Unfortunately, I do not have a good answer what a citation could be. Maybe I should try to find some time to write a JOSS paper too :-)

[Alexander-Barth]

I had a look at this example:
https://academia.stackexchange.com/a/14015

Maybe you can cite the repo as:

@misc{NCDatasets,
  author = {Alexander Barth},
  title = {NCDatasets: A julia package for manipulating netCDF data sets},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/Alexander-Barth/NCDatasets.jl}},
  commit = {90ed5641684604096558a77020038583e1f2459f}
}

where the commit is the latest released version.

I am also considering to write also a JOSS paper, I would like to cite speedy weather :-) It is ok if I use for now a similar approach?

@misc{SpeedyWeather,
  author = {Milan Klöwer and Maximilian Gelbrecht and Daisuke Hotta and Justin Willmert and Simone Silvestri and Gregory L Wagner and Alistair White and Sam Hatfield and Tom Kimpson and Navid C Constantinou and Chris Hill},
  title = {SpeedyWeather.jl: Reinventing atmospheric general circulation models towards interactivity and extensibility},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/SpeedyWeather/SpeedyWeather.jl/}},
  commit = {90ed5641684604096558a77020038583e1f2459f}
}

Of course, I will replace the citation to SpeedyWeather with the actual JOSS paper (unless there is a timing issue).

hey @milankl I hope you had a good flight back from the Azores :-)

update: I just have seen that you already submitted your JOSS paper; congrats ! :-)

[ctroupin]

you can also add this repository on Zenodo, so you get a DOI for each release.

[milankl]

@Alexander-Barth sorry, only saw this now, yes, please zenodo for the time being and once the JOSS paper is out I'll let you know! If we're supposed to use another citation in between let me know.

[Alexander-Barth]

Thanks @milankl !
I am closing this issue.
A CITATION.cff has been added for future papers :-)