Skip to content

Commit 918d4de

Browse files
docs: add v3 paper citations (#4619)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Added a new citation for the "DeePMD-kit v3" article in various documentation files. - Clarified references to distinguish between the "v2" and "v3" publications. - Enhanced bibliography and credits details for improved clarity. - **Chores** - Revised citation formatting across the package to reflect formal publication standards. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Jinzhe Zeng <jinzhe.zeng@ustc.edu.cn> Signed-off-by: Jinzhe Zeng <njzjz@qq.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent 47bbd65 commit 918d4de

File tree

6 files changed

+97
-3
lines changed

6 files changed

+97
-3
lines changed

CITATIONS.bib

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,31 @@ @article{Zeng_JChemPhys_2023_v159_p054801
4040
doi = {10.1063/5.0155600},
4141
}
4242

43+
@article{Zeng_arXiv_2025_p2502.19161,
44+
annote = {general purpose},
45+
author = {
46+
Jinzhe Zeng and Duo Zhang and Anyang Peng and Xiangyu Zhang and Sensen He
47+
and Yan Wang and Xinzijian Liu and Hangrui Bi and Yifan Li and Chun Cai and
48+
Chengqian Zhang and Yiming Du and Jia-Xin Zhu and Pinghui Mo and Zhengtao
49+
Huang and Qiyu Zeng and Shaochen Shi and Xuejian Qin and Zhaoxi Yu and
50+
Chenxing Luo and Ye Ding and Yun-Pei Liu and Ruosong Shi and Zhenyu Wang
51+
and Sigbj{\o}rn L{\o}land Bore and Junhan Chang and Zhe Deng and Zhaohan
52+
Ding and Siyuan Han and Wanrun Jiang and Guolin Ke and Zhaoqing Liu and
53+
Denghui Lu and Koki Muraoka and Hananeh Oliaei and Anurag Kumar Singh and
54+
Haohui Que and Weihong Xu and Zhangmancang Xu and Yong-Bin Zhuang and Jiayu
55+
Dai and Timothy J. Giese and Weile Jia and Ben Xu and Darrin M. York and
56+
Linfeng Zhang and Han Wang
57+
},
58+
title = {
59+
{DeePMD-kit v3: A Multiple-Backend Framework for Machine Learning
60+
Potentials}
61+
},
62+
journal = {arXiv},
63+
year = 2025,
64+
pages = {2502.19161},
65+
doi = {10.48550/arXiv.2502.19161},
66+
}
67+
4368
@article{Lu_CompPhysCommun_2021_v259_p107624,
4469
annote = {GPU support},
4570
title = {

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ If you use this code in any future publications, please cite the following publi
3636
- Jinzhe Zeng, Duo Zhang, Denghui Lu, Pinghui Mo, Zeyu Li, Yixiao Chen, Marián Rynik, Li'ang Huang, Ziyao Li, Shaochen Shi, Yingze Wang, Haotian Ye, Ping Tuo, Jiabin Yang, Ye Ding, Yifan Li, Davide Tisi, Qiyu Zeng, Han Bao, Yu Xia, Jiameng Huang, Koki Muraoka, Yibo Wang, Junhan Chang, Fengbo Yuan, Sigbjørn Løland Bore, Chun Cai, Yinnian Lin, Bo Wang, Jiayan Xu, Jia-Xin Zhu, Chenxing Luo, Yuzhi Zhang, Rhys E. A. Goodall, Wenshuo Liang, Anurag Kumar Singh, Sikai Yao, Jingchao Zhang, Renata Wentzcovitch, Jiequn Han, Jie Liu, Weile Jia, Darrin M. York, Weinan E, Roberto Car, Linfeng Zhang, Han Wang. "DeePMD-kit v2: A software package for deep potential models." J. Chem. Phys. 159 (2023): 054801.
3737
[![doi:10.1063/5.0155600](https://img.shields.io/badge/DOI-10.1063%2F5.0155600-blue)](https://doi.org/10.1063/5.0155600)
3838
[![Citations](https://citations.njzjz.win/10.1063/5.0155600)](https://badge.dimensions.ai/details/doi/10.1063/5.0155600)
39+
- Jinzhe Zeng, Duo Zhang, Anyang Peng, Xiangyu Zhang, Sensen He, Yan Wang, Xinzijian Liu, Hangrui Bi, Yifan Li, Chun Cai, Chengqian Zhang, Yiming Du, Jia-Xin Zhu, Pinghui Mo, Zhengtao Huang, Qiyu Zeng, Shaochen Shi, Xuejian Qin, Zhaoxi Yu, Chenxing Luo, Ye Ding, Yun-Pei Liu, Ruosong Shi, Zhenyu Wang, Sigbjørn Løland Bore, Junhan Chang, Zhe Deng, Zhaohan Ding, Siyuan Han, Wanrun Jiang, Guolin Ke, Zhaoqing Liu, Denghui Lu, Koki Muraoka, Hananeh Oliaei, Anurag Kumar Singh, Haohui Que, Weihong Xu, Zhangmancang Xu, Yong-Bin Zhuang, Jiayu Dai, Timothy J. Giese, Weile Jia, Ben Xu, Darrin M. York, Linfeng Zhang, Han Wang. "DeePMD-kit v3: A Multiple-Backend Framework for Machine Learning Potentials." [arXiv:2502.19161](https://arxiv.org/abs/2502.19161).
3940

4041
In addition, please follow [the bib file](CITATIONS.bib) to cite the methods you used.
4142

@@ -68,14 +69,16 @@ In addition to building up potential energy models, DeePMD-kit can also be used
6869
- Non-von-Neumann.
6970
- C API to interface with the third-party packages.
7071

71-
See [our latest paper](https://doi.org/10.1063/5.0155600) for details of all features until v2.2.3.
72+
See [our v2 paper](https://doi.org/10.1063/5.0155600) for details of all features until v2.2.3.
7273

7374
#### v3
7475

7576
- Multiple backends supported. Add PyTorch and JAX backends.
7677
- The DPA-2 model.
7778
- Plugin mechanisms for external models.
7879

80+
See [our v3 paper](https://doi.org/10.48550/arXiv.2502.19161) for details of all features until v3.0.
81+
7982
## Install and use DeePMD-kit
8083

8184
Please read the [online documentation](https://deepmd.readthedocs.io/) for how to install and use DeePMD-kit.

deepmd/utils/summary.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ class SummaryPrinter(ABC):
4242
"Please read and cite:",
4343
"Wang, Zhang, Han and E, Comput.Phys.Comm. 228, 178-184 (2018)",
4444
"Zeng et al, J. Chem. Phys., 159, 054801 (2023)",
45+
"Zeng et al, arxiv:2502.19161",
4546
"See https://deepmd.rtfd.io/credits/ for details.",
4647
)
4748

doc/credits.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Cite DeePMD-kit and methods
1313

1414
Wang_ComputPhysCommun_2018_v228_p178
1515
Zeng_JChemPhys_2023_v159_p054801
16+
Zeng_arXiv_2025_p2502.19161
1617

1718
- If GPU version is used,
1819

source/lmp/pair_deepmd.cpp

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ static const char cite_user_deepmd_package[] =
5050
"energy representation and molecular dynamics}},\n"
5151
" pages = {178--184}\n"
5252
"}\n"
53-
"@misc{Zeng_JChemPhys_2023_v159_p054801,\n"
53+
"@article{Zeng_JChemPhys_2023_v159_p054801,\n"
5454
" title = {{DeePMD-kit v2: A software package for deep potential "
5555
"models}},\n"
5656
" author = {Jinzhe Zeng and Duo Zhang and Denghui Lu and Pinghui Mo and "
@@ -82,6 +82,38 @@ static const char cite_user_deepmd_package[] =
8282
" year = 2023,\n"
8383
" pages = 054801,\n"
8484
" doi = {10.1063/5.0155600},\n"
85+
"}\n"
86+
"@Article{Zeng_arXiv_2025_p2502.19161,\n"
87+
" annote = {general purpose},\n"
88+
" author = {Jinzhe Zeng and Duo Zhang and Anyang Peng and Xiangyu "
89+
"Zhang and Sensen\n"
90+
" He and Yan Wang and Xinzijian Liu and Hangrui Bi and Yifan "
91+
"Li and Chun\n"
92+
" Cai and Chengqian Zhang and Yiming Du and Jia-Xin Zhu and "
93+
"Pinghui Mo\n"
94+
" and Zhengtao Huang and Qiyu Zeng and Shaochen Shi and "
95+
"Xuejian Qin and\n"
96+
" Zhaoxi Yu and Chenxing Luo and Ye Ding and Yun-Pei Liu and "
97+
"Ruosong Shi\n"
98+
" and Zhenyu Wang and Sigbj{\\o}rn L{\\o}land Bore and Junhan "
99+
"Chang and\n"
100+
" Zhe Deng and Zhaohan Ding and Siyuan Han and Wanrun Jiang "
101+
"and Guolin\n"
102+
" Ke and Zhaoqing Liu and Denghui Lu and Koki Muraoka and "
103+
"Hananeh Oliaei\n"
104+
" and Anurag Kumar Singh and Haohui Que and Weihong Xu and "
105+
"Zhangmancang\n"
106+
" Xu and Yong-Bin Zhuang and Jiayu Dai and Timothy J. Giese "
107+
"and Weile\n"
108+
" Jia and Ben Xu and Darrin M. York and Linfeng Zhang and Han "
109+
"Wang},\n"
110+
" title = {{DeePMD-kit v3: A Multiple-Backend Framework for Machine "
111+
"Learning\n"
112+
" Potentials}},\n"
113+
" journal = {arXiv},\n"
114+
" year = 2025,\n"
115+
" pages = {2502.19161},\n"
116+
" doi = {10.48550/arXiv.2502.19161},\n"
85117
"}\n\n";
86118

87119
PairDeepMD::PairDeepMD(LAMMPS *lmp)

source/lmp/pair_deepspin.cpp

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ static const char cite_user_deepmd_package[] =
5050
"energy representation and molecular dynamics}},\n"
5151
" pages = {178--184}\n"
5252
"}\n"
53-
"@misc{Zeng_JChemPhys_2023_v159_p054801,\n"
53+
"@article{Zeng_JChemPhys_2023_v159_p054801,\n"
5454
" title = {{DeePMD-kit v2: A software package for deep potential "
5555
"models}},\n"
5656
" author = {Jinzhe Zeng and Duo Zhang and Denghui Lu and Pinghui Mo and "
@@ -82,6 +82,38 @@ static const char cite_user_deepmd_package[] =
8282
" year = 2023,\n"
8383
" pages = 054801,\n"
8484
" doi = {10.1063/5.0155600},\n"
85+
"}\n"
86+
"@Article{Zeng_arXiv_2025_p2502.19161,\n"
87+
" annote = {general purpose},\n"
88+
" author = {Jinzhe Zeng and Duo Zhang and Anyang Peng and Xiangyu "
89+
"Zhang and Sensen\n"
90+
" He and Yan Wang and Xinzijian Liu and Hangrui Bi and Yifan "
91+
"Li and Chun\n"
92+
" Cai and Chengqian Zhang and Yiming Du and Jia-Xin Zhu and "
93+
"Pinghui Mo\n"
94+
" and Zhengtao Huang and Qiyu Zeng and Shaochen Shi and "
95+
"Xuejian Qin and\n"
96+
" Zhaoxi Yu and Chenxing Luo and Ye Ding and Yun-Pei Liu and "
97+
"Ruosong Shi\n"
98+
" and Zhenyu Wang and Sigbj{\\o}rn L{\\o}land Bore and Junhan "
99+
"Chang and\n"
100+
" Zhe Deng and Zhaohan Ding and Siyuan Han and Wanrun Jiang "
101+
"and Guolin\n"
102+
" Ke and Zhaoqing Liu and Denghui Lu and Koki Muraoka and "
103+
"Hananeh Oliaei\n"
104+
" and Anurag Kumar Singh and Haohui Que and Weihong Xu and "
105+
"Zhangmancang\n"
106+
" Xu and Yong-Bin Zhuang and Jiayu Dai and Timothy J. Giese "
107+
"and Weile\n"
108+
" Jia and Ben Xu and Darrin M. York and Linfeng Zhang and Han "
109+
"Wang},\n"
110+
" title = {{DeePMD-kit v3: A Multiple-Backend Framework for Machine "
111+
"Learning\n"
112+
" Potentials}},\n"
113+
" journal = {arXiv},\n"
114+
" year = 2025,\n"
115+
" pages = {2502.19161},\n"
116+
" doi = {10.48550/arXiv.2502.19161},\n"
85117
"}\n\n";
86118

87119
PairDeepSpin::PairDeepSpin(LAMMPS *lmp)

0 commit comments

Comments
 (0)