add installdoc

gen_doc/LaTeX/chapInstallUnix.tex

+\chapter{Installation for Unix platform}\label{sec:InstallUnix}
+
+\paragraph{}The FA$\mu$ST project is based on an C++ library available for both UNIX and Windows environments. CMake has been choose to build the project FA$\mu$ST because it is an open-source, cross-platform family of tools designed to build, test and package software.
+
+\paragraph{}This chapter presents the steps to install the FA$\mu$ST tools on the Unix platform (both Linux and Mac OS). First section \ref{sec:UnixGettingStarted} presents the basic installation of FA$\mu$ST and second section \ref{sec:UnixCustomInstall} corresponds to the advanced  installation.
+
+\section{Getting Started}\label{sec:UnixGettingStarted}
+
+\subsection{Required tools}\label{sec:RequiredTools}
+
+\begin{itemize}
+\item CMake : (tested with version 3.4.3 cf. website \url{https://cmake.org/})
+\item Matlab : (tested with version 2014 and 2015)
+The use of the mex function in Matlab requires that you have a third-party compiler installed on your system. The latest version of Matlab (2016a in our case) only supports up to GCC 4.7 (see \url{http://fr.mathworks.com/support/compilers/R2016a/index.html?sec=glnxa64} for more detail). Please adjust your version of GCC compiler in order to run the installation properly. 
+You must too have matlab in your environment PATH. If not please add. 
+
+\item \textit{OPTIONAL} The use of GPU process in FAUST project required the drivers for NVIDIA and CUDA install. You must have nvcc in your environment PATH. If not please add.
+\end{itemize}
+
+\paragraph{}Please export following variable:
+\begin{itemize}
+\item CC with gcc (example: "\texttt{export CC='/usr/lib64/ccache/gcc'}") 
+\item CXX with g++ (example: "\texttt{export CXX=/usr/lib64/ccache/g++}
+\end{itemize}
+
+\subsection{Required packages}\label{sec:RequiredPackages}
+
+\paragraph{}Here is a list of packages used in the FA$\mu$ST project. Normally, the installation of this packages are automatically done (see the directory "./externals").
+\begin{itemize}
+\item eigen
+\item openBlas
+\item xml2
+\item matio
+\end{itemize}
+
+\subsection{Basic build and installation}\label{sec:UnixBuildInstall}
+\paragraph{}When prerequisities listed in precedent sections are checked, the FA$\mu$ST installation can be done : 
+
+\begin{itemize}
+\item Download the FA$\mu$ST package on the website :  \url{http://faust.gforge.inria.fr/}
+\item Open a command terminal
+\item Place you in the FA$\mu$ST directory, and type the following commands : 
+\begin{lstlisting}
+mkdir build
+cd build
+cmake ..
+make
+make install
+\end{lstlisting}
+\end{itemize}
+
+\paragraph{}When using the \texttt{cmake} command to generate the build system, Cmake performs a list of tests to determine the system configuration and manage the build system. If the configuration is correct then the build system is generated and written. In this case the three last lines of the console log of cmake command should be: \\
+\texttt{... \\
+-- Configuring done \\
+-- Generating done \\
+-- Build files have been written to: ./build}
+
+\paragraph{}The command \texttt{make} will compile the build files.
+
+\paragraph{}The command \texttt{make install} will install in default directory.
+
+
+
+\section{Custom - Advanced Installation}\label{sec:UnixCustomInstall}
+
+\paragraph{}The project FA$\mu$ST can be configured with optional parameters, for example if you want to install FA$\mu$ST in a different folder or to enable the parallel computing using multithread capacities provided by the OS. This build system can be parametrized using the Cmake Graphical User Interface, or the Cmake command line tools. 
+
+\paragraph{}The Cmake Graphical User Interface ccmake allows you to selected option input. When using the \texttt{ccmake} command in your build directory, the Cmake GUI appears in the console (see figure \ref{fig:ccmake}).
+
+\begin{figure}[!htbp]
+\label{fig:ccmake}
+\includegraphics[scale=0.5]{images/ccmake.jpg}
+\end{figure}
+
+\paragraph{}When scrolling on a value and pressing [enter], this value can be edited, the black underlaid row displays some information about the option and required path to create the build system. In the case of an option press [enter] to toggle the ON/OFF values.
+\paragraph{}After choosing options for the build and setting the required fields, press [c] to configure. The configuration of the build system is checked again by Cmake, at the end of this check if the build settings are correct, you can press [g] in order to generate the build system.
+	
+
+\paragraph{} Instead the ccmake GUI, an other possibility to configure and generate the project is to use the command line cmake which can take the option input. Here is the list of available options: 
+\texttt{$cmake\ ..\ -D<BUILD\_NAME>=<ON/OFF>$}
+
+\begin{itemize}
+\item BUILD\_TESTING : Enable the ctest option (default value is ON)
+\item BUILD\_DOCUMENTATION : Generating the doxygen documentation (default value is OFF)  
+\item BUILD\_MULTITHREAD : Enable multithread with OpenMP Multithreading (default value is OFF)
+\item BUILD\_VERBOSE : Enable verbose option when compile (-v) (default value is OFF)
+\item BUILD\_DEBUG : Enable FAUST Debug mode (default value is OFF )
+\item BUILD\_USE\_GPU : Using both CPU and GPU process ( default value is OFF)
+\item BUILD\_MATLAB\_MEX\_FILES : Enable building Matlab MEX files (default value is ON)
+\item BUILD\_OPENBLAS : Using openBLAS for matrix and vector computations (default value is OFF )
+\item BUILD\_READ\_XML\_FILE : Using xml2 library to read xml files (default value is OFF)
+\item BUILD\_READ\_MAT\_FILE : Using matio library to read mat files (default value is OFF)
+\end{itemize}
+
+\paragraph{}Following the selected option, the cmake installer automatically checks the dependent component (library OpenBlas, eigen, matio, libxml2).  
+
+\section{Build using Code Block}\label{sec:UnixInstallCodeBlock}
+progress...

gen_doc/LaTeX/chapInstallWindows.tex

+\chapter{Installation for Windows platform}\label{sec:WinInstall}
+
+\paragraph{}The FA$\mu$ST project is based on an C++ library available for both UNIX and Windows environments. CMake has been choose to build the project FA$\mu$ST because it is an open-source, cross-platform family of tools designed to build, test and package software.
+
+\paragraph{}This chapter presents the steps to install the FA$\mu$ST tools on the Windows platform. First section \ref{sec:WinGettingStarted} presents the basic installation of FA$\mu$ST and second section \ref{sec:WinCustomInstall} corresponds to the advanced  installation.
+
+
+\section{Getting Started} \label{sec:WinGettingStarted}
+
+\subsection{Required tools}\label{sec:WinRequired}
+The installation of the FA$\mu$ST tools depends on other components to be installed in order to run properly. 
+\begin{enumerate}
+
+\item \textbf{Install CMake} for building the FA$\mu$ST tools. 
+From \url{https://cmake.org/download/}, download Binary distributions correspond to your environment (in our case  cmake-3.6.1-win64-x64.zip). The directory of binary must be add to the environment PATH of your system if you want to use the cmake command line tool. 
+
+\item \textbf{Install 7-Zip} from \url{http://www.7-zip.org/}. 7-Zip is a file archiver used to extract external library files. Please verify that \texttt{7z.exe} is present in your environment PATH of your system.
+
+\item \textbf{Install Matlab} if not already done (MATLAB R2015b in our case). The builder of the FA$\mu$ST tools automatically checks your Matlab root directory if your \texttt{matlab.exe} is present in your environment Path and/or if your Matlab installation has been performed in a default directory like \texttt{"C:/Program Files/MATLAB/<R2015b>/bin/matlab.exe"} or \texttt{"C:/Program Files (x86)/MATLAB/<R2015b>/bin/matlab.exe"}. In case of several versions of Matlab installed in your system, you can force the directory of your preferred version of Matlab using the following system variable : \\
+\texttt{MATLAB\_EXE\_DIR="C:/Program Files/MATLAB/<R2015b>/bin/matlab.exe"}
+
+\textit{Note for the case of using the compiler MinGW :} In Matlab, you must install MinGW version 4.9.2 from MATLAB using the \textbf{ADDON menu}. For more detail, please follow the instruction given in following link :  
+\url{http://fr.mathworks.com/help/matlab/matlab_external/install-mingw-support-package.html}. For that, you must have a id session for Mathwork. It is easy to create. 
+Current this latest step, an environment variable called MW\_MINGW64\_LOC is automatically generated. 
+
+\item \textbf{Install C++ Compiler:} Both \textbf{Microsoft visual C++} and \textbf{MinGW "Minimalist GNU for Windows"} compiler have been tested. If you are friendly with Unix tools and command line terminal, preferd \textbf{MinGW "Minimalist GNU for Windows"} C++ compiler. Otherwise, if you are more familiar with the graphical user interface, preferred the \textbf{Microsoft visual C++} compiler. The version of the C++ compilers must be coherent with the version of your Matlab version. In this documentation, the version of our C++ compiler corresponds to Matlab 2014 and 2015. If you use an other version of Matlab, please refers to the Mathworks website \url{http://fr.mathworks.com/support/compilers/<R20XXa>}.
+
+\paragraph{}For \textbf{Microsoft visual C++} installation :
+\begin{itemize}
+\item Download and install Microsoft Visual C++ 2013 professional from \url{https://www.microsoft.com/en-US/download/details.aspx?id=44916}
+% \item Download and install Microsoft .NET Framework 4
+% \item Download and install Microsoft SDK 7.1
+\end{itemize}
+
+\paragraph{}For \textbf{MinGW} installation :
+\begin{itemize}
+\item Download Mingw in \url{https://sourceforge.net/projects/mingw/files/latest/download?source=files}
+\item Launch install file and choose MINGW version 4.9.2 for mexFunction compatibility 
+\item The directory of binary must be add to the environment PATH. 
+
+\item \textit{Note for make tool :} In a terminal command, type \texttt{make}. if it doesn't exist, please check if \textbf{make.exe} file is present in MINGW install directory. if not, you can copy and rename mingw32-make.exe to make.exe
+\end{itemize}
+
+\end{enumerate}
+
+
+\subsection{Required packages}\label{sec:WinRequiredPackages}
+\paragraph{}Here is a list of packages used in the FA$\mu$ST project. There are nothing to do because the installation of this packages are automatically done (see the directory "./externals").
+\begin{itemize}
+\item \textbf{Eigen} is a C++ template library for linear algebra: matrices, vectors, numerical solvers, and related algorithms. (see \url{http://eigen.tuxfamily.org})
+
+\end{itemize}
+
+
+\subsection{Basic build and Installation}\label{sec:WinBasicInstall}
+\paragraph{}When prerequisites listed in precedent section \ref{sec:WinRequired} are checked, the FA$\mu$ST installation can be done. 
+First download the FA$\mu$ST package on the website  \url{http://faust.gforge.inria.fr/}. 
+
+Depending to your C++ compiler (MinGW or Visual studio), refers to the right part and follow the given instructions.
+
+\paragraph{}In the case of \textbf{MinGW compiler} :
+Open a command terminal and place you in the FAUST directory. Type the following commands : 
+\begin{lstlisting}
+mkdir build
+cd build
+cmake -G "MinGW Makefiles" .. 
+make
+make install
+\end{lstlisting}
+
+
+
+\paragraph{}In the case of \textbf{Microsoft Visual Studio 2013 compiler using the Graphical Users Interfaces}:
+\begin{enumerate}
+\item Open application \texttt{cmake-GUI.exe} from the program menu or from your cmake install binaries directory  to launch the CMake configuration application:
+
+\begin{figure}[!h] %%[!htbp]
+\centering
+\includegraphics[scale=0.5]{images/cmakeGUI-1.eps}
+\caption{cmake GUI}
+\label{fig:cmakeGUI-1}
+\end{figure}
+
+
+\item Set the "Where is the source code:" text box with the path of the directory where the source files are located (F:/WORK/FAUST/faust) and the "Where to build the binaries:" with the path of the directory where you want to build the library and executable files (F:/WORK/FAUST/faust/build). (see \ref{fig:cmakeGUI-1}).
+
+When clicking for the first time on the [Configure] button, CMake will ask for the build tool you want to use. The build system type depends on the builder you want to use, in our case this is the Visual Studio X (X depending the version of Visual installed on the computer) chain tools. (see \ref{fig:cmakeGUI-2}).
+
+
+\begin{figure}[!h]
+\centering
+\includegraphics[scale=0.5]{images/cmakeGUI-2.eps}
+\caption{cmake GUI}
+\label{fig:cmakeGUI-2}
+\end{figure}
+
+\item When pressing again the [Configure] button to configure the build system, CMake performs a list of tests to determine the system configuration and manage the build system. If the configuration is correct then no pop-up will appears during the tests and CMake finally shows the various options of the build underlaid in grey. In case of a configuration issue, a pop up window warns you about this issue indicating which test has failed, in this case the build option in the CMake application software will be underlaid in red. We will discuss in Section \ref{sec:WinCustomInstall} what to do in such a case, but let us for the moment assume that everything ran smoothly.
+(see \ref{fig:cmakeGUI-4}).
+
+\begin{figure}[!h] %%[!htbp]
+\centering
+\includegraphics[scale=0.5]{images/cmakeGUI-4.eps}
+\caption{cmake GUI}
+\label{fig:cmakeGUI-4}
+\end{figure}
+
+\item Once the build system configured then generated, you have to actually build FAUST, using Visual Studio.
+\item Open file "faust.sln" with visual studio 
+\item Click right on Target ALL\_BUILD and select generated 
+\item Click right on Target INSTALL and select generated 
+\item Click right on Target CTEST and select generated 
+\end{enumerate}
+
+
+
+\paragraph{}In the case of \textbf{Microsoft Visual Studio 2013 compiler using the command terminal} :
+Open a command terminal and place you in the FAUST directory. Type the following commands : 
+\begin{lstlisting}
+mkdir build
+cd build
+cmake .. 
+cmake --build . --config "Release" --target "install"
+\end{lstlisting}
+
+
+\section{Custom - Advanced Installation}\label{sec:WinCustomInstall}
+
+progress... 
+
+
+