Differences between revisions 17 and 18
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## page was renamed from QuickInstall

= FreeSurfer Download and Install =

<<TableOfContents>>

== FreeSurfer System Requirements ==
'''Summary of Requirements:'''<<BR>>
Operating System: Linux, macOS<<BR>>
Processor Speed: 2GHz at least<<BR>>
RAM: 8GB recommended<<BR>>
Graphics card: 3D graphics card with its own graphics memory & accelerated OpenGL drivers<<BR>>
Size of installation package: 10GB<<BR>>
Typical size of a processed subject: 300MB<<BR>>
Other requirements: Matlab (only needed to run FS-FAST, the fMRI analysis stream)

== Download ==

'''!FreeSurfer 6.0''' ReleaseNotes

----
'''''Important Note:''' When processing a group of subjects for your study, it is essential to process all your subjects with the same version of !FreeSurfer, on the same OS platform and vendor, and for safety, even the same version of the OS. While we continue to work to ensure that results match across platforms, there are none-the-less system-level libraries that are OS dependent. An exception to this rule is that you may view and edit files across any platform or version, and run some post-processing tools (outside the recon-all stream) if you check with us first (for instance you may run the longitudinal processing with newer versions).''

'''''Important Note for macOS users:''' macOS machines require the installation of XQuartz for !FreeSurfer to work properly.''
 * [[http://xquartz.macosforge.org/downloads/SL/XQuartz-2.7.6.dmg|XQuartz 2.7.6]]
----

||'''OS''' || '''Platform''' || '''Version''' || '''Release Date''' || '''Download''' || '''Size''' ||
|| Linux || CentOS 6 x86_64 (64b)|| stable v6.0.0 || 23 Jan 2016 || [[ftp://surfer.nmr.mgh.harvard.edu/pub/dist/freesurfer/6.0.0/freesurfer-Linux-centos6_x86_64-stable-pub-v6.0.0.tar.gz|freesurfer-Linux-centos6_x86_64-stable-pub-v6.0.0.tar.gz]]||4.6G||
|| macOS || Lion OS X 10.7 (64b Intel) || stable v6.0.0 || 23 Jan 2016 || [[ftp://surfer.nmr.mgh.harvard.edu/pub/dist/freesurfer/6.0.0/freesurfer-Darwin-OSX-stable-pub-v6.0.0.dmg|freesurfer-Darwin-OSX-stable-pub-v6.0.0.dmg]] || 4.4G ||

'''Development Version:''' Daily builds of !FreeSurfer can be downloaded from [[ftp://surfer.nmr.mgh.harvard.edu/pub/dist/freesurfer/dev|here]].

'''Previous Releases:''' Old releases of !FreeSurfer can be downloaded from [[ftp://surfer.nmr.mgh.harvard.edu/pub/dist/freesurfer|here]].

== Installation ==

'''Linux:''' Installing !FreeSurfer on Linux systems involves simply extracting the contents of the .tar.gz file somewhere on your machine. Installing into the directory {{{/usr/local}}} is recommended. For example:

{{{
$> tar -C /usr/local -xzvf freesurfer-Linux-centos6_x86_64-stable-pub-v6.0.0.tar.gz
}}}

'''Mac:''' [[MacOsInstall|Step-by-step]] instructions, including notes on how to bypass the '''unidentified developer''' issue. The default !FreeSurfer installation location on macOS is in the {{{/Applications}}} directory.


== Setup & Configuration ==

To begin using !FreeSurfer, you need to open a terminal window and define and environment variable called '''{{{FREESURFER_HOME}}}''' which is set to the location !FreeSurfer was installed, and then source the setup script. Sourcing !FreeSurfer needs to be done every time you open a new terminal window. Or, you can add the two lines below to your default setup file (.bashrc or .cshrc) and !FreeSurfer will be sourced automatically everytime you open a new window.

'''Linux:'''
{{{
## bash
$> export FREESURFER_HOME=/usr/local/freesurfer
$> source $FREESURFER_HOME/SetUpFreeSurfer.sh

## tcsh
$> setenv FREESURFER_HOME /usr/local/freesurfer
$> source $FREESURFER_HOME/SetUpFreeSurfer.csh
}}}


'''Mac:'''
{{{
$> export FREESURFER_HOME=/Applications/freesurfer
$> source $FREESURFER_HOME/SetUpFreeSurfer.sh
}}}

If done correctly, you should see output similar to this:

{{{
Setting up environment for FreeSurfer/FS-FAST (and FSL)
FREESURFER_HOME /usr/local/freesurfer
FSFAST_HOME /usr/local/freesurfer/fsfast
FSF_OUTPUT_FORMAT nii
SUBJECTS_DIR /usr/local/freesurfer/subjects
MNI_DIR /usr/local/freesurfer/mni
}}}

== License ==
A license key must be obtained to make the !FreeSurfer tools operational. Obtaining a license is free and comes in the form of a license.txt file. Once you obtain the license.txt key file, copy it to your !FreeSurfer installation directory. This is also the location defined by the '''{{{FREESURFER_HOME}}}''' environment variable.

[[https://surfer.nmr.mgh.harvard.edu/registration.html|Follow this link to obtain a license key.]]

== Test your FreeSurfer Installation ==
!FreeSurfer comes with two sample data files (sample-001.mgz and sample-002.mgz) as well as a fully recon-ed subject named bert. These data files can be used to test that your !FreeSurfer installation was done properly. To test your installation, please try the following examples:

'''Example 1:''' Convert the sample-001.mgz to nifti format.

{{{
$> cp $FREESURFER_HOME/subjects/sample-001.mgz .
$> mri_convert sample-001.mgz sample-001.nii.gz
...
reading from sample-001.mgz...
TR=7.25, TE=3.22, TI=600.00, flip angle=7.00
i_ras = (-0, -1, -0)
j_ras = (-0, 0, -1)
k_ras = (-1, 0, 0)
writing to sample-001.nii.gz...
}}}

'''Example 2:''' View the output volumes, surfaces and subcortical segmentation of fully recon-ed subject bert.
{{{
$> cd $FREESURFER_HOME/subjects
$> freeview -v \
    bert/mri/T1.mgz \
    bert/mri/wm.mgz \
    bert/mri/brainmask.mgz \
    bert/mri/aseg.mgz:colormap=lut:opacity=0.2 \
    -f \
    bert/surf/lh.white:edgecolor=blue \
    bert/surf/lh.pial:edgecolor=red \
    bert/surf/rh.white:edgecolor=blue \
    bert/surf/rh.pial:edgecolor=red
}}}

The freeview above command will open the freeview GUI and should look similar to the image below.

{{attachment:freeview_67.jpeg}}

== Additional Resources ==

[[https://surfer.nmr.mgh.harvard.edu/fswiki/Tutorials|Try our tutorials]]

[[https://surfer.nmr.mgh.harvard.edu/fswiki/CourseDescription|Sign up for a FreeSurfer course]]

[[https://surfer.nmr.mgh.harvard.edu/fswiki/FreeSurferSupport|Join the FreeSurfer mailing list, ask a question, or view the archives]]