Skip to content

Commit a42cc93

Browse files
committed
add joss badge and citation
1 parent 3dae9ef commit a42cc93

2 files changed

Lines changed: 35 additions & 8 deletions

File tree

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,15 @@
1313
[ddocs-img]: https://img.shields.io/badge/docs-dev-blue.svg
1414
[ddocs-url]: https://cavenfish.github.io/YetAnotherSimulationSuite.jl/dev/
1515

16+
[joss-img]: https://joss.theoj.org/papers/10.21105/joss.09480/status.svg
17+
[joss-url]: https://doi.org/10.21105/joss.09480
18+
1619
[![][docs-img]][docs-url]
1720
[![][ddocs-img]][ddocs-url]
1821
[![][ci-img]][ci-url]
1922
[![][codecov-img]][codecov-url]
2023
[![][aqua-img]][aqua-url]
21-
24+
[![][joss-img]][joss-url]
2225

2326
<img src="https://github.com/Cavenfish/YetAnotherSimulationSuite.jl/blob/main/docs/src/assets/logo.png" alt="Logo" width=350 >
2427

@@ -105,11 +108,16 @@ YASS is MIT licensed. See [LICENSE](LICENSE) for details.
105108
If you use YASS in your research, please cite:
106109

107110
```bibtex
108-
@misc{yass2023,
109-
author = {Brian C. Ferrari},
110-
title = {YetAnotherSimulationSuite.jl},
111-
year = {2023},
112-
publisher = {GitHub},
113-
url = {https://github.com/Cavenfish/YetAnotherSimulationSuite.jl}
111+
@article{Ferrari2025,
112+
doi = {10.21105/joss.09480},
113+
url = {https://doi.org/10.21105/joss.09480},
114+
year = {2025},
115+
publisher = {The Open Journal},
116+
volume = {10},
117+
number = {116},
118+
pages = {9480},
119+
author = {Ferrari, Brian C.},
120+
title = {YetAnotherSimulationSuite.jl: An Atomic Simulation Suite in Julia},
121+
journal = {Journal of Open Source Software}
114122
}
115123
```

docs/src/index.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,23 @@ Currently, YASS is able to perform the following simulations/calculations on mol
2525

2626
- Geometry optimizations
2727
- Harmonic frequency calculations
28-
- Classical molecular dynamics in the NVE and NVT ensemble
28+
- Classical molecular dynamics in the NVE and NVT ensemble
29+
30+
### Citation
31+
32+
If you use YASS in your research, please cite:
33+
34+
```bibtex
35+
@article{Ferrari2025,
36+
doi = {10.21105/joss.09480},
37+
url = {https://doi.org/10.21105/joss.09480},
38+
year = {2025},
39+
publisher = {The Open Journal},
40+
volume = {10},
41+
number = {116},
42+
pages = {9480},
43+
author = {Ferrari, Brian C.},
44+
title = {YetAnotherSimulationSuite.jl: An Atomic Simulation Suite in Julia},
45+
journal = {Journal of Open Source Software}
46+
}
47+
```

0 commit comments

Comments
 (0)