HowToBuild
When building FARSIGHT for the first time you will need to set up a development environment. FARSIGHT utilizes several large source libraries so ensure that you have at least 25 GiB of HDD space.
Contents |
Choose a Compiler For Your OS
Popular choices are gcc/g++ on Linux, Microsoft Visual Studio 2008/2010 on Windows, and XCode* on Mac OS X.
*To install XCode/gcc on Mac OS X you may need to install the XCode development environment. This software should be available on your OS reinstall/recovery disk. At this time only XCode 3.2 is supported as CMake still does not generate appropriate project files for XCode 4
Install CMake
CMake is a tool which generates the makefiles under Linux, the Visual Studio Solution files (.sln) under Windows, or the XCode project files (.xcodeproj) under Mac OS X. It aims to allow developers to build their projects across different platforms with a minimum of reconfiguration.
Note: If you want to take advantage of multicore building in Visual Studio, you can append /MPn, where n is the number of processors you have. (ie. /MP16 for the Dell T5500 Workstations in the lab) to CMAKE_C_FLAGS and CMAKE_CXX_FLAGS at each CMake configuration screen.
To check the number of processors your computer has, call up the command prompt, type "echo NUMBER_OF_PROCESSORS", and the next line will result in a number. Using a number greater than the number of processors you have will seriously slow down the computer.
Install Subversion
SVN is a version control system used to manage the source code of FARSIGHT.
TortoiseSVN x64 is a popular choice for Windows that integrates into the OS.
Linux & Mac developers typically use the command-line tool svn.
Download FARSIGHT source code
FARSIGHT's SVN Repository is located at:
https://farsight-svn.ee.uh.edu/repos/farsight/
The main line of development is in the "trunk" subdirectory. If you're not interested in downloading test data or branch versions, you can download only the source code by appending "/trunk" to the above path.
https://farsight-svn.ee.uh.edu/repos/farsight/trunk
Windows
- Go to C:\Lab\src
- Right-click to view the folder menu.
- Click SVN Checkout and a window will pop up.
Build FARSIGHT
FARSIGHT depends on Qt, Boost, ITK, VTK, and VXL.
FARSIGHT's SuperBuild system can automatically download & build these dependencies for you.
Please follow the ManualBuild instructions if you'd prefer to setup these dependencies by hand.
What's next?
Checking the Quality Dashboard
When you start contributing code you can monitor if code and tests you build are compiling correctly on the dashboard machines here: http://cdash.org/CDash/index.php?project=Farsight
Submitting results to the Dashboard
You can also submit an experimental build or set up automated builds .
