Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add easy installation #171

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add easy installation #171

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions docs/user_guide/2.installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# 2. Installation
## 2.1 Install Dependencies
## 2.1 Easy installation

[![conda-forge](https://img.shields.io/conda/dn/conda-forge/dmff?color=red&label=conda-forge&logo=conda-forge)](https://anaconda.org/conda-forge/dmff)

You can [setup a conda environment](https://docs.deepmodeling.com/faq/conda.html), and then use conda to install DMFF from conda-forge:

```sh
conda create -n dmff dmff -c conda-forge
conda activate dmff
```

## 2.2 Install DMFF from Source Code

Alternatively, you can install DMFF from the source. Firstly, install its dependencies:

+ Create conda environment:
```
conda create -n dmff python=3.9 --yes
Expand Down Expand Up @@ -31,7 +45,7 @@ conda install -c conda-forge openmm==7.7.0
```bash
conda install -c conda-forge rdkit
```
## 2.2 Install DMFF from Source Code

One can download the DMFF source code from github and install it using `pip`. :
```bash
git clone https://github.com/deepmodeling/DMFF.git
Expand Down
Loading