Skip to content

Commit 4ec90ca

Browse files
authored
docs: update installation documentation (#1372)
Since the dpgen conda package on the deepmodeling channel and the offline packages are not maintained anymore, this PR removes the related documentation.
1 parent ad53c5a commit 4ec90ca

File tree

2 files changed

+12
-31
lines changed

2 files changed

+12
-31
lines changed

README.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,14 @@ Yuzhi Zhang, Haidi Wang, Weijie Chen, Jinzhe Zeng, Linfeng Zhang, Han Wang, and
2323

2424
## Download and Install
2525

26-
DP-GEN only supports Python 3.9 and above.
26+
DP-GEN only supports Python 3.9 and above. You can use one of the following methods to install DP-GEN:
27+
28+
- Install via pip: `pip install dpgen`
29+
- Install via conda: `conda install -c conda-forge dpgen``
30+
- Install from source code: `git clone https://github.com/deepmodeling/dpgen && pip install ./dpgen`
2731

28-
One can download the source code of dpgen by
29-
```bash
30-
git clone https://github.com/deepmodeling/dpgen.git
31-
```
32-
then you may install DP-GEN easily by:
33-
```bash
34-
cd dpgen
35-
pip install --user .
36-
```
37-
With this command, the dpgen executable is install to `$HOME/.local/bin/dpgen`. You may want to export the `PATH` by
38-
```bash
39-
export PATH=$HOME/.local/bin:$PATH
40-
```
4132
To test if the installation is successful, you may execute
33+
4234
```bash
4335
dpgen -h
4436
```

doc/overview/overview.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![GitHub release](https://img.shields.io/github/release/deepmodeling/dpgen.svg?maxAge=86400)](https://github.com/deepmodeling/dpgen/releases/)
66
[![doi:10.1016/j.cpc.2020.107206](https://img.shields.io/badge/DOI-10.1016%2Fj.cpc.2020.107206-blue)](https://doi.org/10.1016/j.cpc.2020.107206)
77
![Citations](https://citations.njzjz.win/10.1016/j.cpc.2020.107206)
8-
[![conda install](https://img.shields.io/conda/dn/deepmodeling/dpgen?label=conda%20install)](https://anaconda.org/deepmodeling/dpgen)
8+
[![conda install](https://img.shields.io/conda/dn/conda-forge/dpgen?label=conda%20install)](https://anaconda.org/conda-forge/dpgen)
99
[![pip install](https://img.shields.io/pypi/dm/dpgen?label=pip%20install)](https://pypi.org/project/dpgen)
1010

1111
DP-GEN (Deep Generator) is a software written in Python, delicately designed to generate a deep learning based model of interatomic potential energy and force field. DP-GEN is dependent on [DeepMD-kit](https://github.com/deepmodeling/deepmd-kit/blob/master/README.md). With highly scalable interface with common softwares for molecular simulation, DP-GEN is capable to automatically prepare scripts and maintain job queues on HPC machines (High Performance Cluster) and analyze results.
@@ -21,28 +21,17 @@ Yuzhi Zhang, Haidi Wang, Weijie Chen, Jinzhe Zeng, Linfeng Zhang, Han Wang, and
2121

2222
## Download and install
2323

24-
DP-GEN only supports Python 3.9 and above.
25-
26-
Please follow our [GitHub](https://github.com/deepmodeling/dpgen) webpage to download the [latest released version](https://github.com/deepmodeling/dpgen/tree/master) and [development version](https://github.com/deepmodeling/dpgen/tree/devel).
27-
One can download the source code of dpgen by
28-
```bash
29-
git clone https://github.com/deepmodeling/dpgen.git
30-
```
31-
32-
DP-GEN offers multiple installation methods. It is recommend using easily methods like:
33-
- offline packages: find them in [releases](https://github.com/deepmodeling/dpgen/releases/),
34-
- pip: use `pip install dpgen`, see [dpgen-PyPI](https://pypi.org/project/dpgen/)
35-
- conda: use `conda install -c deepmodeling dpgen`, see [dpgen-conda](https://anaconda.org/deepmodeling/dpgen)
24+
DP-GEN only supports Python 3.9 and above. You can use one of the following methods to install DP-GEN:
3625

26+
- Install via pip: `pip install dpgen`
27+
- Install via conda: `conda install -c conda-forge dpgen``
28+
- Install from source code: `git clone https://github.com/deepmodeling/dpgen && pip install ./dpgen`
3729

3830
To test if the installation is successful, you may execute
31+
3932
```bash
4033
dpgen -h
4134
```
42-
or just
43-
```
44-
dpgen
45-
```
4635

4736
## Use DP-GEN
4837

0 commit comments

Comments
 (0)