Skip to content

Commit 3e46015

Browse files
committed
Updates the docs of drd3, rasp, and foldx
1 parent c7cf02f commit 3e46015

File tree

5 files changed

+7
-18
lines changed

5 files changed

+7
-18
lines changed

docs/protein-optimization/using_poli/objective_repository/RaSP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
[*Rapid Stability Predictions* (RaSP)](https://github.com/KULL-Centre/_2022_ML-ddG-Blaabjerg) {cite:p}`Blaabjerg:RaSP:2023` predicts the stability of a protein using a supervised learning approach. Starting from features learned using self supervision {cite:p}`Boomsma:spherical_conv:2017`, RaSP learns to predict Rosetta scores using neural networks. The drawback being that only additive mutations could be computed simultaneously. We limit the edit distance to 1 (i.e. we only consider mutations that are one-away from the wildtype).
77

8-
This objective function is quite similar to [`foldx_stability`](./foldx_stability.md), and can be considered a drop-in replacement for single mutations. Be aware that the scales are different, though.
8+
This objective function is quite similar to [`foldx_stability`](./foldx_stability.md), and can be considered a drop-in replacement for single mutations. Be aware that the scales are different.
99

1010
## Prerequisites
1111

docs/protein-optimization/using_poli/objective_repository/drd3_docking.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,6 @@ Running this objective function will create an `./oracle` folder on your working
9090
After the setup described above, you can simply run the following code from
9191

9292
```python
93-
from pathlib import Path
94-
95-
import numpy as np
96-
9793
from poli import objective_factory
9894

9995
# How to create
@@ -112,10 +108,3 @@ print(y0) # [[-4.1]]
112108
:::
113109

114110
::::
115-
116-
<!-- ## References
117-
118-
:::{bibliography}
119-
:style: alpha
120-
121-
::: -->

docs/protein-optimization/using_poli/objective_repository/foldx_sasa.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ This objective function returns the solvent accesible surface area (SASA) of a w
99

1010
:::{note}
1111

12-
If you are interested in computing both a protein's stability and it's SASA score, try `foldx_stability_and_sasa` instead! Just change the `name` in the `create` method below.
12+
If you are interested in computing **both** a protein's stability and it's SASA score, try `foldx_stability_and_sasa` instead! Just change the `name` in the `create` method below.
1313

1414
:::
1515

1616
## Prerequisites
1717

1818
- Have `foldx` installed, and available in your home directory. We expect the following files to be there:
1919
- `~/foldx/foldx`: the binary. You might need to rename it.
20-
- `~/foldx/rotabase.txt`: a text file necessary for `foldx` to run.
20+
- `~/foldx/rotabase.txt`: a text file necessary for `foldx` to run (if you are using `v4` of `foldx`).
2121
- A `wildtype_pdb_file`: a (repaired) pdb file of the wildtype.
2222

2323
:::{admonition} We can repair the file for you
@@ -46,7 +46,7 @@ You can either run this objective function in your current environment (assuming
4646
You will have to install the following two dependencies:
4747

4848
```bash
49-
pip install biopython python-levenshtein
49+
pip install biopython python-levenshtein pdb-tools
5050
```
5151

5252
Then run

docs/protein-optimization/using_poli/objective_repository/foldx_stability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ If you are interested in computing both a protein's stability and it's SASA scor
1616

1717
- Have `foldx` installed, and available in your home directory. We expect the following files to be there:
1818
- `~/foldx/foldx`: the binary. You might need to rename it.
19-
- `~/foldx/rotabase.txt`: a text file necessary for `foldx` to run.
19+
- `~/foldx/rotabase.txt`: a text file necessary for `foldx` to run (only if you are using v4 of `foldx`).
2020
- A `wildtype_pdb_file`: a (repaired) pdb file of the wildtype.
2121

2222
:::{admonition} We can repair the file for you
@@ -45,7 +45,7 @@ You can either run this objective function in your current environment (assuming
4545
You will have to install the following two dependencies:
4646

4747
```bash
48-
pip install biopython python-levenshtein
48+
pip install biopython python-levenshtein pdb-tools
4949
```
5050

5151
Then run

docs/protein-optimization/using_poli/objective_repository/penalized_logp_lambo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ import numpy as np
5757
from poli import objective_factory
5858

5959
# Using create
60-
_, f, x0, y0, _ = objective_factory.create(name="penalized_logp_lambo")
60+
problem_info, f, x0, y0, _ = objective_factory.create(name="penalized_logp_lambo")
6161

6262
# An example input
6363
print(x0)

0 commit comments

Comments
 (0)