From c4dd8765ce47c3e00aa2eb3b976d451bf1fc5ade Mon Sep 17 00:00:00 2001 From: Taylor Salo Date: Tue, 19 Nov 2024 14:13:30 -0500 Subject: [PATCH] Add instructions for installing with pip (#885) Add instructions for installing with pip. --- docs/installation.rst | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index b790f6e3..8aa21ddf 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -5,13 +5,27 @@ Installation ############ There are two easy ways to use *QSIPrep*: -in a `Docker Container`_, or in a `Singularity Container`_. +as a Python library with PyPi or as a container with Docker or Singularity/Apptainer. Using a local container method is highly recommended. + Once you are ready to run *QSIPrep*, see Usage_ for details. -To install:: - $ pip install --user --upgrade qsiprep-container +************** +Python Library +************** + +To install the *QSIPrep* Python library, use pip:: + + $ pip install --user --upgrade qsiprep + +We strongly discourage installing *QSIPrep* this way, +as *QSIPrep* relies on a number of non-Python dependencies that are difficult to install +and configure on a local system. +Pip will not install these dependencies for you. +Instead, we recommend using the Docker or Singularity/Apptainer containers, +wherein all of the necessary dependencies will come pre-installed and configured. + .. _`Docker Container`: