|
1 | | -# Interfaces out of DeePMD-kit |
2 | | - |
3 | | -The codes of the following interfaces are not a part of the DeePMD-kit package and maintained by other repositories. We list these interfaces here for user convenience. |
4 | | - |
5 | | -## dpdata |
6 | | - |
7 | | -[dpdata](https://github.com/deepmodeling/dpdata) provides the `predict` method for `System` class: |
8 | | - |
9 | | -```py |
10 | | -import dpdata |
11 | | -dsys = dpdata.LabeledSystem('OUTCAR') |
12 | | -dp_sys = dsys.predict("frozen_model_compressed.pb") |
13 | | -``` |
14 | | - |
15 | | -By inferring with the DP model `frozen_model_compressed.pb`, dpdata will generate a new labeled system `dp_sys` with inferred energies, forces, and virials. |
16 | | - |
17 | | -## OpenMM plugin for DeePMD-kit |
18 | | - |
19 | | -An [OpenMM](https://github.com/openmm/openmm) plugin is provided from [JingHuangLab/openmm_deepmd_plugin](https://github.com/JingHuangLab/openmm_deepmd_plugin), written by the [Huang Lab](http://www.compbiophysics.org/) at Westlake University. |
20 | | - |
21 | | -## AMBER interface to DeePMD-kit |
22 | | - |
23 | | -An [AMBER](https://ambermd.org/) interface to DeePMD-kit is written by the [York [Lab](https://theory.rutgers.edu/) from Rutgers University. It is open-source at [GitLab RutgersLBSR/AmberDPRc](https://gitlab.com/RutgersLBSR/AmberDPRc/). Details can be found in [this paper](https://doi.org/10.1021/acs.jctc.1c00201). |
24 | | - |
25 | | -## DP-GEN |
26 | | - |
27 | | -[DP-GEN](https://github.com/deepmodeling/dpgen) provides a workflow to generate accurate DP models by calling DeePMD-kit's command line interface (CLI) in the local or remote server. Details can be found in [this paper](https://doi.org/10.1016/j.cpc.2020.107206). |
28 | | - |
29 | | -## MLatom |
30 | | - |
31 | | -[Mlatom](http://mlatom.com/) provides an interface to the DeePMD-kit within MLatom's workflow by calling DeePMD-kit's CLI. Details can be found in [this paper](https://doi.org/10.1007/s41061-021-00339-5). |
32 | | - |
33 | | -## ABACUS |
34 | | - |
35 | | -[ABACUS](https://github.com/deepmodeling/abacus-develop/) can run molecular dynamics with a DP model. User is required to [build ABACUS with DeePMD-kit](https://abacus.deepmodeling.com/en/latest/advanced/install.html#build-with-deepmd-kit). |
| 1 | +# Interfaces out of DeePMD-kit |
| 2 | + |
| 3 | +The codes of the following interfaces are not a part of the DeePMD-kit package and maintained by other repositories. We list these interfaces here for user convenience. |
| 4 | + |
| 5 | +## dpdata |
| 6 | + |
| 7 | +[dpdata](https://github.com/deepmodeling/dpdata) provides the `predict` method for `System` class: |
| 8 | + |
| 9 | +```py |
| 10 | +import dpdata |
| 11 | + |
| 12 | +dsys = dpdata.LabeledSystem("OUTCAR") |
| 13 | +dp_sys = dsys.predict("frozen_model_compressed.pb") |
| 14 | +``` |
| 15 | + |
| 16 | +By inferring with the DP model `frozen_model_compressed.pb`, dpdata will generate a new labeled system `dp_sys` with inferred energies, forces, and virials. |
| 17 | + |
| 18 | +## OpenMM plugin for DeePMD-kit |
| 19 | + |
| 20 | +An [OpenMM](https://github.com/openmm/openmm) plugin is provided from [JingHuangLab/openmm_deepmd_plugin](https://github.com/JingHuangLab/openmm_deepmd_plugin), written by the [Huang Lab](http://www.compbiophysics.org/) at Westlake University. |
| 21 | + |
| 22 | +## AMBER interface to DeePMD-kit |
| 23 | + |
| 24 | +An [AMBER](https://ambermd.org/) interface to DeePMD-kit is written by the [York [Lab](https://theory.rutgers.edu/) from Rutgers University. It is open-source at [GitLab RutgersLBSR/AmberDPRc](https://gitlab.com/RutgersLBSR/AmberDPRc/). Details can be found in [this paper](https://doi.org/10.1021/acs.jctc.1c00201). |
| 25 | + |
| 26 | +## DP-GEN |
| 27 | + |
| 28 | +[DP-GEN](https://github.com/deepmodeling/dpgen) provides a workflow to generate accurate DP models by calling DeePMD-kit's command line interface (CLI) in the local or remote server. Details can be found in [this paper](https://doi.org/10.1016/j.cpc.2020.107206). |
| 29 | + |
| 30 | +## MLatom |
| 31 | + |
| 32 | +[Mlatom](http://mlatom.com/) provides an interface to the DeePMD-kit within MLatom's workflow by calling DeePMD-kit's CLI. Details can be found in [this paper](https://doi.org/10.1007/s41061-021-00339-5). |
| 33 | + |
| 34 | +## ABACUS |
| 35 | + |
| 36 | +[ABACUS](https://github.com/deepmodeling/abacus-develop/) can run molecular dynamics with a DP model. User is required to [build ABACUS with DeePMD-kit](https://abacus.deepmodeling.com/en/latest/advanced/install.html#build-with-deepmd-kit). |
0 commit comments