Skip to content

Commit 766fcaf

Browse files
njzjznjzjz-botpre-commit-ci[bot]njzjz-botiProzd
authored
docs: refresh project landing pages (#5951)
## Summary - Replace the repository README with a Markdown-first landing page that prominently highlights pretrained DPA models and the current DeePMD-kit feature set. - Route feature-level calls to action to the hosted documentation while keeping runnable examples in the repository. - Preserve the theme-aware logo plus the DOI and live citation-count badges for the three general software publications. - Refresh the documentation homepage with responsive Sphinx Design cards, model guidance, data-to-dynamics navigation, and the complete general software citations. - Keep the change isolated to `README.md` and `doc/index.rst` to avoid conflicts with other documentation work. ## Validation - `ruff check .` - `ruff format .` - Repository Markdown and whitespace hooks - `git diff --check` - Minimal Sphinx 9.1 HTML build with `sphinx-design` - Verified all hosted documentation links and citation badge endpoints referenced by the README return HTTP 200 Fixes #5240 Coding agent: Codex Codex version: codex-cli 0.144.6 Model: gpt-5.6-sol Reasoning effort: xhigh <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Rewrote the README with an accessible overview of capabilities, model families, supported backends, workflows, installation, quick starts, pretrained models, integrations, licensing, and references. * Replaced the documentation landing page with structured guidance for installation, training, deployment, physics features, and recent developments. * Improved navigation with card-based sections, clearer guide categories, project details, generated indices, and search access. * **References** * Added citations for the Deep Potential representation and DeePCG coarse-grained model. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Jinzhe Zeng <njzjz@qq.com> Co-authored-by: njzjz-bot <njzjz.bot@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: njzjz-bot (driven by OpenClaw (model: custom-chat-jinzhezeng-group/gpt-5.6-terra))[bot] <48687836+njzjz-bot@users.noreply.github.com> Co-authored-by: Duo <50307526+iProzd@users.noreply.github.com> Co-authored-by: njzjz-bot <njzjz-bot@users.noreply.github.com>
1 parent 5ec909c commit 766fcaf

10 files changed

Lines changed: 723 additions & 123 deletions

File tree

CITATIONS.bib

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,22 @@ @article{Zeng_JChemTheoryComput_2025_v21_p4375
8686
},
8787
}
8888

