feat: docs on foldseek

Venom-Biochem-Lab · Feb 28, 2024 · 327da76 · 327da76
1 parent dc82434
commit 327da76
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/backend.md b/docs/backend.md
@@ -130,3 +130,17 @@ https://github.com/xnought/venome/assets/65095341/c44f1d8c-0d58-407c-9aa2-29c4a9
 
 
 this is where you can see print statements and other debug info / errors.
+
+## Foldseek
+
+For similarity search we use [Foldseek](https://github.com/steineggerlab/foldseek). 
+
+Without foldseek installed nothing will be computed and no errors. No harm at all.
+
+However if you want to add foldseek run
+
+```bash
+./run.sh add_foldseek
+```
+
+to the docker container and then it will compute.
diff --git a/docs/run.md b/docs/run.md
@@ -57,6 +57,8 @@ or
 | `psql` | Opens up a direct terminal into the database to execute SQL commands live |
 | `upload_all` | Uploads all the pdb files to the system via POST requests |
 | `delete_all` | Deletes all protein entries and restarts the server from scratch |
+| `add_foldseek` | installs foldseek onto the docker container via wget |
+| `remove_foldseek` | deletes foldseek from the docker container |
 
 There are actually many more functions, so please check out [`run.sh`](../run.sh).