From 5fb5c6fc4d918ed0b68934511dd05bf31afb6022 Mon Sep 17 00:00:00 2001 From: Gabriel Gerez Date: Wed, 5 Jun 2024 09:59:22 +0200 Subject: [PATCH] Add conda installation --- docs/installation.rst | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/installation.rst b/docs/installation.rst index a2337e6..250d130 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -6,7 +6,17 @@ Installation Prerequisites ============= +We recommend to use an environment manager like conda to install **VAMPyR** and its prerequisites. +To set up an environment named `vamp-env` and activating it using conda we can run: +``` +conda create -n vamp-env +conda activate vamp-env +``` +Other environment managers are also possible, but we will not cover them here. + + +We will work from this environment for the rest of the installation process. Install options =============== @@ -15,7 +25,12 @@ From conda ---------- The easiest way to install **VAMPyR** is to use the conda package manager. -You can install **VAMPyR** by running: +You can install **VAMPyR** by running the following commmand while in the `vamp-env` environment: +``` +conda install -c conda-forge vampyr +``` +This should install **VAMPyR** and all its dependencies. To use **VAMPyR** in a script or a Jupyter notebook, you can simply follow the instructions in the notebooks. + From source -----------