FRAT/Install Guide

From KitwarePublic
< FRAT
Revision as of 22:15, 11 August 2011 by Gabe.hart (talk | contribs)
Jump to navigationJump to search

__NOTITLE__


(F)luid (R)egistration and (A)tlas (T)oolkit


Home




For Users




For Developers




Contact Us

Installation Guide

WARNING: FRAT is currently a work in progress and is under no mandate to maintain backward compatibility.

Dependencies

  • FRAT is configured and built using CMake. A basic understanding of CMake is assumed. Documentation and tutorials can be found at [1]. In this walkthrough, we demonstrate configuration at the linux command line. The CMake GUI can also be used in Windows or Linux.
  • FRAT requires a full setup of the Insight Toolkit (ITK), GenerateCLP, and a working FFTW setup. The easiest way to get ITK and GenerateCLP is to do a complete install of TubeTK. For build instructions, go here. For FFTW installation instructions, go here.

Download FRAT Source Code

NOTE: Currently FRAT is available only as source. Binary executables may be available in the future.

  • Create the directory for your FRAT setup. We'll refer to it as FRAT_DIR for the sake of clarity.
  • In FRAT_DIR, clone the repository
cd FRAT_DIR
git clone git://gitorious.org/frat/frat.git
  • After cloning you should now have a FRAT_DIR/frat/ directory

Configure build

  • First, create a build directory and enter it. Typically this will live alongside the source directory.
mkdir build
cd build
  • Now, use cmake to configure the build
ccmake FRAT_DIR/frat
  • You will now be presented with the cmake configuration interface. Press 'c' to run the initial configuration.
  • You will initially be presented with errors since the paths to ITK and GenerateCLP probably won't be immediately found.
  • If you built ITK and GenerateCLP by building TubeTK (assuming TubeTK built with SuperBuild in TubeTK_BUILD_DIR), set the paths as:
ITK_DIR                TubeTK_BUILD_DIR/GenerateCLP-Build
GenerateCLP_DIR        TubeTK_BUILD_DIR/Insight-Build
  • By default, only the test applications are enabled. To build the entire toolkit, set
COMPILE_APPLICATIONS   ON
COMPILE_TESTING        ON
  • For further control, individual executables (tests and applications) can be enabled or disabled in the advanced options. Press (t) to toggle the advanced view on.
  • Once the option to generate is presented, press (g) to generate the build files

Build

  • This is the easy part. Just run make (optionally with a -j flag for parallel compilation)
make -j4
  • To build the Doxygen documentation, enable BUILD_DOCUMENTATION in CMake and build the "doc" target
make doc