89+
@article{Han_CommunComputPhys_2018_v23_p629,
90+
annote = {Deep Potential},
91+
title = {
92+
{Deep Potential: A General Representation of a Many-Body Potential Energy
93+
Surface}
94+
},
95+
author = {Jiequn Han and Linfeng Zhang and Roberto Car and Weinan E},
96+
journal = {Commun. Comput. Phys.},
97+
year = 2018,
98+
volume = 23,
99+
number = 3,
100+
pages = {629--639},
101+
doi = {10.4208/cicp.OA-2017-0213},
102+
url = {https://arxiv.org/abs/1707.01478},
103+
}
104+
89105
@article{Lu_CompPhysCommun_2021_v259_p107624,
90106
annote = {GPU support},
91107
title = {
@@ -120,6 +136,18 @@ @article{Zhang_PhysRevLett_2018_v120_p143001
120136
doi = {10.1103/PhysRevLett.120.143001},
121137
}
122138

139+
@article{Zhang_JChemPhys_2018_v149_p34101,
140+
annote = {coarse-grained model (DeePCG)},
141+
title = {{DeePCG: Constructing Coarse-Grained Models via Deep Neural Networks}},
142+
author = {Linfeng Zhang and Jiequn Han and Han Wang and Roberto Car and Weinan E},
143+
journal = {J. Chem. Phys.},
144+
year = 2018,
145+
volume = 149,
146+
number = 3,
147+
pages = 034101,
148+
doi = {10.1063/1.5027645},
149+
}
150+
123151
@incollection{Zhang_BookChap_NIPS_2018_v31_p4436,
124152
annote = {DeepPot-SE (se\_e2\_a, se\_e2\_r, se\_e3, se\_atten)},
125153
title = {
@@ -196,6 +224,35 @@ @article{Zhang_npjComputMater_2024_v10_p293
196224
doi = {10.1038/s41524-024-01493-2},
197225
}
198226

227+
@article{Zhang_npjComputMater_2026_DPA3,
228+
annote = {DPA-3 descriptor (dpa3)},
229+
author = {
230+
Duo Zhang and Anyang Peng and Chun Cai and Wentao Li and Yuanchang Zhou and
231+
Jinzhe Zeng and Mingyu Guo and Chengqian Zhang and Bowen Li and Hong Jiang
232+
and Tong Zhu and Weile Jia and Linfeng Zhang and Han Wang
233+
},
234+
title = {{A Graph Neural Network for the Era of Large Atomistic Models}},
235+
journal = {npj Comput. Mater.},
236+
year = 2026,
237+
doi = {10.1038/s41524-026-02146-2},
238+
}
239+
240+
@misc{Li_2026_DPA4,
241+
annote = {DPA-4 descriptor (dpa4, sezm)},
242+
author = {
243+
Tiancheng Li and Wentao Li and Anyang Peng and Jianming Xue and Linfeng
244+
Zhang and Duo Zhang and Han Wang
245+
},
246+
title = {
247+
{{DPA4}: Pushing the Accuracy-Cost Frontier of Interatomic Potentials with
248+
{EMFA} {SO(2)} Convolution}
249+
},
250+
publisher = {arXiv},
251+
year = 2026,
252+
doi = {10.48550/arXiv.2606.02419},
253+
url = {https://arxiv.org/abs/2606.02419},
254+
}
255+
199256
@article{Zhang_PhysPlasmas_2020_v27_p122704,
200257
annote = {frame-specific parameters (e.g. electronic temperature)},
201258
author = {
@@ -262,6 +319,18 @@ @article{Sommers_PhysChemChemPhys_2020_v22_p10592
262319
doi = {10.1039/D0CP01893G},
263320
}
264321

322+
@misc{Ahart_2026_DeepPolaron,
323+
annote = {atomic charge population (DeepPopulation)},
324+
author = {Christian S. Ahart and Denan Li and Jochen Blumberger and Shi Liu},
325+
title = {
326+
{Polaron Transport in {TiO}$_{2}$ from Machine Learning Molecular Dynamics}
327+
},
328+
publisher = {arXiv},
329+
year = 2026,
330+
doi = {10.48550/arXiv.2606.01763},
331+
url = {https://arxiv.org/abs/2606.01763},
332+
}
333+
265334
@article{Zeng_JChemTheoryComput_2023_v19_p1261,
266335
annote = {fit relative energies},
267336
author = {Jinzhe Zeng and Yujun Tao and Timothy J Giese and Darrin M York},

README.md

Lines changed: 240 additions & 83 deletions
Large diffs are not rendered by default.
43.3 KB
Loading

doc/_static/dpa4-performance.webp

105 KB
Loading

doc/credits.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,24 @@ Cite DeePMD-kit and methods
1515
Zeng_JChemPhys_2023_v159_p054801
1616
Zeng_JChemTheoryComput_2025_v21_p4375
1717

18+
.. _cite-deep-potential:
19+
20+
- If the original Deep Potential model is used,
21+
22+
.. bibliography::
23+
:filter: False
24+
25+
Han_CommunComputPhys_2018_v23_p629
26+
27+
.. _cite-deepcg:
28+
29+
- If the DeePCG coarse-grained model is used,
30+
31+
.. bibliography::
32+
:filter: False
33+
34+
Zhang_JChemPhys_2018_v149_p34101
35+
1836
- If GPU version is used,
1937

2038
.. bibliography::
@@ -57,6 +75,24 @@ Cite DeePMD-kit and methods
5775

5876
Zhang_npjComputMater_2024_v10_p293
5977

78+
.. _cite-dpa3:
79+
80+
- If DPA-3 descriptor (`dpa3`) is used,
81+
82+
.. bibliography::
83+
:filter: False
84+
85+
Zhang_npjComputMater_2026_DPA3
86+
87+
.. _cite-dpa4:
88+
89+
- If DPA-4 descriptor (`dpa4`, `sezm`) is used,
90+
91+
.. bibliography::
92+
:filter: False
93+
94+
Li_2026_DPA4
95+
6096
- If frame-specific parameters (`fparam`, e.g. electronic temperature) is used,
6197

6298
.. bibliography::
@@ -85,6 +121,15 @@ Cite DeePMD-kit and methods
85121

86122
Sommers_PhysChemChemPhys_2020_v22_p10592
87123

124+
.. _cite-deeppopulation:
125+
126+
- If fitting atomic charge populations with DeepPopulation,
127+
128+
.. bibliography::
129+
:filter: False
130+
131+
Ahart_2026_DeepPolaron
132+
88133
- If fitting density of states,
89134

90135
.. bibliography::

0 commit comments

Comments
 (0)