install.rst 1.42 KB
Newer Older
William Clarke's avatar
William Clarke committed
1
2
3
Installation Instructions
=========================

William Clarke's avatar
William Clarke committed
4
FSL-MRS can currently be installed using two methods.
William Clarke's avatar
William Clarke committed
5
6
7

1. From GitLab
~~~~~~~~~~~~~~
William Clarke's avatar
William Clarke committed
8
Download or clone from |fslmrs_gitlab|_. To get FSL-MRS with example data and example Jupyter notebooks, download the full package from gitlab. `Git LFS <https://git-lfs.github.com/>`_ must be installed to download package data.
William Clarke's avatar
William Clarke committed
9

10
11
::

William Clarke's avatar
William Clarke committed
12
    git clone --recurse-submodules https://git.fmrib.ox.ac.uk/fsl/fsl_mrs.git
13
14
    cd fsl_mrs
    pip install .
William Clarke's avatar
William Clarke committed
15
16
17
18

2. From Conda
~~~~~~~~~~~~~

19
The primary installation method is via *conda*. After installing conda and creating or activating a suitable `enviroment <https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html>`_ you can install FSL-MRS from the FSL conda channel.
William Clarke's avatar
William Clarke committed
20

21
22
23
24
25
::

    conda install -c conda-forge \
                  -c https://fsl.fmrib.ox.ac.uk/fsldownloads/fslconda/channel/ \
                  fsl_mrs
William Clarke's avatar
William Clarke committed
26

27
28
29
30
31
spec2nii
~~~~~~~~
To convert data to NIfTI install the spec2nii program from conda.

::
William Clarke's avatar
William Clarke committed
32

33
    conda install -c conda-forge spec2nii
William Clarke's avatar
William Clarke committed
34
35
36
37
38


Operating systems
~~~~~~~~~~~~~~~~~
FSL-MRS has been tested throughly on Mac and Linux operating systems. FSL-MRS dependencies and FSL-MRS is availible on native Windows installations, but has not currently been tested. `Windows Subsytem for Linux <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_ (or WSL2) offers a Linux interface on Windows. FSL-MRS has been tested on WSL.