Skip to content

Commit a60f0ca

Browse files
authored
docs: add conda install (#59)
1 parent 0457922 commit a60f0ca

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[![DOI:10.1021/acs.jcim.4c02441](https://img.shields.io/badge/DOI-10.1021%2Facs.jcim.4c02441-blue)](https://doi.org/10.1021/acs.jcim.4c02441)
44
[![Citations](https://citations.njzjz.win/10.1021/acs.jcim.4c02441)](https://doi.org/10.1021/acs.jcim.4c02441)
5+
[![conda install](https://img.shields.io/conda/dn/conda-forge/deepmd-gnn?label=conda%20install)](https://anaconda.org/conda-forge/deepmd-gnn)
56
[![PyPI - Version](https://img.shields.io/pypi/v/deepmd-gnn)](https://pypi.org/p/deepmd-gnn)
67

78
`deepmd-gnn` is a [DeePMD-kit](https://github.com/deepmodeling/deepmd-kit) plugin for various graph neural network (GNN) models, which connects DeePMD-kit and atomistic GNN packages by enabling GNN models in DeePMD-kit.
@@ -22,14 +23,25 @@ If you use this software, please cite the following paper:
2223

2324
## Installation
2425

26+
### Install via conda
27+
28+
If you are in a [conda environment](https://docs.deepmodeling.com/faq/conda.html) where DeePMD-kit is already installed from the conda-forge channel,
29+
you can use `conda` to install the DeePMD-GNN plugin:
30+
31+
```sh
32+
conda install deepmd-gnn -c conda-forge
33+
```
34+
35+
### Build from source
36+
2537
First, clone this repository:
2638

2739
```sh
2840
git clone https://gitlab.com/RutgersLBSR/deepmd-gnn
2941
cd deepmd-gnn
3042
```
3143

32-
### Python interface plugin
44+
#### Python interface plugin
3345

3446
Python 3.9 or above is required. A C++ compiler that supports C++ 14 (for PyTorch 2.0) or C++ 17 (for PyTorch 2.1 or above) is required.
3547

@@ -42,7 +54,7 @@ export CMAKE_PREFIX_PATH=$(python -c "import torch;print(torch.utils.cmake_prefi
4254
pip install .
4355
```
4456

45-
### C++ interface plugin
57+
#### C++ interface plugin
4658

4759
DeePMD-kit version should be v3.0.0b4 or later.
4860

0 commit comments

Comments
 (0)