Differences between revisions 15 and 43 (spanning 28 versions)
Revision 15 as of 2016-04-21 16:09:35
Size: 3339
Editor: ZekeKaufman
Comment:
Revision 43 as of 2016-07-12 11:49:25
Size: 4444
Editor: ZekeKaufman
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
Describe FsTutorial/CourseSetup_easy here.
Line 4: Line 2:
Notes on how to do the physical setup of the computers and stuff for the course. Also see [[FreesurferCourseAdminNotes]] This purpose of this page is to describe how one would go about setting up laptops (or workstations) for a Freesurfer course.
Line 8: Line 6:
== Laptop Hardware ==
 * Laptop hardware should meet or exceed the recommended [[SystemRequirements|System Requirements]] for running freesurfer.
== Hardware ==
 * Laptops/workstations should have hardware which meet or exceed the recommended [[SystemRequirements|System Requirements]] for running freesurfer.
 * Laptops/workstations should have internet access. (For following course tutorials and performing last minute updates of the data set)
Line 11: Line 10:
 * Laptops should have internet access. (For following course tutorials and performing last minute updates of the data set)
Line 13: Line 11:
== Laptop Software ==
 * Laptops should have the [[Download|"Development Version"]] of freesurfer installed either locally, or via a central server.
 * Laptops should have a recent versions of [[http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FslInstallation|FSL]] installed either locally, or via a central server.
