Skip to content

Commit 03c4653

Browse files
authored
Updated README
Added links to external tools, added more details to clarify instructions.
1 parent 5bbd9c9 commit 03c4653

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,24 @@ Open source code for RFdiffusion2 as described in the following pre-print.
2222

2323
2. **Add the repo to your PYTHONPATH**
2424

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:
2626
```bash
27-
export PYTHONPATH="/my/path/to/rfdiffusion"
27+
export PYTHONPATH="/my/path/to/RFdiffusion2"
2828
```
2929

3030
3. **Download the model weights and containers:**
3131
```bash
32+
cd /my/path/to/RFdiffusion2
3233
python setup.py
3334
```
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.
3436

3537
4. **Install apptainer**
3638

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.
3943

4044
If you manage your packages on linux with `apt` you can simply run:
4145
```bash
@@ -78,22 +82,22 @@ The outputs will be written to:
7882
pipeline_outputs/${now:%Y-%m-%d}_${now:%H-%M-%S}_open_source_demo
7983
```
8084

81-
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.
8286

8387
Pipeline runs can be resumed by passing `outdir=/path/to/your/output/directory`.
8488

8589

8690
## Viewing Designs
8791

8892
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.
9094

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:
9296
```bash
93-
./pymol -R
97+
pymol -R
9498
```
9599

96-
### Pymol and designs on the same machine
100+
### PyMOL and designs on the same machine
97101

98102
Run:
99103
```bash
@@ -112,23 +116,24 @@ You should see something like:
112116
- The generated backbone will be colored a pastel gradient.
113117
- Any small molecules will have their carbon atoms colored purple.
114118

115-
### Pymol running locally, designs on remote GPU
119+
### PyMOL running locally, designs on remote GPU
116120

117121
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).
119123

120-
Simply find your hostname with:
124+
Simply find your hostname on your cluster with:
121125
```bash
122126
hostname -I
123127
192.168.0.113 100.64.128.68
124128
```
125129

126130
The second number is the route to your computer.
127131

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:
129133
```bash
130134
apptainer exec rf_diffusion/exec/bakerlab_rf_diffusion_aa.sif rf_diffusion/dev/show_bench.py --clear=True --key=name '/absolute/path/to/pipeline_outputs/output_directory/*.pdb' --pymol_url=http://100.64.128.68:9123
131135
```
136+
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.
132137

133138
## Additional Info
134139

0 commit comments

Comments
 (0)