Skip to content

Commit

Permalink
Add conda installation
Browse files Browse the repository at this point in the history
  • Loading branch information
Gabrielgerez committed Jun 5, 2024
1 parent 376d776 commit 5fb5c6f
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
===============
Expand All @@ -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
-----------
Expand Down

0 comments on commit 5fb5c6f

Please sign in to comment.