Differences between revisions 22 and 38 (spanning 16 versions)
Revision 22 as of 2011-05-12 17:42:44
Size: 2750
Comment:
Revision 38 as of 2022-03-28 13:47:57
Size: 2214
Editor: AndrewHoopes
Comment:
Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:
The InternalFreeSurferDistributions are FreeSurferStable and FreeSurferDev. Please see ReleasePolicy for information on the release policy for these distributions.
Line 8: Line 8:
Here are instructions on how to set-up your environment to use the InternalFreeSurferDistributions. Here are instructions on how to set-up your environment to use the Internal !FreeSurfer Distributions.
Line 10: Line 10:
All computers on the Martinos Center NMR network should have the directory '''/usr/local/freesurfer'''. Inside there, you will see the files '''nmr-stable-env''' and '''nmr-dev-env'''. Sourcing these will set up your environment to use the stable or dev version, respectively. For example, to use the stable version, which is what most users should do, use the following setup command: The Internal !FreeSurfer Distributions are 'stable' and 'dev'. All computers on the Martinos Center NMR network should have the directory '''/usr/local/freesurfer'''. Inside there, you will see the file '''fsenv'''. Sourcing this will set up your environment to use the stable or dev versions. For example, to use the current stable version (7.2.0), which is what most users should do, use the following setup command:

'''Version 7.2.0:'''
{{{
$> source /usr/local/freesurfer/fsenv 7.2.0
}}}

'''dev:'''
{{{
$> source /usr/local/freesurfer/fsenv dev
}}}

'''NOTE:''' Do not put this command in your .cshrc or .bashrc file! If /usr/local/freesurfer is down for whatever reason, then your login will not work.

You should see your prompt change and your environment will be set up to run !FreeSurfer. Note that the programs may appear to be in a different location. That's OK, because {{{/usr/local/freesurfer}}} is actually a link to a platform specific version that resides in a different directory, much like how {{{/usr/pubsw}}} works. If you don't know what this means, don't worry.

Your {{{FREESURFER_HOME}}} will actually be {{{/usr/local/freesurfer/7.2.0}}} or {{{/usr/local/freesurfer/dev}}}, etc... so if you'd like to set {{{FREESURFER_HOME}}} manually and without changing your prompt, you can still do so:
Line 13: Line 29:
$ source /usr/local/freesurfer/nmr-stable-env
}}}
## csh
$> setenv FREESURFER_HOME /usr/local/freesurfer/7.2.0
$> source $FREESURFER_HOME/SetUpFreesurfer.csh
Line 16: Line 33:
You should see the prompt change to {{{(nmr-stable-env)}}} and your environment should then be set up to run FreeSurfer. Note that the programs may appear to be in a different location:

{{{
$ which tkmedit
/space/freesurfer/centos4.0/stable/bin/tkmedit
}}}

That's OK, because {{{/usr/local/freesurfer}}} is actually a link to a platform specific version that resides in a different directory, much like how {{{/usr/pubsw}}} works. If you don't know what this means, don't worry.

Your {{{FREESURFER_HOME}}} will actually be {{{/usr/local/freesurfer/stable}}} or {{{/usr/local/freesurfer/dev}}}, so if you'd like to set {{{FREESURFER_HOME}}} manually, you can still do so.

You can suppress output from sourcing these scripts with the {{{FS_FREESURFERENV_NO_OUTPUT}}} environment variable:

{{{
setenv FS_FREESURFERENV_NO_OUTPUT
}}}

You can keep the prompt from changing to {{{(nmr-stable-env)}}} or {{{(nmr-dev-env)}}} by setting {{{FSENV_KEEP_PROMPT}}}:

{{{
setenv FSENV_KEEP_PROMPT
## bash
$> export FREESURFER_HOME=/usr/local/freesurfer/7.2.0
$> source $FREESURFER_HOME/SetUpFreesurfer.sh
Line 41: Line 40:
For instructions on how to '''freeze''' one of these releases, see MakingPrivateCopiesOfDistributions. Users are strongly encouraged to "Freeze" their copy of !FreeSurfer in a project-specific directory like their SUBJECTS_DIR. To make a copy, just download the public distribution from ftp://surfer.nmr.mgh.harvard.edu/pub/dist/freesurfer
Line 45: Line 44:
There are the older versions that are still available for compatibility, but will soon be removed. For instructions on how to make a local copy of one of these versions for your private use, see MakingPrivateCopiesOfObsoleteDistributions.

There are three older internal distributions of FreeSurfer available at the NMR Center. To use a distribution, set your FREESURFER_HOME environment variable to the directory of the distribution and then source the Free``Surfer``Env.csh file in that distribution. For example:

{{{
setenv FREESURFRER_HOME ~inverse/freesurfer_alpha
source $FREESURFER_HOME/FreeSurferEnv.csh
}}}

Note that you may still have to set up your path. Be sure you are using the right binaries with the {{{which}}} command.
There are the older versions that are still available for compatibility, see the Archives section of the public download page.

top

FreeSurfer Distributions for Internal Users

Distributions

Access

Here are instructions on how to set-up your environment to use the Internal FreeSurfer Distributions.

The Internal FreeSurfer Distributions are 'stable' and 'dev'. All computers on the Martinos Center NMR network should have the directory /usr/local/freesurfer. Inside there, you will see the file fsenv. Sourcing this will set up your environment to use the stable or dev versions. For example, to use the current stable version (7.2.0), which is what most users should do, use the following setup command:

Version 7.2.0:

$> source /usr/local/freesurfer/fsenv 7.2.0

dev:

$> source /usr/local/freesurfer/fsenv dev

NOTE: Do not put this command in your .cshrc or .bashrc file! If /usr/local/freesurfer is down for whatever reason, then your login will not work.

You should see your prompt change and your environment will be set up to run FreeSurfer. Note that the programs may appear to be in a different location. That's OK, because /usr/local/freesurfer is actually a link to a platform specific version that resides in a different directory, much like how /usr/pubsw works. If you don't know what this means, don't worry.

Your FREESURFER_HOME will actually be /usr/local/freesurfer/7.2.0 or /usr/local/freesurfer/dev, etc... so if you'd like to set FREESURFER_HOME manually and without changing your prompt, you can still do so:

## csh
$> setenv FREESURFER_HOME /usr/local/freesurfer/7.2.0
$> source $FREESURFER_HOME/SetUpFreesurfer.csh

## bash
$> export FREESURFER_HOME=/usr/local/freesurfer/7.2.0
$> source $FREESURFER_HOME/SetUpFreesurfer.sh

Frozen Version

Users are strongly encouraged to "Freeze" their copy of FreeSurfer in a project-specific directory like their SUBJECTS_DIR. To make a copy, just download the public distribution from ftp://surfer.nmr.mgh.harvard.edu/pub/dist/freesurfer

Obsolete Versions

There are the older versions that are still available for compatibility, see the Archives section of the public download page.

InternalFreeSurferDistributions (last edited 2022-03-28 13:47:57 by AndrewHoopes)