From 56b126a7a471a94c2f4516032b5187bc777ce561 Mon Sep 17 00:00:00 2001 From: puerling Date: Thu, 17 Oct 2024 17:30:04 +0200 Subject: [PATCH] README: make Zenodo reference more visible --- README.md | 8 +++---- docs/REFERENCE.md | 53 +++++++++++++++++++++++++++++++++-------------- 2 files changed, 40 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index f421c22ec..d6aa587bc 100644 --- a/README.md +++ b/README.md @@ -16,15 +16,13 @@ SPIRIT | master: | ![CI](https://github.com/spirit-code/spirit/workflows/CI/badge.svg?branch=master) | [![Coverage Status](https://coveralls.io/repos/github/spirit-code/spirit/badge.svg?branch=master)](https://coveralls.io/github/spirit-code/spirit?branch=master) | [![Coverage Status](https://codecov.io/gh/spirit-code/spirit/branch/master/graph/badge.svg)](https://codecov.io/gh/spirit-code/spirit/branch/master) | | develop: | ![CI](https://github.com/spirit-code/spirit/workflows/CI/badge.svg?branch=develop) | [![Coverage Status](https://coveralls.io/repos/github/spirit-code/spirit/badge.svg?branch=develop)](https://coveralls.io/github/spirit-code/spirit?branch=develop) | [![Coverage Status](https://codecov.io/gh/spirit-code/spirit/branch/develop/graph/badge.svg)](https://codecov.io/gh/spirit-code/spirit/branch/develop) | -**[Python package](https://pypi.org/project/spirit/):** [![PyPI version](https://badge.fury.io/py/spirit.svg)](https://badge.fury.io/py/spirit) - - -  +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7261158.svg)](https://doi.org/10.5281/zenodo.7261158) +[![PyPI version](https://badge.fury.io/py/spirit.svg)](https://badge.fury.io/py/spirit) The code is released under [MIT License](LICENSE.txt).
If you intend to *present and/or publish* scientific results or visualisations for which you used Spirit, -please cite [`G. P. Müller et al., Phys. Rev. B 99, 224414 (2019)`](https://link.aps.org/doi/10.1103/PhysRevB.99.224414) and read the [docs/REFERENCE.md](docs/REFERENCE.md). +please cite both the spirit paper [`G. P. Müller et al., Phys. Rev. B 99, 224414 (2019)`](https://link.aps.org/doi/10.1103/PhysRevB.99.224414) and the (version-independent) Zenodo entry [`DOI: 10.5281/zenodo.7261158`](https://doi.org/10.5281/zenodo.7261158). For details, please refer to the [docs/REFERENCE.md](docs/REFERENCE.md). **This is an open project and contributions and collaborations are always welcome!!** See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) on how to contribute or write an email to moritz.sallermann@rwth-aachen.de or t.puerling@fz-juelich.de
diff --git a/docs/REFERENCE.md b/docs/REFERENCE.md index 53db99dcc..7ec5dcd48 100644 --- a/docs/REFERENCE.md +++ b/docs/REFERENCE.md @@ -1,27 +1,48 @@ # Reference The **Spirit** framework is a scientific project. -If you present and/or publish scientific results or -visualisations that used Spirit, you should add a reference. - +If you present and/or publish scientific results or visualizations that used **Spirit**, please always cite [the Spirit paper](https://journals.aps.org/prb/abstract/10.1103/PhysRevB.99.224414), the (version-independent) Zenodo entry for **Spirit**, and mention the version. When referring to **Spirit** as a scientific project. + + @article{spiritPaper, + title = {Spirit: Multifunctional framework for atomistic spin simulations}, + author = {M\"uller, Gideon P. and Hoffmann, Markus and Di\ss{}elkamp, Constantin and Sch\"urhoff, Daniel and Mavros, Stefanos and Sallermann, Moritz and Kiselev, Nikolai S. and J\'onsson, Hannes and Bl\"ugel, Stefan}, + journal = {Phys. Rev. B}, + volume = {99}, + issue = {22}, + pages = {224414}, + numpages = {16}, + year = {2019}, + month = {Jun}, + publisher = {American Physical Society}, + doi = {10.1103/PhysRevB.99.224414}, + url = {https://link.aps.org/doi/10.1103/PhysRevB.99.224414} + } -### The Framework +If you used **Spirit** to produce scientific results, please cite + + @misc{spiritCode, + author = {Müller, G. P. and Hoffmann, M. and Disselkamp, C. and Schürhoff, D. and Mavros, S. and Sallermann, M. and Kiselev, N. S. and Jónsson, H. and Blügel, S.}, + title = {{SPIRIT}}, + month = jan, + year = 2021, + publisher = {Zenodo}, + doi = {10.5281/zenodo.7261158}, + url = {https://doi.org/10.5281/zenodo.7261158}, + howpublished = {Zenodo} + } -If you used Spirit to produce scientific results or when referring to it as a -scientific project, please cite [the paper](https://journals.aps.org/prb/abstract/10.1103/PhysRevB.99.224414). +You may need to update the DOI and Zenodo URL to the specific version you were using. - \bibitem{mueller_spirit_2019}{ - G. P. Müller, M. Hoffmann, C. Disselkamp, D. Schürhoff, S. Mavros, M. Sallermann, N. S. Kiselev, H. Jónsson, S. Blügel. - "Spirit: Multifunctional framework for atomistic spin simulations." - Phys. Rev. B \textbf{99}, 224414 (2019) - } +### Source Code -When referring to code of this framework please add a reference to our GitHub page. +When referring to specific sections of code you may also reference our GitHub page. You may use e.g. the following TeX code: - \bibitem{spirit} - {Spirit spin simulation framework} (see spirit-code.github.io) - + @misc{spiritWeb, + author = {}, + title = {{Spirit spin simulation framework}}, + howpublished = {\url{https://spirit-code.github.io}} + } ### Specific Methods @@ -90,4 +111,4 @@ You may use e.g. the following TeX code: --- -[Home](Readme.md) \ No newline at end of file +[Home](README.md)