README.TXT 4.46 KB
Newer Older
Mark Hymers's avatar
Mark Hymers committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
Install Other Packages
Before you can compile IFrIT, you need to install other packages that
IFrIT uses: 

    * Required: Kitware VTK (Visualization Toolkit for 3D
      visualizations, public domain). IFrIT has been ported to VTK
      version 4.4 to VTK 5.0. Version 5 is still somewhat buggy, but
      it adds capabilities to create movies directly and to use 3D
	textures for volume rendering. Do not download later versions 
	(so-called Nightly releases), they might not compile or function
      properly.
      Installation Notes:
          o VTK must be compiled with Hybrid and Parallel classes (set
      both to ON when configuring VTK with cmake). 
          o I suggest you compile VTK with shared libraries (that is
      not the default option in VTK). Compiling with static libraries
      may require editing Makefiles manually (but, hopefully, will
      not). 
          o MacOS: users may try to include X11 classes in the VTK
      installations (VTK option VTK_USE_X) if they have problems with
      the VTK installation. If you compile VTK with shared libraries,
      make sure to add the VTK library directoriy ($VTKDIR/bin) to the
      environment variable DYLD_LIBRARY_PATH prior to installing
      VTK. Otherwise, you will get errors of libraries not being
      found. 
          o Cygwin: make sure to set VTK_USE_X during VTK
      installation, otherwise cmake will create a Windows VTK version.  

    * Optional: Trolltech Qt (a multi-platform GUI library, open
      source). IFrIT has been ported to Qt versions from 3.0.4 to
      4.1.4 (I recommend using Qt 3, version 4 does not add any new
	capabilities that I use, and is somewhat slower than version 3).
      Mac users should get a free Mac version of Qt, do not use the
      X11 version. 

      Important: Qt is needed for GUI support. Without Qt, only the
      command-line version of IFrIT will be available. 
      Installation Notes:
          o Qt must be compiled with thread support (use option
      -thread when configuring Qt prior to compiling). 
          o MacOS: If you compile Qt with shared libraries (default
      option), make sure to add the Qt library directory ($QTDIR/lib)
      to the environment variable DYLD_LIBRARY_PATH prior to
      installing Qt. Otherwise, you will get errors of libraries not
      being found. 
          o Cygwin: Good luck with compiling Qt under cygwin - it is
      possible, but requires editing source files (search for helpful
      tricks on IFrIT website). Keep in mind that neither Trolltech
      nor I support Qt under cygwin. After IFrIT is ported to Qt 4.0,
      there will be a Windows native free version of IFrIT.  

Compile IFrIT
To compile IFrIT, follow the steps:

    * Untar IFrIT source file, and place it in a temporary directory.
    * Set the environment variables VTKDIR to point to the VTK root
      directory. If you use Qt, the environment variable QTDIR should
      also be defined (it is defined automatically, if Qt is installed
      correctly), and Qt bin directory ($QTDIR/bin) should be in your
      path. 
    * Switch to ifrit-NNN/build directory (where NNN is the version of
      IFrIT).  
    * Use CMake to configure IFrIT - since you installed VTK, you
      should have a working version of CMake too. The simplest way to
      configure IFrIT is to run non-interactive CMake: 

         % cmake .

      If you would like to use CMake options to disable some of the
      components or need more control over the build process (if, for
      example, some of the standard libraries are not in standard
      places), you can run CMake interactively: 

         % cmake -i .

      (in the command-line mode) or

         % ccmake .

      for the GUI mode (ccmake is called CMakeSetup.exe under
      Windows). In most cases configuring in GUI mode reduces to
      pressing "c" a few times, and then pressing "g". If CMake
      complains about VTK changing compiler switches, accept VTK
      choice. If completed successfully, CMake will create a Makefile
      in the current directory. 
    * Compile IFrIT by executing

         % make

      (or gmake). It will take some time to compile. The executable is
      called "ifrit" and is located in the main source directory (one
      level above build). Move it into your personal bin
      directory. The executable is self-containing, it does not need
      any other files to run (but you can use external files to modify
      IFrIT behavior).  

97
Enjoy! Do not forget to glance through the User Guide!