From b16840e09903777853f7ff8f4ada764e67c1048d Mon Sep 17 00:00:00 2001 From: Noah Date: Mon, 21 Aug 2023 15:06:25 -0400 Subject: [PATCH] installation docs --- docs/getting_started/installation.rst | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/getting_started/installation.rst b/docs/getting_started/installation.rst index 492bc14..4976825 100644 --- a/docs/getting_started/installation.rst +++ b/docs/getting_started/installation.rst @@ -25,7 +25,7 @@ https://youtu.be/9CCnaLlUFG4 - +Quick intro about Iliad Google Cloud Platform server - Linux ==================================================================== @@ -38,19 +38,18 @@ Next, follow along this video when creating your GCP Virtual Machine (VM) Instan +Install, configure, and run Iliad on GCP -Step 1: Install Snakemake and Snakedeploy -***************************************** +Step 1: Install Conda and Snakemake +*********************************** -Snakemake and Snakedeploy are best installed via the `Mamba package manager `_ (a newer package manager for Conda replacement). -From our testing, Conda is perfectly fine as an alternative, and you can use them interchangeably below. -If you have neither Conda nor Mamba, it can be installed via `Mambaforge `_. +Conda and Snakemake are best installed via the `Miniconda package manager `_ (a newer package manager for Conda). +From our testing, Mamba and micromamba are perfectly fine as alternatives, and you can use them interchangeably below. +If you have neither Conda nor Mamba, it can be installed via `conda-forge `_. For other options see `here `_. -You will need to add Mamba to PATH so follow their instructions_ for such. - -Here is my suggested install guidance for Conda: +Here is my suggested install guidance for Conda on GCP VM instance: .. code-block:: console @@ -61,7 +60,7 @@ Here is my suggested install guidance for Conda: $ conda init bash $ source ~/.bashrc -Given that Mamba (or Conda) is installed, run the following in your command line interface tool +Given that Conda (or Mamba) is installed, run the following in your command line interface tool (i.e. `Putty `_, `MacOS Terminal `_, or `VS Code `_). @@ -71,7 +70,7 @@ If you need guidance for a specific platform you are using, see the specific `pl $ conda create -c conda-forge -c bioconda --name iliadEnv snakemake=7.19.0 snakedeploy openpyxl pandas -to install Snakemake, Snakedeploy, and a necessary python library for parsing user input tables in an isolated environment. +to install Snakemake and necessary python libraries. For all following commands ensure that this environment is activated via