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

Add citation info #322

Merged
merged 4 commits into from
Sep 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
cff-version: 1.2.0
message: >-
If you use this software, please cite it using the
metadata from this file.
repository-code: 'https://github.com/spglib/spglib'
preferred-citation:
title: >-
$\texttt{Spglib}$: a software library for crystal symmetry
search
authors:
- given-names: Atsushi
family-names: Togo
- given-names: Isao
family-names: Tanaka
type: misc
doi: 10.48550/arXiv.1808.01590
year: 2018
archivePrefix: arXiv
primaryClass: cond-mat.mtrl-sci
references:
- authors:
- given-names: Kohei
family-names: Shinohara
- given-names: Atsushi
family-names: Togo
- given-names: Isao
family-names: Tanaka
type: article
title: Algorithms for magnetic symmetry operation search and identification of magnetic space group from magnetic crystal structure
journal: Acta Cryst. A
year: 2023
volume: 79
number: 5
pages: 390--398
month: Sep
doi: 10.1107/S2053273323005016
url: https://doi.org/10.1107/S2053273323005016
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@ C library for finding and handling crystal symmetries

- [Spglib](#spglib)
- [What does Spglib do?](#what-does-spglib-do)
- [Requirements](#requirements)
- [How to use Spglib](#how-to-use-spglib)
- [How install the python library](#how-install-the-python-library)
- [How to manually compile](#how-to-manually-compile)
- [How to run test](#how-to-run-test)
- [How to cite Spglib](#how-to-cite-spglib)
- [Contributing](#contributing)
- [Documentation](#documentation)

Expand Down Expand Up @@ -130,6 +132,41 @@ $ ctest --test-dir ./build
Additionally, there are python tests that cover more use-cases.
See the [README](python/README.rst) in the python folder for more details

## How to cite Spglib

If you use spglib in your research, please consider citing the following work:

- [Atsushi Togo and Isao Tanaka, Spglib: a software library for crystal symmetry search, arXiv:1808.01590 (2018)](https://arxiv.org/abs/1808.01590)

```
@misc{spglibv1,
Author = {Atsushi Togo and Isao Tanaka},
Title = {$\texttt{Spglib}$: a software library for crystal symmetry search},
Eprint = {arXiv:1808.01590},
howpublished = {\url{https://github.com/spglib/spglib}},
year = {2018}
}
```

If you use functions to search for magnetic symmetry operations in spglib, please also consider citing the following work:

- [Kohei Shinohara, Atsushi Togo, and Isao Tanaka, Algorithms for magnetic symmetry operation search and identification of magnetic space group from magnetic crystal structure, Acta Cryst. A 79, 390-398 (2023)](https://onlinelibrary.wiley.com/iucr/doi/10.1107/S2053273323005016) (open access)

```
@article{spglibv2,
author = "Shinohara, Kohei and Togo, Atsushi and Tanaka, Isao",
title = "{Algorithms for magnetic symmetry operation search and identification of magnetic space group from magnetic crystal structure}",
journal = "Acta Cryst. A",
year = "2023",
volume = "79",
number = "5",
pages = "390--398",
month = "Sep",
doi = {10.1107/S2053273323005016},
url = {https://doi.org/10.1107/S2053273323005016},
}
```

## Contributing

We welcome any contribution from the core development of the library to documentation
Expand Down
Loading