Deltares / pandamesh

🐼 From geodataframe to mesh ▦
https://deltares.github.io/pandamesh/
MIT License
26 stars 9 forks source link

Citation #11

Open vieirasaulo opened 11 months ago

vieirasaulo commented 11 months ago

Hi there,

How can I cite pandamesh?

Best wishes,

Saulo

Huite commented 11 months ago

Hi @vieirasaulo,

Good question! I have a list of Python packages I should submit to Journal of Open Source Software...

Until then, I think citing like the Dask docs suggest will do:

Dask Development Team (2016). Dask: Library for dynamic task scheduling URL http://dask.pydata.org

Bibtex:

@Manual{,
  title = {Dask: Library for dynamic task scheduling},
  author = {{Dask Development Team}},
  year = {2016},
  url = {http://dask.pydata.org},
}

Along those lines for pandamesh:

Pandamesh Development Team (2023). Pandamesh: Library for mesh generation from geospatial vector data URL https://github.com/Deltares/pandamesh

Bibtex:

@Manual{,
  title = { Pandamesh: Library for mesh generation from geospatial vector data},
  author = {{Pandamesh Development Team}},
  year = {2023},
  url = {https://github.com/Deltares/pandamesh},
}
vieirasaulo commented 11 months ago

Hey, thanks for getting back to me. If I may, I've been citing other packages as @software using Zenodo or PyPI, and was wondering if it would be cool with you to cite it like this:

@software{Deltares2021, author = {Pandamesh Development Team}}, title = {Pandamesh: Library for mesh generation from geospatial vector data}, url = {https://pypi.org/project/pandamesh/}, year = {2023}, note = {Computer Software, \textit{Python Software Foundation}}, publisher = {Python Software Foundation}, organization = {Deltares}, version = {0.1.2}, }

Does that make sense?

Huite commented 11 months ago

Yes, fine by me. I'm just not sure whether the Python Software Foundation is the appropriate publisher. This is true for Python (or specifically CPython), but not for all packages. I think pandamesh is "published" on PyPI, conda, and github.

We could also interpret github as the main published site, and so you could list github as the publisher. That also what one of these answer on stackexchange suggests: https://academia.stackexchange.com/questions/14010/how-do-you-cite-a-github-repository

vieirasaulo commented 11 months ago

Alright, it makes sense. Thanks for the answer!