diff --git a/README.md b/README.md index 9afd2f2f6cfb8a71c9a0dd1f0ce59b8699b263ab..1d5563b3267d0efc7d3ae58533aaa8420a6f088e 100755 --- a/README.md +++ b/README.md @@ -51,6 +51,7 @@ Installation - [pip](#pypi) - [cloning github repository](#clone) - [singularity](#singularity) +- [conda](#conda) Running - [Quick run](#run) @@ -145,6 +146,19 @@ To get latest version: It will replace your file panacota.img by a new one corresponding to the latest version. +### <a name="conda"></a> From conda + +Be careful while using conda, especially if you are not familiar with it. We advise to install PanACoTA in a dedicated conda environment, in order to avoid unwanted interactions with other softwares (like needed versions of dependencies automatically installed by conda). To install the package, use `conda install -c bioconda panacota`. But, as described in [conda documentation](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#id6), we advise to install it with: + + # Create an environment: This creates the 'myenv' environment in '/envs/'. No packages will be installed in this environment. + conda create --name myenv + # Activate the environment + conda activate myenv + # Install PanACoTA + conda install -c bioconda panacota + # When you have finished using PanACoTA, deactivate environment + conda deactivate + ### From zip version For people wanting to download source code of a specific version, we provide releases. You can download last one here: [](https://github.com/gem-pasteur/PanACoTA/releases) diff --git a/doc/source/starting.rst b/doc/source/starting.rst index cc4dc5dc59dd958fbb84d1ba51687f57ee9014d3..7ca923a159248c4a9cd560a6e76c9da8b3ef0799 100755 --- a/doc/source/starting.rst +++ b/doc/source/starting.rst @@ -134,6 +134,24 @@ To get latest version: It will replace your file ``panacota.img`` by a new one corresponding to the latest version. +From conda +********** + +Be careful while using conda, especially if you are not familiar with it. We advise to install PanACoTA in a dedicated conda environment, in order to avoid unwanted interactions with other softwares (like needed versions of dependencies automatically installed by conda). To install the package, use ``conda install -c bioconda panacota``. But, as described in `conda documentation <https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#id6>`_, we advise to install it with: + +.... code-block:: bash + + source + # Create an environment: This creates the 'myenv' environment in '/envs/'. No packages will be installed in this environment. + conda create --name myenv + # Activate the environment + conda activate myenv + # Install PanACoTA + conda install -c bioconda panacota + # When you have finished using PanACoTA, deactivate environment + conda deactivate + + From zip version ****************