README.md 943 Bytes
Newer Older
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
1
2
3
4
5
6
7
# OpenFold

A faithful PyTorch reproduction of DeepMind's 
[AlphaFold 2](https://github.com/deepmind/alphafold).

## Installation

Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
8
1. Having installed Python 3.9, install dependencies.
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
9
10
11
12
13

```bash
pip3 install -r requirements.txt
```

Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
14
2. Install third-party dependencies with:
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
15
16

```bash
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
scripts/install_third_party_dependencies.sh
```

This script installs Miniconda locally and creates a conda virtual environment
with all of the packages required to run Openfold. To activate the environment,
run:

```bash
scripts/activate_conda_venv.sh
```

To deactivate it, run

```bash
scripts/deactivate_conda_venv.sh
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
32
33
34
35
36
37
38
39
40
41
```

## Features

OpenFold fully reproduces AlphaFold's inference and data processing pipelines, 
but is written entirely in PyTorch rather than JAX/TensorFlow. It is capable of 
importing AlphaFold's original pretrained weights.

Future versions will support multi-GPU training with 
[DeepSpeed](https://github.com/microsoft/DeepSpeed).