Differences between revisions 10 and 20 (spanning 10 versions)
Revision 10 as of 13:41:14 25-04-2017
Size: 3713
Comment:
Revision 20 as of 11:05:41 04-08-2023
Size: 3723
Editor: PaulMcCarthy
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
The `fslinstaller.py` script carries out the installation of FSL, configuring your environment to enable you to run FSL from a terminal (`/Applications/Utilities/Terminal.app`) window.

if you use Mathworks' MATLAB it will configure your `startup.m` file to allow you to use the FSL MATLAB functions and
on macOS platforms it will also install FSLEyes and FSLView into `/Applications`.
The `fslinstaller.py` script carries out the installation of FSL, configuring your environment to enable you to run FSL from a terminal window (e.g. (`/Applications/Utilities/Terminal.app` on macOS). The `fslinstaller,py` source code can be viewed [[https://git.fmrib.ox.ac.uk/fsl/conda/installer|here]].
Line 7: Line 5:
{{{#!wiki warning
'''Administrative privileges may be required'''

Installation into certain folders on your computer (e.g. the default, `/usr/local`) may require administrative privileges. If this is the case, the installer will attempt to gain these privileges through the use of the `sudo` command, which will require you to enter your password for verification. If you don't have permission to use `sudo` (an administration account on macOS) then the installer will fail and will need to either install into a folder belonging to your user or to run the installer as the `root` user. Should you install as `root` see the [[FslInstallation/ShellSetup|configuring your account for FSL]] section for details on how to use the installer to setup your user account for FSL.
}}}
Line 20: Line 13:
In the terminal change to the folder containing the fslinstaller.py file and run it with python; assuming that you wish to install into `/usr/local` (the default) then just press the Return key when the installer asks where to install to. For example if you downloaded to your `Downloads` folder: In the terminal change to the folder containing the `fslinstaller.py` file and run it with python; assuming that you wish to install into `~/fsl/` (the default) then just press the Return key when the installer asks where to install to. For example if you downloaded to your `Downloads` folder:
Line 26: Line 19:
<<Anchor(python2_required)>> <<Anchor(python_name)>>
Line 28: Line 21:
The installer '''requires''' python 2.x to run which is the default on macOS and Centos 6 & 7, if you have installed python version 3 and made it the default when you run `python` then you will need to run it with a python 2 version, you can often find this as:
 * /usr/bin/python
 * python27
 * python2.7
 * python26
 * python2.6
Some systems do not have a command called `python`, and will print errors like `python: command not found`. If this happens try calling `python3 fslinstaller.py` or `python2 fslinstaller.py`.

Some versions of macOS do not have Python installed by default - if you do not have any Python command available, you can download an installer from https://www.python.org. Alternately, Python will be installed as part of Xcode, which you can install by running `sudo xcode-select --install`.

If you experience SSL certificate errors on macOS, try running the installer with `/usr/bin/python fslinstaller.py` or `/usr/bin/python3 fslinstaller.py`. If you have installed Python separately from https://www.python.org, make sure you have run the ''Install certificates'' script, as described [[https://bugs.python.org/issue43404#msg388144|here]].
Line 39: Line 31:
if you use Mathworks' MATLAB it will configure your `startup.m` file to allow you to use the FSL MATLAB functions.

{{{#!wiki note
'''Installing FSL into a different location'''

By default, FSL is installed into your user account home directory (at `~/fsl/`), and so does not require administrative privileges. If you wish to install FSL to a different location (e.g. `/usr/local/fsl/`), or are installing FSL on a multi-user system, you may need to enter your administrator password before the installation can proceed. You can run the `fslinstaller.py` script as described above - the script will prompt you for your password when necessary.

If you do not have permission to use `sudo` then the installer will fail and you will need to either install into a folder belonging to your user or to run the installer as the `root` user. Should you install as `root`, see the [[FslInstallation/ShellSetup|configuring your account for FSL]] section for details on how to setup your user account for FSL.
}}}

Line 40: Line 43:
The installer has some advanced options which may be of use, particularly when scripting installs.
 * -d specify folder to install FSL into (without 'fsl'), e.g. ''/usr/local''
 * -e only configure your account for running FSL
 * -E configure FSL for all users (Linux)
 * -v print installer version number and exit
 * -c check for updated versions of FSL
 * -l list versions of FSL available for download
 * -V install specified version number e.g. ''5.0.10''
 * -s download the source code for the current, or specified version of FSL
 * -f download the FEEDS data set for the current, or specified version of FSL
 * -q silence all messages
 * -p skip environment setup
 * -D switch on debug messages - use this option to generate logging that can be included when requesting installation support
Line 54: Line 44:
You can automate the installation process using the -q and -d options to prevent questions being asked and to specify the install location respectively. The installer has some advanced options which, amongst other things, allows you to:
 * customise the FSL installation location.
 * automate the FSL installation - this is useful if you would like to call the installer from an automated script.

Type `python fslinstaller.py -h` for a list of all available options.

FSL Install Script

The fslinstaller.py script carries out the installation of FSL, configuring your environment to enable you to run FSL from a terminal window (e.g. (/Applications/Utilities/Terminal.app on macOS). The fslinstaller,py source code can be viewed here.

Running the installer (on macOS or Linux)

The installer requires access to the internet to be able to download the FSL software appropriate for your platform and runs from within a terminal session, so you need to open a terminal:

  • Linux (Centos 7)
    • The Terminal application can be found in Applications > Utilities > Terminal menu

  • macOS
    • The Terminal application can be found in /Applications/Utilities

In the terminal change to the folder containing the fslinstaller.py file and run it with python; assuming that you wish to install into ~/fsl/ (the default) then just press the Return key when the installer asks where to install to. For example if you downloaded to your Downloads folder:

cd ~/Downloads
python fslinstaller.py

Some systems do not have a command called python, and will print errors like python: command not found. If this happens try calling python3 fslinstaller.py or python2 fslinstaller.py.

Some versions of macOS do not have Python installed by default - if you do not have any Python command available, you can download an installer from https://www.python.org. Alternately, Python will be installed as part of Xcode, which you can install by running sudo xcode-select --install.

If you experience SSL certificate errors on macOS, try running the installer with /usr/bin/python fslinstaller.py or /usr/bin/python3 fslinstaller.py. If you have installed Python separately from https://www.python.org, make sure you have run the Install certificates script, as described here.

Once the install completes Linux users should log out (System (top right icon) > Log out) and log back in to complete the FSL setup. If you are accessing the Linux computer via a remote SSH session then close the SSH session and re-login. Apple macOS users should open a new terminal window to begin using FSL.

if you use Mathworks' MATLAB it will configure your startup.m file to allow you to use the FSL MATLAB functions.

Installing FSL into a different location

By default, FSL is installed into your user account home directory (at ~/fsl/), and so does not require administrative privileges. If you wish to install FSL to a different location (e.g. /usr/local/fsl/), or are installing FSL on a multi-user system, you may need to enter your administrator password before the installation can proceed. You can run the fslinstaller.py script as described above - the script will prompt you for your password when necessary.

If you do not have permission to use sudo then the installer will fail and you will need to either install into a folder belonging to your user or to run the installer as the root user. Should you install as root, see the configuring your account for FSL section for details on how to setup your user account for FSL.

Advanced Options

The installer has some advanced options which, amongst other things, allows you to:

  • customise the FSL installation location.
  • automate the FSL installation - this is useful if you would like to call the installer from an automated script.

Type python fslinstaller.py -h for a list of all available options.

 

FslInstallation/FslInstaller (last edited 11:05:41 04-08-2023 by PaulMcCarthy)