From 4e8a876b6bf8f739d48f6ff51cc43ae08d054be5 Mon Sep 17 00:00:00 2001 From: Carl Mathias Kobel Date: Mon, 15 Jul 2024 23:38:32 +0200 Subject: [PATCH] Update 10 installation.md --- docs/10 installation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/10 installation.md b/docs/10 installation.md index 0255208..f3a8c34 100644 --- a/docs/10 installation.md +++ b/docs/10 installation.md @@ -39,7 +39,7 @@ Installing into isolated environments is best practice in order to avoid side ef ## Optionally: Testing the installation -Now you will be able to run comparem2. You can use the example data in path "tests/MAGs" to check that everything works. The first time you run comparem2 it will show the message "Pulling singularity image docker://cmkobel/comparem2." This might take some time depending on your network bandwidth as it downloads a +4GB Docker image that contains all the conda environments needed for each analysis. +Now you will be able to run CompareM2. You can use the example data in path "tests/MAGs" to check that everything works. The first time you run CompareM2 it will show the message "Pulling singularity image docker://cmkobel/comparem2." This might take some time depending on your network bandwidth as it downloads a +4GB Docker image that contains all the conda environments needed for each analysis. ```bash @@ -73,7 +73,7 @@ comparem2 ### Shared database -If you are working on a shared computational resource like a laboratory workstation or a HPC you might want to share a database directory so that each user will not have to redundantly download each database. To set this up, the first user must decide on a directory and set reading and writing permissions for the group of users that should be able to use the database. Writing permissions are necessary for the "database representative" flags that snakemake uses to keep track of the presence of the databases. Setting this custom path is a matter of defining the "COMPAREM2_DATABASES" environment variable. You can put this into your ~/.bashrc or execute the command before using comparem2. +If you are working on a shared computational resource like a laboratory workstation or a HPC you might want to share a database directory so that each user will not have to redundantly download each database. To set this up, the first user must decide on a directory and set reading and writing permissions for the group of users that should be able to use the database. Writing permissions are necessary for the "database representative" flags that snakemake uses to keep track of the presence of the databases. Setting this custom path is a matter of defining the "COMPAREM2_DATABASES" environment variable. You can put this into your ~/.bashrc or execute the command before using CompareM2. ```bash export COMPAREM2_DATABASES="/absolute/path/to/shared_databases/comparem2_v2.5.8+" @@ -81,7 +81,7 @@ export COMPAREM2_DATABASES="/absolute/path/to/shared_databases/comparem2_v2.5.8+ ### HPC profiles for Snakemake - If you have experience with snakemake and are working on a high performance computing cluster (HPC), you can modify and use the cluster configuration profiles in the "profiles/" directory. You can define the use of one of these profiles by setting the "COMPAREM2_PROFILE" environment variable. You can put this into your ~/.bashrc or execute the command before using comparem2. You can read more about snakemake profiles [here](https://snakemake.readthedocs.io/en/stable/executing/cli.html#profiles) or browse more default profiles [here](https://github.com/snakemake-profiles). + If you have experience with snakemake and are working on a high performance computing cluster (HPC), you can modify and use the cluster configuration profiles in the "profiles/" directory. You can define the use of one of these profiles by setting the "COMPAREM2_PROFILE" environment variable. You can put this into your ~/.bashrc or execute the command before using CompareM2. You can read more about snakemake profiles [here](https://snakemake.readthedocs.io/en/stable/executing/cli.html#profiles) or browse more default profiles [here](https://github.com/snakemake-profiles). ```bash export COMPAREM2_PROFILE=${COMPAREM2_BASE}/profiles/apptainer/slurm-sigma2-saga