Skip to content

Commit d949b5f

Browse files
docs: add the citation (#555)
Signed-off-by: Jinzhe Zeng <[email protected]> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added a Credits section to README with citation details. * Enhanced project documentation with bibliographic citations. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Jinzhe Zeng <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 16b013d commit d949b5f

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,14 @@ DPDispatcher will monitor (poke) until these jobs finish and download the result
1111

1212
For more information, check the [documentation](https://dpdispatcher.readthedocs.io/).
1313

14+
## Credits
15+
16+
Please cite the following paper if you use this project in your work:
17+
18+
- Fengbo Yuan, Zhaohan Ding, Yun-Pei Liu, Kai Cao, Jiahao Fan, Cao Thang Nguyen, Yuzhi Zhang, Haidi Wang, Yixiao Chen, Jiameng Huang, Tongqi Wen, Mingkang Liu, Yifan Li, Yong-Bin Zhuang, Hao Yu, Ping Tuo, Yaotang Zhang, Yibo Wang, Linfeng Zhang, Han Wang, Jinzhe Zeng, DPDispatcher: Scalable HPC Task Scheduling for AI-Driven Science, _J. Chem. Inf. Model._, 2025, DOI: [10.1021/acs.jcim.5c02081](https://doi.org/10.1021/acs.jcim.5c02081). [![Citations](https://citations.njzjz.win/10.1021/acs.jcim.5c02081)](https://badge.dimensions.ai/details/doi/10.1021/acs.jcim.5c02081)
19+
20+
This project was separated out from the [DP-GEN](https://github.com/deepmodeling/dpgen) project (Section 3.3 in [its paper](https://doi.org/10.1016/j.cpc.2020.107206)) to be used by more workflow software.
21+
1422
## Installation
1523

1624
DPDispatcher can be installed by `pip`:
@@ -33,7 +41,3 @@ See [Getting Started](https://dpdispatcher.readthedocs.io/en/latest/getting-star
3341

3442
DPDispatcher is maintained by Deep Modeling's developers and welcomes other people.
3543
See [Contributing Guide](CONTRIBUTING.md) to become a contributor! 🤓
36-
37-
## References
38-
39-
DPDispatcher is derived from the [DP-GEN](https://github.com/deepmodeling/dpgen) package. To mention DPDispatcher in a scholarly publication, please read Section 3.3 in the [DP-GEN paper](https://doi.org/10.1016/j.cpc.2020.107206).

doc/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,15 @@ DPDispatcher is a Python package used to generate HPC (High Performance Computin
1010

1111
DPDispatcher will monitor (poke) until these jobs finish and download the results files (if these jobs is running on remote systems connected by SSH).
1212

13+
Please cite the following paper if you use this project in your work:
14+
15+
- Fengbo Yuan, Zhaohan Ding, Yun-Pei Liu, Kai Cao, Jiahao Fan, Cao
16+
Thang Nguyen, Yuzhi Zhang, Haidi Wang, Yixiao Chen, Jiameng Huang,
17+
Tongqi Wen, Mingkang Liu, Yifan Li, Yong-Bin Zhuang, Hao Yu, Ping
18+
Tuo, Yaotang Zhang, Yibo Wang, Linfeng Zhang, Han Wang, Jinzhe Zeng,
19+
DPDispatcher: Scalable HPC Task Scheduling for AI-Driven Science, *J.
20+
Chem. Inf. Model.*, 2025.
21+
1322
.. toctree::
1423
:maxdepth: 2
1524
:caption: Contents:

0 commit comments

Comments
 (0)