You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-13Lines changed: 18 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,20 +22,24 @@ Open source code for RFdiffusion2 as described in the following pre-print.
22
22
23
23
2.**Add the repo to your PYTHONPATH**
24
24
25
-
If you installed the repo into `/my/path/to/rfdiffusion`, then run:
25
+
If you installed the repo into `/my/path/to/RFdiffusion2`, then run:
26
26
```bash
27
-
export PYTHONPATH="/my/path/to/rfdiffusion"
27
+
export PYTHONPATH="/my/path/to/RFdiffusion2"
28
28
```
29
29
30
30
3.**Download the model weights and containers:**
31
31
```bash
32
+
cd /my/path/to/RFdiffusion2
32
33
python setup.py
33
34
```
35
+
These files are quite large so the download process can take over half an hour. If the download process gets terminated before finishing run `python setup.py overwrite` so taht any partially downloaded files can be overwritten.
34
36
35
37
4.**Install apptainer**
36
38
37
-
RFdiffusion 2 (RFD2) uses [apptainer](https://apptainer.org) to simplify the environment set-up.
38
-
Please follow the apptainer [installation instructions](https://apptainer.org/docs/admin/main/installation.html) for your operating system.
39
+
*Note: you can also run RFdiffusion2 with singularity.*
40
+
41
+
RFdiffusion2 (RFD2) uses [apptainer](https://apptainer.org) to simplify the environment set-up.
42
+
If you do not already have apptainer on your system, please follow the apptainer [installation instructions](https://apptainer.org/docs/admin/main/installation.html) for your operating system.
39
43
40
44
If you manage your packages on linux with `apt` you can simply run:
41
45
```bash
@@ -78,22 +82,22 @@ The outputs will be written to:
This runs only the design stage of the pipeline. In order to continue through sequence-fitting with LigandMPNN and folding with Chai1, pass the command line argument: `stop_step=''`. Note that Chai1 cannot run on all GPU architectures.
85
+
This runs only the design stage of the pipeline. In order to continue through sequence-fitting with [LigandMPNN](https://github.com/dauparas/LigandMPNN) and folding with [Chai1](https://github.com/chaidiscovery/chai-lab), pass the command line argument: `stop_step=''`. Note that Chai1 cannot run on all GPU architectures.
82
86
83
87
Pipeline runs can be resumed by passing `outdir=/path/to/your/output/directory`.
84
88
85
89
86
90
## Viewing Designs
87
91
88
92
Visualizing the design outputs can be confusing when looking at the raw .pdb files, especially for unindexed motif scaffolding, in which the input motif is incorporated into the protein at indices of the network's choice.
89
-
To simplify this, we provide scripts for visualizing the outputs of the network that interact with a local pymol instance over XMLRPC.
93
+
To simplify this, we provide scripts for visualizing the outputs of the network that interact with a local PyMOL instance over XMLRPC.
90
94
91
-
Download [pymol](https://www.pymol.org/) and run it as an XMLRPCServer with:
95
+
Download [PyMOL](https://www.pymol.org/) and run it as an XMLRPCServer with:
92
96
```bash
93
-
./pymol -R
97
+
pymol -R
94
98
```
95
99
96
-
### Pymol and designs on the same machine
100
+
### PyMOL and designs on the same machine
97
101
98
102
Run:
99
103
```bash
@@ -112,23 +116,24 @@ You should see something like:
112
116
- The generated backbone will be colored a pastel gradient.
113
117
- Any small molecules will have their carbon atoms colored purple.
114
118
115
-
### Pymol running locally, designs on remote GPU
119
+
### PyMOL running locally, designs on remote GPU
116
120
117
121
It is common for users to be sshed into a gpu cluster for running designs.
118
-
It is still possible to view designs on a remote computer from your local pymol, as long as your remote computer has a route to your local computer (via VPN or ssh proxy).
122
+
It is still possible to view designs on a remote computer from your local PyMOL, as long as your remote computer has a route to your local computer (via VPN or ssh proxy).
119
123
120
-
Simply find your hostname with:
124
+
Simply find your hostname on your cluster with:
121
125
```bash
122
126
hostname -I
123
127
192.168.0.113 100.64.128.68
124
128
```
125
129
126
130
The second number is the route to your computer.
127
131
128
-
Simply append `--pymol_url=http://100.64.128.68:9123` to the command, i.e. from your remote machine run:
132
+
Simply append `--pymol_url=http://100.64.128.68:9123` to the command, i.e. from your remote machine (cluster) run:
Make sure to replace 100.64.128.68 with your computer's route. 9123 is the port that PyMol uses, after running `pymol -R` you should see a message containing this route number.
0 commit comments