== Software ==
 * Laptops/workstations should have the tutorial [[ftp://surfer.nmr.mgh.harvard.edu/pub/dist/freesurfer/tutorial_versions/|Development Version]] of freesurfer installed either locally, or via a central server.
 * Laptops/workstations should have a recent version of [[http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FslInstallation|FSL]] installed either locally, or via a central server. (FSL is required for the [[https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/Diffusion|Diffusion]] and [[https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/Tracula|TRACULA]] tutorials)
Line 18: Line 16:
Line 20: Line 17:
 * Laptops should have access to the "Lightweight" version of freesurfer [[FsTutorial/Data|tutorial data]] either downloaded locally, or via a central server, or external storage device (thumb drive, external hard drive, etc). Note that it is important for each laptop to have access its own sandboxed version of the data, with read/write access, because course participants will be creating files within their workspace.  * Laptops/workstations should have access to the "Lightweight" version of freesurfer [[FsTutorial/Data|tutorial data]] either downloaded locally, or via a central server, or external storage device (thumb drive, external hard drive, etc). Note that it is important for each laptop to have access its own sandboxed version of the data, with read/write access, because course participants will be creating files within their workspace.
Line 23: Line 20:
 * The following lines should be added to a {{{.bashrc}}} file in the users home directory so that freesurfer is automatically sourced (and other environment variable set) whenever a terminal window is opened.  * The following lines should be added to a {{{.bashrc}}} file in the users home directory so that freesurfer is automatically sourced (and other environment variables set) whenever a terminal window is opened.
Line 26: Line 23:

## Set location of tutorial location
## Set location of tutorial data
Line 30: Line 26:
## Set location of FSL (Required for Diffusion tutorial only) ## Set location of FSL (Required for Diffusion and TRACULA tutorials only)
Line 33: Line 29:
## Set location of Matlab and other variable (Required for FSFAST tutorial only) ## Set location of Matlab and other Matlab/FSFAST related variables (Required for FSFAST tutorial only)
Line 37: Line 33:
export LD_LIBRARY_PATH="$LD_LIBRARY_PATH":"$FS_MCRROOT/sys/os/glnxa64"  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH":"$FS_MCRROOT/sys/os/glnxa64"
Line 45: Line 41:
Line 47: Line 42:
Line 49: Line 43:
 * Once the steps above have been taken, the best an most reliable way to test your setup is simply to run thru one or more of the many freesurfer [[https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial|tutorials]].
 * A more automated way to test your setup is to run the {{{test_tutorials.sh}}} script. This script comes with freesurfer and can be run in the following ways:
 * Make sure the TUTORIAL_DATA environment variable is set correctly by typing {{{ls $TUTORIAL_DATA}}} in a terminal window. You should see the output below:
Line 53: Line 46:
  $> <source_freesurfer>
  
  # Display help
  $> test_tutorials.sh --help
$> ls $TUTORIAL_DATA
buckner_data fsfast-functional
diffusion_recons fsfast-tutorial.subjects
diffusion_tutorial long-tutorial
}}}
 * Once you verify freesurfer is sourced correctly and the TUTORIAL_DATA environment variable is set correctly, the best and most reliable way to test your setup is simply to run thru one or more of the [[https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial|tutorials]].
 * A more automated way to test your setup is to run the [[https://surfer.nmr.mgh.harvard.edu/pub/dist/freesurfer/patches/test_tutorials.sh|test_tutorials.sh]] script. The script can be run in the following ways (after sourcing freesurfer and properly setting TUTORIAL_DATA):
Line 58: Line 54:
  # Run a quick test
  $> test_tutorials.sh -
{{{
#
# Run a quick test
$> test_tutorials.sh -quick
Line 61: Line 58:
## If the above command runs to completion without crashing then you're probably
## all set. But the following commands can be used to test specific tutorials.
Line 62: Line 61:
## Run the Multi-Modal Integration tutorial
$> test_tutorials.sh -multimodal
Line 63: Line 64:
## Run the TRACULA tutorial
$> test_tutorials.sh -tracula
Line 64: Line 67:

## Display help and other options
$> test_tutorials.sh -help

FreeSurfer Course Setup

This purpose of this page is to describe how one would go about setting up laptops (or workstations) for a Freesurfer course.

Hardware

  • Laptops/workstations should have hardware which meet or exceed the recommended System Requirements for running freesurfer.

  • Laptops/workstations should have internet access. (For following course tutorials and performing last minute updates of the data set)
  • In addition to the listed System Requirements, laptops should have 17" screens to facilitate viewing of images on the screen.

Software

  • Laptops/workstations should have the tutorial Development Version of freesurfer installed either locally, or via a central server.

  • Laptops/workstations should have a recent version of FSL installed either locally, or via a central server. (FSL is required for the Diffusion and TRACULA tutorials)

  • Optional: If the course is doing the FSFAST tutorial, than laptops should have the Matlab runtime installed (version 8.3, no license required). However, the commands requiring Matlab have been marked and can be skipped because the output data has already been provided. So Matlab is not an absolute requirement.

Tutorial Data

  • Laptops/workstations should have access to the "Lightweight" version of freesurfer tutorial data either downloaded locally, or via a central server, or external storage device (thumb drive, external hard drive, etc). Note that it is important for each laptop to have access its own sandboxed version of the data, with read/write access, because course participants will be creating files within their workspace.

Startup Script

  • The following lines should be added to a .bashrc file in the users home directory so that freesurfer is automatically sourced (and other environment variables set) whenever a terminal window is opened.

## Set location of tutorial data
export TUTORIAL_DATA=<location_of_tutorial_data>

## Set location of FSL (Required for Diffusion and TRACULA tutorials only)
export FSLDIR=<location_of_fsl_installation>

## Set location of Matlab and other Matlab/FSFAST related variables (Required for FSFAST tutorial only)
export FS_MCRROOT=<location_of_matlab_installation>
export LD_LIBRARY_PATH="$LD_LIBRARY_PATH":"$FS_MCRROOT/runtime/glnxa64"
export LD_LIBRARY_PATH="$LD_LIBRARY_PATH":"$FS_MCRROOT/bin/glnxa64"
export LD_LIBRARY_PATH="$LD_LIBRARY_PATH":"$FS_MCRROOT/sys/os/glnxa64"
export FS_SPMREG_USE_BIN=1
export FS_MKCON_USE_BIN=1
export FS_SXA3_USE_BIN=1

## Source freesurfer
export FREESURFER_HOME=<location_of_freesurfer_installation>
source $FREESURFER_HOME/SetUpFreeSurfer.sh

Testing

  • Make sure the TUTORIAL_DATA environment variable is set correctly by typing ls $TUTORIAL_DATA in a terminal window. You should see the output below:

$> ls $TUTORIAL_DATA
buckner_data                    fsfast-functional
diffusion_recons                fsfast-tutorial.subjects
diffusion_tutorial              long-tutorial
  • Once you verify freesurfer is sourced correctly and the TUTORIAL_DATA environment variable is set correctly, the best and most reliable way to test your setup is simply to run thru one or more of the tutorials.

  • A more automated way to test your setup is to run the test_tutorials.sh script. The script can be run in the following ways (after sourcing freesurfer and properly setting TUTORIAL_DATA):

## Run a quick test
$> test_tutorials.sh -quick

## If the above command runs to completion without crashing then you're probably
## all set. But the following commands can be used to test specific tutorials.

## Run the Multi-Modal Integration tutorial
$> test_tutorials.sh -multimodal

## Run the TRACULA tutorial
$> test_tutorials.sh -tracula

## Display help and other options
$> test_tutorials.sh -help

FsTutorial/CourseLaptopSetup (last edited 2017-03-30 11:01:12 by ZekeKaufman)