diff --git a/README.md b/README.md index 3240a5e..acf6aff 100644 --- a/README.md +++ b/README.md @@ -27,13 +27,20 @@ Read [our paper](https://doi.org/10.1128/mSystems.00920-20) on phyloFlash. [Conda](https://conda.io/docs/) is a package manager that will also install dependencies that are required if you don't have them already. -phyloFlash is distributed through the [Bioconda](http://bioconda.github.io/) channel on Conda. +phyloFlash is distributed through the [Bioconda](http://bioconda.github.io/) +channel on Conda. According to the [Conda documentation](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html), it is recommended to install all packages at the same time to avoid dependency conflicts, and to create new environments instead of installing to the base environment. +We also recommend using [Mamba](https://mamba.readthedocs.io/en/latest/) as a +drop-in substitute for Conda. It implements a more effective dependency solver +and is also the default Conda frontend for the pipeline managers Snakemake. +Conda sometimes fails to solve the environment, and in these cases Mamba +usually works. + ```bash # If you haven't set up Bioconda already conda config --add channels defaults @@ -44,6 +51,8 @@ conda config --set channel_priority strict # Create new environment named "pf" with phyloflash # Sortmerna is an optional dependency conda create -n pf phyloflash sortmerna=2.1b +# If Conda is unable to solve the environment; requires mamba in base env +mamba create -n pf phyloflash sortmerna=2.1b ``` ### Download from GitHub diff --git a/docs/index.md b/docs/index.md index bbe9048..0bb997a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -44,6 +44,12 @@ it is recommended to install all packages at the same time to avoid dependency conflicts, and to create new environments instead of installing to the base environment. +We also recommend using [Mamba](https://mamba.readthedocs.io/en/latest/) as a +drop-in substitute for Conda. It implements a more effective dependency solver +and is also the default Conda frontend for the pipeline managers Snakemake. +Conda sometimes fails to solve the environment, and in these cases Mamba +usually works. + ```bash # If you haven't set up Bioconda already conda config --add channels defaults @@ -54,6 +60,8 @@ conda config --set channel_priority strict # Create new environment named "pf" with phyloflash # sortmerna is an optional dependency conda create -n pf phyloflash sortmerna=2.1b +# If Conda is unable to solve the environment; requires mamba in base env +mamba create -n pf phyloflash sortmerna=2.1b ``` ### Download from GitHub diff --git a/docs/install.md b/docs/install.md index 2c99dd9..4dc7e92 100644 --- a/docs/install.md +++ b/docs/install.md @@ -36,6 +36,12 @@ it is recommended to install all packages at the same time to avoid dependency conflicts, and to create new environments instead of installing to the base environment. +We also recommend using [Mamba](https://mamba.readthedocs.io/en/latest/) as a +drop-in substitute for Conda. It implements a more effective dependency solver +and is also the default Conda frontend for the pipeline managers Snakemake. +Conda sometimes fails to solve the environment, and in these cases Mamba +usually works. + ```bash # If you haven't set up Bioconda already conda config --add channels defaults @@ -46,6 +52,8 @@ conda config --set channel_priority strict # Create new environment named "pf" with phyloflash # sortmerna is an optional dependency conda create -n pf phyloflash sortmerna=2.1b +# If Conda is unable to solve the environment; requires mamba in base env +mamba create -n pf phyloflash sortmerna=2.1b ``` In some cases, `conda install` can hang on the "Solving environment" step. This