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

citing em geosci #552

Open
lheagy opened this issue Jan 23, 2019 · 3 comments
Open

citing em geosci #552

lheagy opened this issue Jan 23, 2019 · 3 comments

Comments

@lheagy
Copy link
Member

lheagy commented Jan 23, 2019

We should include a description for how people should cite EM geosci. I suggest we do something similar to astropy which starts the citation with "Astropy collaboration" and then lists all contributors. Listing contributors is a bit of a question, but on option is to list all who have contributed on github as authors. Note that we should first get permission from everyone. If we treat it like a book, then we can also reference editors if that makes sense? The doi is then the doi from zenodo.

Thoughts?

@thast
Copy link
Member

thast commented Feb 6, 2019

Some thoughts: Scikit-Learn chose to also include quite a number of contributors as Authors:
@Article{scikit-learn,
title={Scikit-learn: Machine Learning in {P}ython},
author={Pedregosa, F. and Varoquaux, G. and Gramfort, A. and Michel, V.
and Thirion, B. and Grisel, O. and Blondel, M. and Prettenhofer, P.
and Weiss, R. and Dubourg, V. and Vanderplas, J. and Passos, A. and
Cournapeau, D. and Brucher, M. and Perrot, M. and Duchesnay, E.},
journal={Journal of Machine Learning Research},
volume={12},
pages={2825--2830},
year={2011}
}

@thast
Copy link
Member

thast commented Feb 6, 2019

So here is a proposal. As for author, after the main leaders for the DISC (Doug, Lindsey and Seogi), I have listed every person that have commit to the website, by order of quantitative contribution. For the year, I chose the year of first online publication (2015):

@misc{EMGeoSci, author = {Douglas W. Oldenburg and Lindsey J. Heagy and Seogi Kang and Devin C. Cowan and Dominique Fournier and Thibaut Astic and Sarah Devriese and Dikun Yang and Sanna Tyrväinen and Ronghua Peng and Patrick Belliveau and Luz Ang{\'e}lica Caudillo-Mata and Daniel Bild-Enkin and Mike McMillan and Gu{\~d}ni Karl Rosenkj{\ae}r and Rowan Cockett and Michael Mitchell}, title = {E{M} {G}eo{S}ci: A online textbook for electromagnetic geophysics}, url = {https://em.geosci.xyz}, howpublished = {\url{https://em.geosci.xyz}}, urldate = {2019-02-01}, doi = {10.5281/zenodo.2548027}, year = {2015}, note = {Accessed: 2019-02-01}, }

Output:
Oldenburg, D. W., Heagy, L. J., Kang, S., Cowan, D. C., Fournier, D., Astic, T., Devriese, S., Yang, D., Tyrväinen, S., Peng, R., Belliveau, P., Caudillo-Mata, L. A., Bild-Enkin, D., McMillan, M., Rosenkjær, G. K., Cockett, R., & Mitchell, M., 2015. EM GeoSci: A online textbook for electromagnetic geophysics, https://em.geosci.xyz, Accessed: 2019-02-01

Optionally there is the decorator @online but it did not worked well for me.

@lheagy
Copy link
Member Author

lheagy commented Feb 7, 2019

Thanks @thast this looks good. The only other thing I would suggest we consider is that the first author be "GeoSci.xyz Project".

e.g.

@misc{EMGeoSci,
 author = {{GeoSci.xyz Project} and Douglas W. Oldenburg and Lindsey J. Heagy and
 Seogi Kang and Devin C. Cowan and Dominique Fournier and
 Thibaut Astic and Sarah Devriese and Dikun Yang and
 Sanna Tyrväinen and Ronghua Peng and Patrick Belliveau and
 Luz Ang{\'e}lica Caudillo-Mata and Daniel Bild-Enkin and Mike McMillan
 and Gu{\~d}ni Karl Rosenkj{\ae}r and Rowan Cockett and Michael Mitchell},
 title = {E{M} {G}eo{S}ci: A online textbook for electromagnetic geophysics},
 url = {https://em.geosci.xyz},
 howpublished = {\url{https://em.geosci.xyz}},
 urldate = {2019-02-01},
 doi = {10.5281/zenodo.2548027},
 year = {2015},
 note = {Accessed: 2019-02-01},
}

Both Astropy and Jupyter do this - then in citations it is (GeoSci.xyz Project et al., 2015). I like this as it leaves room for future contributors to be acknowledged as a part of the project, as well as people who may not have directly contributed on GitHub but helped with text etc.

What do you think about this? cc @dougoldenburg

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

No branches or pull requests

2 participants