Skip to content

Commit

Permalink
Add instructions for installing with pip (#885)
Browse files Browse the repository at this point in the history
Add instructions for installing with pip.
  • Loading branch information
tsalo authored Nov 19, 2024
1 parent 789be41 commit c4dd876
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`:

Expand Down

0 comments on commit c4dd876

Please sign in to comment.