/**

\page Installation Installation Guidelines

The following steps describe the whole procedure to build and install the PHI Estimator (PHI-E). 

<h2>1. Dependencies</h2>

Before building PHI-E, the following software libraries are required to be installed. <strong>Please note</strong> that to build in Windows, CMake needs to be used an appropriate compiler (Win32 or Win64 version of Visual Studio is recommended). The selected solution platform is needed to match with dependent libraries.

<table border="0">
	<tr>
    <td width="10%"><strong>Package</strong></td>      
	  <td width="10%"><strong>Version</strong></td>      
    <td width="80%"><strong>Description</strong></td>  
	</tr>
	<tr>
		<td>C++ compiler</td>
		<td></td>
		<td>(MSVC/11.x, MSVC/12.x, GCC/4.8.1, GCC/4.9.2)</td>
	</tr>
	<tr>
		<td><a href="http://www.cmake.org/">CMake</a></td>
		<td>2.8.4 or higher</td>
		<td>To compile and build PHI-E and its dependencies</td>
	</tr>
  <tr>
		<td><a href="http://qt-project.org/downloads">Qt</a></td>
		<td>4.8.x</td>
		<td>The main GUI interface for PHI Estimaotr. Download and install the precompiled library. For <b>Windows</b>, consider visiting <a href="http://www.npcglib.org/~stathis/blog/precompiled-qt4-qt5/">this page</a> to download the precompiled library.</td>
	</tr>
	<tr>
		<td><a href="http://www.vtk.org/files/release/5.6/">VTK</a></td>
		<td>5.6.1 - 5.10.1</td>
		<td>Install Qt before setting VTK up. Enable the <b>VTK_USE_QT</b> option</td>
	</tr>
	<tr>
		<td><a href="http://www.itk.org/ITK/resources/software.html">ITK</a></td>
		<td>4.7 or higher</td>
		<td>Build VTK before proceeding to ITK. During CMake configuration, enable <b>Module_ITKVtkGlue</b></td>
	</tr>
	<tr>
		<td><a href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</a></td>
		<td></td>
		<td>For documentation only</td>
	</tr>
</table>

<h2>2. Build & Installation</h2>

Please follow commands below in a shell/terminal (e.g., <a href="http://www.gnu.org/software/bash/">Bash</a>). They will configure and build PHI-E using <a href="http://www.gnu.org/software/make/">GNU Make</a>. The main CMake configuration file (CMakeLists.txt) is located in the root directory of the package.

<h3>2.1 Extract source files and create the build directory</h3>
\verbatim
tar xzf PHIEstimator-${version}-source.tar.gz
mkdir PHIEstimator-${version}-build
cd PHIEstimator-${version}-build
\endverbatim
[Note: In Windows, an appropriate compression program (e.g., <a href="http://www.7-zip.org/">7-zip</a>) might be used to extract the files.]

<h3>2.2 Run CMake to configure the build tree</h3>
\verbatim
cmake ../PHIEstimator-${version}-source
\endverbatim
Use the CMake variable CMAKE_INSTALL_PREFIX to specify the installation
directory, as in:
\verbatim
cmake -DCMAKE_INSTALL_PREFIX=/opt/software/geodesic ../PHIEstimator-${version}-source
\endverbatim

For <b>Windows</b>, open CMake-GUI and select <code>PHIEstimator-${version}-source</code> as the "source" directory and select <code>PHIEstimator-${version}-build</code> as the "build" directory. Click on "Configure" and select the appropriate C++ compiler. If there weren't any configuration errors, click "Generate".

CMake should be able to find ITK, VTK and Qt libraries if they are specified in the <code>$PATH</code> variable in your environment. If you have custom installation directories, then ensure that they have been added to the <code>$PATH</code> variable or point the variables <b>ITK_DIR</b>, <b>VTK_DIR</b> and <b>QT_QMAKE_EXECUTABLE</b> to the appropriate paths (for ITK and VTK, point it to the directory where <code>ITKConfig.cmake</code> is present).

This step will generate a Make file for GCC and a Visual Studio solution file for MSVC.

<h3>2.3 Build</h3>
\verbatim
make
\endverbatim
For <b>Windows</b>, you should launch the generated solution file of Visual Studio (by default, only <code>Release</code> version of the code will be compiled - if this needs to be changed, it can be done so by editing the variable <code>CMAKE_CONFIGURATION_TYPE</code> during the CMake configuration step), and then build solution.

<h3>2.4 Test (optional)</h3>
To perform tests, the BUILD_TESTING option in the CMake configuration needs to be enabled.
\verbatim
make test
\endverbatim
For <b>Windows</b>, you should build the RUN_TESTS project.

In case of failing tests, re-run the tests, but this time by executing <a href="http://www.cmake.org/cmake/help/v2.8.8/ctest.html">CTest</a> directly with the '-V' option to enable verbose output and redirect the output to a text file, as in the example below:
\verbatim
ctest -V >& PHIEstimator-test.log
\endverbatim
And send the file 'PHIEstimator-test.log' as attachment of the issue report to sbia-software@uphs.upenn.edu

<h3>2.5 Install (optional)</h3>
\verbatim
make install
\endverbatim
For <b>Windows</b>, you should build the INSTALL project.

Upon the success of the above compilation and build process, PHIEstimator is installed into the directory specified by the CMAKE_INSTALL_PREFIX, which was set during step 2.2 above.
*/