Skip to content

Commit 8eca960

Browse files
author
Han Wang
committed
improve readme
1 parent 2f4c881 commit 8eca960

File tree

2 files changed

+16
-6
lines changed

2 files changed

+16
-6
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,14 @@ source $tensorflow_venv/bin/activate
102102
pip install --upgrade pip
103103
pip install --upgrade tensorflow==1.14.0
104104
```
105+
It is notice that everytime a new shell is started and one wants to use `DeePMD-kit`, the virtual environment should be activated by
106+
```bash
107+
source $tensorflow_venv/bin/activate
108+
```
109+
if one wants to skip out of the virtual environment, he/she can do
110+
```bash
111+
deactivate
112+
```
105113
If one has multiple python interpreters named like python3.x, it can be specified by, for example
106114
```bash
107115
virtualenv -p python3.7 $tensorflow_venv
@@ -483,7 +491,7 @@ Running an MD simulation with LAMMPS is simpler. In the LAMMPS input file, one n
483491
pair_style deepmd graph.pb
484492
pair_coeff
485493
```
486-
where `graph.pb` is the file name of the frozen model. The `pair_coeff` should be left blank. It should be noted that LAMMPS counts atom types starting from 1, therefore, all LAMMPS atom type will be firstly subtracted by 1, and then passed into the DeePMD-kit engine to compute the interactions. A detailed documentation of this pair style is [here](doc/lammps-pair-style-deepmd.md).
494+
where `graph.pb` is the file name of the frozen model. The `pair_coeff` should be left blank. It should be noted that LAMMPS counts atom types starting from 1, therefore, all LAMMPS atom type will be firstly subtracted by 1, and then passed into the DeePMD-kit engine to compute the interactions. [A detailed documentation of this pair style is available.](doc/lammps-pair-style-deepmd.md).
487495

488496
### Long-range interaction
489497
The reciprocal space part of the long-range interaction can be calculated by LAMMPS command `kspace_style`. To use it with DeePMD-kit, one writes

doc/lammps-pair-style-deepmd.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ This pair style takes the deep potential defined in a model file that usually ha
3535

3636
The model deviation evalulate the consistency of the force predictions from multiple models. By default, only the maximal, minimal and averge model deviations are output. If the key `atomic` is set, then the model deviation of force prediction of each atom will be output.
3737

38-
By default, the model deviation is output in absolute value. If the keyword `relative` is set, then the relative model deviation will be output, which is defined by
38+
By default, the model deviation is output in absolute value. If the keyword `relative` is set, then the relative model deviation will be output. The relative model deviation of the force on atom `i` is defined by
3939
```math
40-
|Df|
41-
Ef = -------------
42-
|f| + level
40+
|Df_i|
41+
Ef_i = -------------
42+
|f_i| + level
4343
```
44-
where `Df` is the model deviation of a force, `|f|` is the norm of the force and `level` is provided as the parameter of the keyword `relative`.
44+
where `Df_i` is the absolute model deviation of the force on atom `i`, `|f_i|` is the norm of the the force and `level` is provided as the parameter of the keyword `relative`.
4545

4646

4747
## Restrictions
@@ -50,6 +50,8 @@ where `Df` is the model deviation of a force, `|f|` is the norm of the force and
5050

5151
- The `atom_style` of the system should be `atomic`.
5252

53+
- When using the `atomic` key word of `deepmd` is set, one should not use this pair style with MPI parallelization.
54+
5355

5456
[DP]:https://journals.aps.org/prl/abstract/10.1103/PhysRevLett.120.143001
5557
[DP-SE]:https://arxiv.org/abs/1805.09003

0 commit comments

Comments
 (0)