From 5babf3db1e8cdf73cfadecc89613970b5462405e Mon Sep 17 00:00:00 2001 From: PauBadiaM Date: Tue, 5 Sep 2023 16:31:41 +0200 Subject: [PATCH] Added conda install instructions --- README.md | 9 +++++++-- docs/source/installation.rst | 15 ++++++++++++--- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d138099..e775741 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,17 @@ If you have any question or problem do not hesitate to open an [issue](https://g ## Installation -To install the latest stable version run: +`decoupler` can be installed from `pip` (lightweight installation):: ``` pip install decoupler ``` -Alternatively, to stay up-to-date with the newest version, run: +It can also be installed from `conda` and `mamba` (this includes extra dependencies): +``` +mamba create -n=decoupler -c conda-forge -c bioconda decoupler +``` + +Alternatively, to stay up-to-date with the newest unreleased version, install from source: ``` pip install git+https://github.com/saezlab/decoupler-py.git ``` diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 8322f9f..9833df2 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -1,20 +1,29 @@ Installation ============ -**decoupler** requires Python version >= 3.8 to run. +``decoupler`` requires Python version >= 3.8 to run. PyPI ---- -**decoupler** is also available on PyPI: +It can be installed from ``pip`` (lightweight installation): .. code-block:: console pip install decoupler +Conda +----- + +It can also be installed from ``conda`` and ``mamba`` (this includes extra dependencies): + +.. code-block:: console + + mamba create -n=decoupler -c conda-forge -c bioconda decoupler + Development Version ------------------- -To stay up-to-date with the newest version, run: +To stay up-to-date with the newest unreleased version, run: .. code-block:: console