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.

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

Update the installation instructions #55

Merged
merged 3 commits into from
Feb 18, 2022
Merged
Changes from all commits
Commits
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
31 changes: 12 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,28 @@
# TorchMD-net
# TorchMD-NET

TorchMD-Net provides state-of-the-art graph neural networks and equivariant transformer neural networks potentials for learning molecular potentials. It offers an efficient and fast implementation and it is integrated in GPU-accelerated molecular dynamics code like [ACEMD](https://www.acellera.com/products/molecular-dynamics-software-gpu-acemd/) and [OpenMM](https://www.openmm.org). See the full paper at https://arxiv.org/abs/2202.02541.
TorchMD-NET provides state-of-the-art graph neural networks and equivariant transformer neural networks potentials for learning molecular potentials. It offers an efficient and fast implementation and it is integrated in GPU-accelerated molecular dynamics code like [ACEMD](https://www.acellera.com/products/molecular-dynamics-software-gpu-acemd/) and [OpenMM](https://www.openmm.org). See the full paper at https://arxiv.org/abs/2202.02541.

## Installation
Create a new conda environment using Python 3.8 via
```
conda create --name torchmd python=3.8
conda activate torchmd
```

### Install PyTorch
Then, install PyTorch according to your hardware specifications (more information [here](https://pytorch.org/get-started/locally/#start-locally)), e.g. for CUDA 11.1 and the most recent version of PyTorch use
Clone the repository:
```
conda install pytorch torchvision torchaudio cudatoolkit=11.1 -c pytorch -c nvidia
git clone https://github.com/torchmd/torchmd-net.git
cd torchmd-net
```
### Install PyTorch Geometric
Install `pytorch-geometric` with its dependencies through

Create a Conda environment and activate it:
```
conda install pytorch-geometric -c rusty1s -c conda-forge
conda env create -f environment.yml
conda activate torchmd-net
```
To install PyTorch Geometric via pip or for PyTorch < 1.8, see https://github.com/rusty1s/pytorch_geometric#installation.

### Install TorchMD-Net
Download and install the `torchmd-net` repository via
Install TorchMD-NET into the Conda environment:
```
git clone https://github.com/compsciencelab/torchmd-net.git
pip install -e torchmd-net/
pip install -e .
```

## Performance
The TorchMD-net equivariant Transformer (ET) is competitive with previous methods on the MD17 benchmark dataset.
The TorchMD-NET equivariant Transformer (ET) is competitive with previous methods on the MD17 benchmark dataset.


![image](https://user-images.githubusercontent.com/36135990/146565069-a3c03827-5ee2-44b0-89b0-9e02e129b6df.png)
Expand Down