HowToBuild

Revision as of 16:26, 9 April 2012

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.

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.

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 /MP to CMAKE_C_FLAGS and CMAKE_CXX_FLAGS at each CMake configuration screen.

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.

Download the latest TortoiseSVN x64

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

If subversion gives you a warning about an untrusted source, please accept the exception. Farsight currently does not have a signed certificate for its SSL service.

Windows

1. Go to C:\Lab\farsight_src
2. Right-click to view the folder menu.
3. Click SVN Checkout and a window will pop up.

SVN Checkout Farsight to the desired folder.

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 .