Skip to content
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
26 changes: 26 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://github.com/lab-cosmo/torch-pme/pulls>`_.

.. 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
Expand Down
11 changes: 9 additions & 2 deletions docs/src/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
torch-pme
#########
Welcome to the torch-pme Documentation!
#######################################

Overview
--------

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

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

.. include:: ../../README.rst
:start-after: marker-cite
:end-before: marker-contributing

.. toctree::
:hidden:

Expand Down
Loading