Skip to content

Commit e098369

Browse files
authored
Merge pull request #251 from njzjz/markdown
update documents for easy installation methods
2 parents 567bcff + 9dabb31 commit e098369

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
- [Deep Potential in a nutshell](#deep-potential-in-a-nutshell)
1111
- [Download and install](#download-and-install)
1212
- [Easy installation methods](#easy-installation-methods)
13+
- [Offline packages](#offline-packages)
1314
- [With Docker](#with-docker)
1415
- [With conda](#with-conda)
15-
- [Offline packages](#offline-packages)
1616
- [Install the python interaction](#install-the-python-interface)
1717
- [Install the Tensorflow's python interface](#install-the-tensorflows-python-interface)
1818
- [Install the DeePMD-kit's python interface](#install-the-deepmd-kits-python-interface)
@@ -90,8 +90,10 @@ Please follow our [github](https://github.com/deepmodeling/deepmd-kit) webpage t
9090
## Easy installation methods
9191
There various easy methods to install DeePMD-kit. Choose one that you prefer. If you want to build by yourself, jump to the next two sections.
9292

93-
### With Docker
94-
A docker for installing the DeePMD-kit on CentOS 7 is available [here](https://github.com/frankhan91/deepmd-kit_docker).
93+
After your easy installation, DeePMD-kit (`dp`) and LAMMPS (`lmp`) will be available to execute. You can try `dp -h` and `lmp -h` to see the help. `mpirun` is also available considering you may want to run LAMMPS in parallel.
94+
95+
### Offline packages
96+
Both CPU and GPU version offline packages are avaiable in [the Releases page](https://github.com/deepmodeling/deepmd-kit/releases).
9597

9698
### With conda
9799
DeePMD-kit is avaiable with [conda](https://github.com/conda/conda). Install [Anaconda](https://www.anaconda.com/distribution/#download-section) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html) first.
@@ -101,13 +103,23 @@ To install the CPU version:
101103
conda install deepmd-kit=*=*cpu lammps-dp=*=*cpu -c deepmodeling
102104
```
103105

104-
To install the GPU version containing [CUDA 10.0](https://docs.nvidia.com/deploy/cuda-compatibility/index.html#binary-compatibility__table-toolkit-driver):
106+
To install the GPU version containing [CUDA 10.1](https://docs.nvidia.com/deploy/cuda-compatibility/index.html#binary-compatibility__table-toolkit-driver):
105107
```bash
106108
conda install deepmd-kit=*=*gpu lammps-dp=*=*gpu -c deepmodeling
107109
```
108110

109-
### Offline packages
110-
Both CPU and GPU version offline package are avaiable in [the Releases page](https://github.com/deepmodeling/deepmd-kit/releases).
111+
### With Docker
112+
A docker for installing the DeePMD-kit is available [here](https://github.com/orgs/deepmodeling/packages/container/deepmd-kit).
113+
114+
To pull the CPU version:
115+
```bash
116+
docker pull ghcr.io/deepmodeling/deepmd-kit:1.2.0_cpu
117+
```
118+
119+
To pull the GPU version:
120+
```bash
121+
docker pull ghcr.io/deepmodeling/deepmd-kit:1.2.0_cuda10.1_gpu
122+
```
111123

112124
## Install the python interface
113125
### Install the Tensorflow's python interface

0 commit comments

Comments
 (0)