Installing fsleyes-plugin-mrs
=============================

Requirements
~~~~~~~~~~~~
This package requires a minimum of FSLeyes 1.0.10. 
Please see the instructions for installing `FSLeyes <https://open.win.ox.ac.uk/pages/fsl/fsleyes/fsleyes/userdoc/install.html>`_

Installation
~~~~~~~~~~~~
This plugin now comes with `FSL <https://www.fmrib.ox.ac.uk/fsl>`_ automatically.

For a separate installation of *fsleyes-plugin-mrs*, you can use one of three methods: GitLab, Conda, or Pypi.

In all cases the *fsleyes-plugin-mrs*  package must be installed into the same environment as FSLeyes is being run from. 
We recommend using the `conda <https://docs.conda.io/en/latest/miniconda.html>`_  or 
`mamba <https://mamba.readthedocs.io/en/latest/>`_ package managers to achieve this.

For more information on loading fsleyes plugins please see the `FSLeyes documentation <https://open.win.ox.ac.uk/pages/fsl/fsleyes/fsleyes/userdoc/plugins.html#loading-installing-fsleyes-plugins>`_

GitLab
------
To install this plugin from GitLab, after activating the target environment (``conda activate my_environment``) run::

    git clone https://git.fmrib.ox.ac.uk/wclarke/fsleyes-plugin-mrs
    cd fsleyes-plugin-mrs
    pip install .

Conda
-----
To install this plugin from conda, after activating the target environment (``conda activate my_environment``) run::

    conda install -c conda-forge fsleyes-plugin-mrs

PyPI
----
To install this plugin from PyPI run::
    
    pip install fsleyes-plugin-mrs