FARSIGHT HowToBuild

Revision as of 17:16, 1 July 2009

 1. Make sure that you downloaded the full FARSIGHT source code
    You can check out a copy from the following location:
    
    svn://www.openworld.rpi.edu/repos/farsight
 
 2. Install CMake 2.6.4 or a later version from:
    Cross Platform Make     

 3. Make sure you have a compiler like g++ or Microsoft Visual C++ (2005, 2008, ...) installed.
    You may need to make changes to your environment variables based on your selection.
    If using MAC OS 10.5.x, make sure that you have the Xcode environment installed.

 4. Install required packages:
    Overview:
    To install VXL,ITK,and VTK, and FARSIGHT first unzip source into folder like C:/VXL/src
    Run CMAKE making sure indicated parameters are correct
    If you are using VC++, Open the .sln file in Visual Studio
    Change to Release mode, and Build ALL, or Debug Mode if you want to use Debugging 

    To install QT use command line scripts described below 

 5. VXL (latest)
    Download it from: Vision-something-Libraries
    Set these OFF or UNCHECK all of the following in CMAKE: 
    BUILD_BRL, BUILD_CONTRIB_VIDL2, BUILD_CONVERSIONS, BUILD_EXAMPLES, 
    EXPAT, BUILD_FOR_VXL_DASHBOARD, BUILD_GEL, BUILD_OUL, BUILD_OXL, BUILD_PRIP,         
    BUILD_SHARED_LIBS, BUILD_TARGETJR, BUILD_TBL, BUILD_TESTING,
    BUILD_UNMAINTAINED_LIBRARIES, BUILD_VGUI set to OFF

 6. ITK (latest)
    Download it from: Segmentation & Registration Toolkit
    Set these OFF or UNCHECK all of the following in CMAKE:
    BUILD_SHARED_LIBS, BUILD_TESTING, BUILD_EXAMPLES, BUILD_DOXYGEN
    Set ITK_USE_SYSTEM_VXL to ON
    See PYTHON.txt if you'd like to enable Python wrapping for ITK
    If using Mac OS 10.5.x use 3.12.0 or later

 7. QT (latest)
    Download it from: [http://www.qtsoftware.com/products A cross-platform application 
    and UI framework] QT comes with mingw by default which includes g++ as a compiler 
    (depending on your selections).
    If you are using VC++ on Windows, make sure that you download the source from:
    QT-Source
    You need to build this source by using VC++ if it is your default compiler.
    In order to compile it with VC++, 
    - Open a VC++ command prompt which will set the environment variables properly and 
      nmake will be available to use if you cannot find it. 
    - Check your system if it is 32 bits or 64 bits.
    - Check if you are using VC++ 2005 or 2008 (or any other version) 

    Enter the following commands which assume that you have VC++ 2005 on a 32 bit OS.
      configure -platform win32-msvc2005
      nmake
    
    If you are using Mac OS 10.5.x enter the commands found at: 
    [1]

    Note: You may need to install and build QT first before building VTK which will require 
    you to set some parameters like VTK_GUI_SUPPORT (Set it to ON or just check it). This will 
    bring another parameter VTK_USE_QVTK which needs to be set to ON again. 
    Then it will ask the desired QT version (Enter only 4 if you are downloading QT4.x.x).
    If you are getting "Qt was not found" message, set QT_QMAKE_EXECUTABLE to the location of 
    qmake.exe. For example, I have it under c:\qt-win-opensource-src-4.5.1\bin\qmake.exe
    Configure it from CMAKE again. It should be able to find QT

8. VTK (latest) (nightly for some QT views)
    Download it from: The Visualization Toolkit
    Set these OFF or UNCHECK all of the following in CMAKE: 
    BUILD_DOCUMENTATION, BUILD_EXAMPLES, BUILD_SHARED_LIBS, BUILD_TESTING

    The embedded python shell needs VTK_USE_GUISUPPORT + VTK_USE_QVTK set to ON
    Tissue Nets needs VTK_USE_BOOST set to ON
    See PYTHON.txt if you'd like to enable Python wrapping for VTK

9. OpenGL
    To compile vessel segmentation you will need openGL, glext.h, and GLUT.
    Your platform probably comes with OpenGL.
    (on Windows with MSVC look in similar path: 
    C:\Program Files (x86)\Microsoft Visual Studio 8 VC\PlatformSDK\Include\gl
    You can download glext.h from here: http://www.opengl.org/registry/.
    Put glext.h in .../GL/ (where gl.h is).
    You will need to get GLUT from here: http://www.opengl.org/resources/libraries/glut/

 10. FARSIGHT
     SET DESIRED MODULES TO ON, WILL TELL YOU IF MISSING LIBRARIES
     Some modules need glut. Therefore, set the desired locations properly for:
     GLUT_INCLUDE_DIR, (ex: C:/Program Files/Microsoft Visual Studio 8/VC/PlatformSDK/Include/gl)
     and GLUT_glut_LIBRARY (ex: C:/Program Files/Microsoft Visual Studio 8/VC/PlatformSDK/Include/gl/glut32.lib)

     THE PACKAGE project does not build automatically, but can be selected and build.
     It requires some type of platform specific program for creating install packages.
     Build PACKAGE to create an install file of Farsight.
     Note: If running the executable results in the following error, you may need to add 
     the QT bin directory to the system path on your OS.
     "QtGui4.dll was not found"

This page was prepared by Aytekin Vargun (with Isaac Abbott's contributions)