Skip to content

Commit f303848

Browse files
authored
Add citation info (#119)
1 parent 3fac177 commit f303848

File tree

2 files changed

+35
-2
lines changed

2 files changed

+35
-2
lines changed

README.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,32 @@ Having a problem with torch-pme? Please let us know by `submitting an issue
6363
Submit new features or bug fixes through a `pull request
6464
<https://github.com/lab-cosmo/torch-pme/pulls>`_.
6565

66+
.. marker-cite
67+
68+
Reference
69+
---------
70+
71+
If you use *torch-pme* for your work, please read and cite our preprint available on
72+
`arXiv`_.
73+
74+
.. code-block::
75+
76+
@article{loche_fast_2024,
77+
title = {Fast and Flexible Range-Separated Models for Atomistic Machine Learning},
78+
author = {Loche, Philip and {Huguenin-Dumittan}, Kevin K. and Honarmand, Melika and Xu, Qianjun and Rumiantsev, Egor and How, Wei Bin and Langer, Marcel F. and Ceriotti, Michele},
79+
year = {2024},
80+
month = dec,
81+
number = {arXiv:2412.03281},
82+
eprint = {2412.03281},
83+
primaryclass = {physics},
84+
publisher = {arXiv},
85+
doi = {10.48550/arXiv.2412.03281},
86+
urldate = {2024-12-05},
87+
archiveprefix = {arXiv}
88+
}
89+
90+
.. _`arXiv`: http://arxiv.org/abs/2412.03281
91+
6692
.. marker-contributing
6793
6894
Contributors

docs/src/index.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
torch-pme
2-
#########
1+
Welcome to the torch-pme Documentation!
2+
#######################################
3+
4+
Overview
5+
--------
36

47
.. include:: ../../README.rst
58
:start-after: marker-introduction
@@ -15,6 +18,10 @@ torch-pme
1518

1619
.. _`vesin`: https://luthaf.fr/vesin
1720

21+
.. include:: ../../README.rst
22+
:start-after: marker-cite
23+
:end-before: marker-contributing
24+
1825
.. toctree::
1926
:hidden:
2027

0 commit comments

Comments
 (0)