/**

\page Installation Installation

These tutorials focus on writing good C++ code for medical imaging and machine learning and such have similar requirements as compared to any other C++ package.

## 1. Dependencies

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="7%"><strong>Package</strong></td>      
    <td width="7%"><strong>Version</strong></td>      
  <td width="100%"><strong>Description</strong></td>  
  </tr>
  <tr>
    <td>Archiver</td>
    <td>n/a</td>
    <td><a href="http://www.gzip.org/">gzip</a> is recommended. <br><b>Windows Users</b>: <a href="http://www.7-zip.org/">7-zip</a></td>
  </tr>
  <tr>
    <td>C++ compiler</td>
    <td>n/a</td>
    <td>MSVC/11.x, MSVC/12.x, GCC/4.8.1, GCC/4.9.2 are supported. MSVC/13+ and GCC/5+ are <b>NOT</b> supported</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 CaPTk and its dependencies</td>
  </tr>
  <tr>
    <td><a href="http://www.itk.org/">ITK</a></td>
    <td>4.10 or higher</td>
    <td>Build VTK and GDCM before proceeding to compile ITK. Instructions to compile ITK are given <a href="http://www.itk.org/Wiki/ITK/Configuring_and_Building">here</a>.</td>
  </tr>
  <tr>
    <td><a href="http://opencv.org/downloads.html">OpenCV</a></td>
    <td>3.0 or higher</td>
    <td>All machine learning algorithms. This generally comes pre-compiled; if not found for your system, steps similar to those done for ITK compilation can be followed.</td>
  </tr>
</table>

Ensure all dependencies are met before proceeding. 

## 2. Build

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 CaPTk 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.

### 2.1 Extract source files and create the build directory

\verbatim
tar xzf ${tutorial}-source.tar.gz
mkdir ${tutorial}-build
cd ${tutorial}-build
\endverbatim
<b>Windows Users</b>: an appropriate compression program (e.g., <a href="http://www.7-zip.org/">7-zip</a>) might be used to extract the files.

### 2.2  Run CMake to configure the build tree

\verbatim
cmake ../${tutorial}-source
\endverbatim

<b>Windows Users</b>: open CMake-GUI and select <code>CaPTk-${version}-source</code> as the "source" directory and select <code>CaPTk-${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 the dependencies 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 variable(s) <b>${Dependency}_DIR</b> to the appropriate build paths where <b>${Dependency}Config.cmake</b> is/are present (for example, in the case of ITK, point <code>ITK_DIR</code> to the directory where <code>ITKConfig.cmake</code> is present) - this should be either the build directory or the installation directory. If you are using a bash shell, it can be done using the following command:

\verbatim
cmake -DITKDIR=${path_to_custom_ITK_build_dir} ${tutorial}-source
\endverbatim

<b>Windows Users</b>: set the variables <code>ITK_DIR</code> using the CMake-GUI.

This step will generate compiler-specific project files (for example, Make file for GCC and Visual Studio solution file for MSVC). For a full list of generators, please see <a href="https://cmake.org/cmake/help/v3.0/manual/cmake-generators.7.html">CMake documentation on generators</a></td>. 

### 2.3 Compile the project

\verbatim
make
\endverbatim

<b>Windows Users</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.

### 2.4 [OPTIONAL] Compile the documentation

To build the documentation from scratch, the <code>BUILD_DOCUMENTATION</code> option in the CMake configuration needs to be enabled.

\verbatim
make doc
\endverbatim

<b>Windows Users</b>: build the <b>doc</b> project in the loaded solution.

Now you are ready to run the awesome tutorial. Good luck!


<div align="right"><a href="Usage.html"><b>Next (Usage)<b></a>

*/
