diff --git a/README.rst b/README.rst index 5d832aee..2358d029 100644 --- a/README.rst +++ b/README.rst @@ -63,6 +63,32 @@ Having a problem with torch-pme? Please let us know by `submitting an issue Submit new features or bug fixes through a `pull request `_. +.. marker-cite + +Reference +--------- + +If you use *torch-pme* for your work, please read and cite our preprint available on +`arXiv`_. + +.. code-block:: + + @article{loche_fast_2024, + title = {Fast and Flexible Range-Separated Models for Atomistic Machine Learning}, + 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}, + year = {2024}, + month = dec, + number = {arXiv:2412.03281}, + eprint = {2412.03281}, + primaryclass = {physics}, + publisher = {arXiv}, + doi = {10.48550/arXiv.2412.03281}, + urldate = {2024-12-05}, + archiveprefix = {arXiv} + } + +.. _`arXiv`: http://arxiv.org/abs/2412.03281 + .. marker-contributing Contributors diff --git a/docs/src/index.rst b/docs/src/index.rst index 13eada85..88d4a40e 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -1,5 +1,8 @@ -torch-pme -######### +Welcome to the torch-pme Documentation! +####################################### + +Overview +-------- .. include:: ../../README.rst :start-after: marker-introduction @@ -15,6 +18,10 @@ torch-pme .. _`vesin`: https://luthaf.fr/vesin +.. include:: ../../README.rst + :start-after: marker-cite + :end-before: marker-contributing + .. toctree:: :hidden: