Integrating recent staging docs content to main docs (#548) (#549)

labdao · Jul 28, 2023 · 87879ea · 87879ea
1 parent 7659bbc
commit 87879ea
Show file tree

Hide file tree

Showing 45 changed files with 1,214 additions and 688 deletions.
diff --git a/docs/docs/getting-started/install-plex.md b/docs/docs/getting-started/install-plex.md
diff --git a/docs/docs/protein-folding/introduction-to-protein-folding.md b/docs/docs/protein-folding/introduction-to-protein-folding.md
diff --git a/docs/docs/protein-folding/open-folder-after-results-14mar23.png b/docs/docs/protein-folding/open-folder-after-results-14mar23.png
diff --git a/docs/docs/protein-folding/overview.md b/docs/docs/protein-folding/overview.md
diff --git a/docs/docs/protein-folding/protein-folding-result-molstar-14mar23.png b/docs/docs/protein-folding/protein-folding-result-molstar-14mar23.png
diff --git a/docs/docs/protein-folding/protein-folding-results-14mar23.png b/docs/docs/protein-folding/protein-folding-results-14mar23.png
diff --git a/docs/docs/protein-folding/protein-folding-results-downloaded-14mar23.png b/docs/docs/protein-folding/protein-folding-results-downloaded-14mar23.png
diff --git a/docs/docs/protein-folding/run-an-example.md b/docs/docs/protein-folding/run-an-example.md
diff --git a/docs/docs/protein-folding/run-with-your-own-data.md b/docs/docs/protein-folding/run-with-your-own-data.md
diff --git a/docs/docs/protein-folding/tools.md b/docs/docs/protein-folding/tools.md
diff --git a/docs/docs/getting-started/_category_.json → docs/docs/quickstart/_category_.json b/docs/docs/getting-started/_category_.json → docs/docs/quickstart/_category_.json
diff --git a/docs/docs/getting-started/available-tools.md → docs/docs/quickstart/available-tools.md b/docs/docs/getting-started/available-tools.md → docs/docs/quickstart/available-tools.md
@@ -9,11 +9,11 @@ Listed below are the tools made available through the PLEX client.
 
 | Tool | Category | Description | Example Command |
 | -------- | -------- | -------- | --- | 
-| [Equibind](https://github.com/labdao/plex/blob/main/tools/equibind.json) | Small Molecule Binding | Docking of small molecules to a protein | `./plex create -t tools/equibind.json -i testdata/binding/abl --autoRun=true` |
-| [Diffdock]( https://github.com/labdao/plex/blob/main/tools/diffdock.json) | Small Molecule Binding | Docking of small molecules to a protein | `./plex create -t tools/diffdock.json -i testdata/binding/abl --autoRun=true` |
-| [RF Diffusion](https://github.com/labdao/plex/blob/main/tools/rfdiffusion.json) | Protein Design | Design protein binders; generally useful for conditional generation of protein backbones | `./plex create -t tools/rfdiffusion.json -i testdata/design --autoRun=true` |
-| [Colabfold](https://github.com/labdao/plex/blob/main/tools/colabfold-mini.json) | Protein Folding | Protein folding prediction | `./plex create -t tools/colabfold-mini.json -i testdata/folding --autoRun=true` |
-| [ODDT](https://github.com/labdao/plex/blob/main/tools/oddt.json) | Small Molecule Binding | Scoring of protein-ligand complexes | `./plex create -t tools/oddt.json -i testdata/scoring/abl --autoRun=true` |
+| [Equibind](https://github.com/labdao/plex/blob/main/tools/equibind.json) | Small Molecule Binding | Docking of small molecules to a protein |  |
+| [Diffdock]( https://github.com/labdao/plex/blob/main/tools/diffdock.json) | Small Molecule Binding | Docking of small molecules to a protein |  |
+| [RF Diffusion](https://github.com/labdao/plex/blob/main/tools/rfdiffusion.json) | Protein Design | Design protein binders; generally useful for conditional generation of protein backbones |  |
+| [Colabfold](https://github.com/labdao/plex/blob/main/tools/colabfold-mini.json) | Protein Folding | Protein folding prediction |  |
+| [ODDT](https://github.com/labdao/plex/blob/main/tools/oddt.json) | Small Molecule Binding | Scoring of protein-ligand complexes |  |
 | [bam2fastq](https://github.com/labdao/plex/blob/main/tools/bam2fastq.json) |  | Sort BAM by qname and Extract Fasta reads R1 R2 with RG using samtools |  |
 
 If there are any additional tools you would like made available in the PLEX client, please see [how to contribute a tool](/get-involved/how-to-contribute-a-tool).
diff --git a/docs/docs/quickstart/installation.md b/docs/docs/quickstart/installation.md
@@ -0,0 +1,42 @@
+---
+title: Install PLEX
+description: How to install PLEX
+sidebar_label: Install PLEX
+sidebar_position: 1
+---
+
+PLEX is a Python package developed by LabDAO that enables you to seamlessly run computational biology tools. PLEX manages all dependencies and installations and requests compute-time from the LabDAO network, ensuring an effortless experience.
+
+:::note
+
+**Time needed:**
+- < 1 minute
+
+**Requirements:**
+- Python 3.8 or higher
+- [pip](https://pip.pypa.io/en/stable/installation/)
+
+:::
+
+## Installation
+
+To install [PLEX](https://pypi.org/project/PlexLabExchange/), run the following command:
+
+```
+pip install PlexLabExchange
+```
+
+If using a Jupyter notebook or Google Colab, you should prefix the command with an exclamation mark:
+
+```
+!pip install PlexLabExchange
+```
+
+**Congratulations.** Welcome to [DeSci](https://ethereum.org/en/desci/).
+
+## Verification
+
+After installation, ensure PLEX is working as expected by running one of the following tools:
+
+- [Small Molecule Binding Tool](../tutorials/small-molecule-binding): A quick-run algorithm; complete a job and visualize results within 5 minutes.
+- [Protein Folding Tool](../tutorials/protein-folding): Comprehensive guide provided for a step-by-step walkthrough.
diff --git a/docs/docs/small-molecule-binding/Gif_-_drag_and_drop_molstar.gif b/docs/docs/small-molecule-binding/Gif_-_drag_and_drop_molstar.gif
diff --git a/docs/docs/small-molecule-binding/InstallationTutorial_Screenshot_of_Molstar.png b/docs/docs/small-molecule-binding/InstallationTutorial_Screenshot_of_Molstar.png
diff --git a/docs/docs/small-molecule-binding/InstallationTutorial_Screenshot_with_outputs.png b/docs/docs/small-molecule-binding/InstallationTutorial_Screenshot_with_outputs.png
diff --git a/.../small-molecule-binding/InstallationTutorial_Screenshot_with_results_folder.png b/.../small-molecule-binding/InstallationTutorial_Screenshot_with_results_folder.png
diff --git a/docs/docs/small-molecule-binding/_category_.json b/docs/docs/small-molecule-binding/_category_.json
diff --git a/docs/docs/small-molecule-binding/binding-files-moved-14mar23.png b/docs/docs/small-molecule-binding/binding-files-moved-14mar23.png
diff --git a/docs/docs/small-molecule-binding/binding-files-ready-14mar23.png b/docs/docs/small-molecule-binding/binding-files-ready-14mar23.png