Mentions légales du service

Skip to content
Snippets Groups Projects
Commit ebf58863 authored by Adrien Leman's avatar Adrien Leman Committed by hhakim
Browse files

doc latex

parent 59ae6ccd
No related branches found
No related tags found
No related merge requests found
...@@ -5,8 +5,8 @@ Here is a list of packages used in the FA$\mu$ST project. The installation of th ...@@ -5,8 +5,8 @@ Here is a list of packages used in the FA$\mu$ST project. The installation of th
\begin{itemize} \begin{itemize}
\item Library \textbf{Eigen} \url{http://eigen.tuxfamily.org}: C++ template library for linear algebra: matrices, vectors, numerical solvers, and related algorithms. \item Library \textbf{Eigen} \url{http://eigen.tuxfamily.org}: C++ template library for linear algebra: matrices, vectors, numerical solvers, and related algorithms.
\item Library \textbf{OpenBLAS} \url{http://www.openblas.net}: Optimized BLAS library based on GotoBLAS2 1.13 BSD version. \item Library \textbf{OpenBLAS} \url{http://www.openblas.net}: Optimized BLAS library based on GotoBLAS2 1.13 BSD version.
\item Library \textbf{xml2} \url{http://xmlsoft.org} % \item Library \textbf{xml2} \url{http://xmlsoft.org}
\item Library \textbf{matio} \url{https://sourceforge.net/projects/matio} % \item Library \textbf{matio} \url{https://sourceforge.net/projects/matio}
\end{itemize} \end{itemize}
\section{Compatibility between MATLAB and gcc compiler}\label{sec:ANNEXECompatibilityMatlabCompiler} \section{Compatibility between MATLAB and gcc compiler}\label{sec:ANNEXECompatibilityMatlabCompiler}
...@@ -116,3 +116,23 @@ You can generated the target using the terminal command \texttt{xcodebuild} : ...@@ -116,3 +116,23 @@ You can generated the target using the terminal command \texttt{xcodebuild} :
\end{lstlisting} \end{lstlisting}
\section{Optional FAuST installation using GPU process}\label{sec:OptionalGPU}
The toolbox FA$\mu$ST integrates optional Graphics Processing Unit (GPU) to improve its performances.
\paragraph{Warning:} This optional GPU install has only be realized on an Linux machine. There is no guarantee that the installation and the use will be effective for every system.
\begin{itemize}
\item \textbf{Install} the CUDA Toolkit and the drivers for NVIDIA.
\item \textbf{Verify install} of GPU tools by typing in a terminal :
\lstset{style=customBash}
\begin{lstlisting}
> which nvcc
\end{lstlisting}
You must obtain the path of your \texttt{nvcc} compiler like
\begin{lstlisting}
/usr/local/cuda-7.5/bin/nvcc
\end{lstlisting}
If not, add \texttt{nvcc} directory in your environment path (in your ~/.bashrc file).
\end{itemize}
...@@ -299,11 +299,11 @@ Instead the ccmake GUI, an other possibility to configure and generate the proje ...@@ -299,11 +299,11 @@ Instead the ccmake GUI, an other possibility to configure and generate the proje
\item BUILD\_MULTITHREAD : Enable multithread with OpenMP Multithreading (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\_VERBOSE : Enable verbose option when compile (-v) (default value is OFF)
\item BUILD\_DEBUG : Enable FA$\mu$ST Debug mode (default value is OFF ) \item BUILD\_DEBUG : Enable FA$\mu$ST Debug mode (default value is OFF )
\item BUILD\_USE\_GPU : Using both CPU and GPU process ( default value is OFF) \item BUILD\_USE\_GPU : Using both CPU and GPU process (default value is OFF) (refer to Annex \ref{sec:OptionalGPU} for installation and more detail)
\item BUILD\_MATLAB\_MEX\_FILES : Enable building Matlab MEX files (default value is ON) \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\_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\_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) %\item BUILD\_READ\_MAT\_FILE : Using matio library to read mat files (default value is OFF)
\end{itemize} \end{itemize}
Following the selected option, the cmake installer automatically checks the dependent component (library OpenBlas, eigen, matio, libxml2). Following the selected option, the cmake installer automatically checks the dependent component (library OpenBlas, eigen, matio, libxml2).
......
...@@ -265,6 +265,8 @@ For more detail about cmake commands, refer to Section \ref{sec:ANNEXEInfoBuildI ...@@ -265,6 +265,8 @@ For more detail about cmake commands, refer to Section \ref{sec:ANNEXEInfoBuildI
% MICCORSOFT VISUAL STUDIO % MICCORSOFT VISUAL STUDIO
\section{Install using Microsoft Visual compiler}\label{sec:WinInstallVS} \section{Install using Microsoft Visual compiler}\label{sec:WinInstallVS}
The installation on Windows Platform using Visual Studio IDE has been tested but there is compilation problems depending of the version of your Windows and your Visual Studio. \textbf{This install configuration is not guaranteed} but you can try and report any problem and/or suggestion on install-list of FA$\mu$ST project on \url{http://lists.gforge.inria.fr/pipermail/faust-install/}.
When prerequisites listed in section \ref{sec:WinRequired} are checked, you must install \textbf{Microsoft Visual Studio} containing the C++ Compiler (Section \ref{sec:WinInstallCompilerVS}). When prerequisites listed in section \ref{sec:WinRequired} are checked, you must install \textbf{Microsoft Visual Studio} containing the C++ Compiler (Section \ref{sec:WinInstallCompilerVS}).
Then, the FA$\mu$ST installation can be done using Visual Studio IDE, following instructions given in Section \ref{sec:WinVisualStudioBasicInstall} or using Command prompt, following instructions given in Section \ref{sec:WinVisualStudioTerminalBasicInstall}. Then, the FA$\mu$ST installation can be done using Visual Studio IDE, following instructions given in Section \ref{sec:WinVisualStudioBasicInstall} or using Command prompt, following instructions given in Section \ref{sec:WinVisualStudioTerminalBasicInstall}.
...@@ -441,11 +443,12 @@ Here is the list of available options: ...@@ -441,11 +443,12 @@ Here is the list of available options:
\item BUILD\_MULTITHREAD : Enable multithread with OpenMP Multithreading (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\_VERBOSE : Enable verbose option when compile (-v) (default value is OFF)
\item BUILD\_DEBUG : Enable FA$\mu$ST Debug mode (default value is OFF ) \item BUILD\_DEBUG : Enable FA$\mu$ST Debug mode (default value is OFF )
\item BUILD\_USE\_GPU : Using both CPU and GPU process ( default value is OFF) \item BUILD\_USE\_GPU : Using both CPU and GPU process ( default value is OFF) (refer to Annex \ref{sec:OptionalGPU} for installation and more detail)
\item BUILD\_MATLAB\_MEX\_FILES : Enable building Matlab MEX files (default value is ON) \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\_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\_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) %\item BUILD\_READ\_MAT\_FILE : Using matio library to read mat files (default value is OFF)
\end{itemize} \end{itemize}
......
...@@ -36,7 +36,7 @@ The Figure \ref{fig:faustStructure} presents an brief structure of the FA$\mu$ST ...@@ -36,7 +36,7 @@ The Figure \ref{fig:faustStructure} presents an brief structure of the FA$\mu$ST
The Figure \ref{fig:recapInstall} summarizes the tested configurations of the installation of the FA$\mu$ST toolbox following the type of platform (Linux, Mac or Windows), compiler, version of Matlab and the type of Integrate Development Environment (IDE).\\ The Figure \ref{fig:recapInstall} summarizes the tested configurations of the installation of the FA$\mu$ST toolbox following the type of platform (Linux, Mac or Windows), compiler, version of Matlab and the type of Integrate Development Environment (IDE).\\
Choose among this Figure \ref{fig:recapInstall} the adapted platform and IDE following your system and refer to the corresponding Install Chapter. Authors suggest the installation using the GCC or Clang compiler directly from a command terminal because it is more simple and requires fewer externals components. Choose among this Figure \ref{fig:recapInstall} the adapted platform and IDE following your system and refer to the corresponding Install Chapter. Authors suggest the installation using the GCC or Clang compiler directly from a command terminal because it is more simple and requires fewer externals components.
The installation on Windows Platform using Visual Studio IDE has been tested but there is compilation problems depending of the version of your Windows and your Visual Studio. This install configuration is not guaranteed but you can try and report any problem and/or suggestion on install-list of FA$\mu$ST project on \url{http://lists.gforge.inria.fr/pipermail/faust-install/}. The installation on Windows Platform using Visual Studio IDE has been tested but there is compilation problems depending of the version of your Windows and your Visual Studio. \textbf{This install configuration is not guaranteed} but you can try and report any problem and/or suggestion on install-list of FA$\mu$ST project on \url{http://lists.gforge.inria.fr/pipermail/faust-install/}.
\begin{figure}[H] %%[!htbp] \begin{figure}[H] %%[!htbp]
\centering \centering
......
No preview for this file type
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment