Mentions légales du service

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

doc latex

parent 98de005d
No related branches found
No related tags found
No related merge requests found
No preview for this file type
...@@ -270,7 +270,13 @@ For more detail about \texttt{cmake} command, refer to Section \ref{sec:ANNEXEIn ...@@ -270,7 +270,13 @@ For more detail about \texttt{cmake} command, refer to Section \ref{sec:ANNEXEIn
The project FA$\mu$ST can be configured with optional parameters, for example if you want to install FA$\mu$ST library 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. The project FA$\mu$ST can be configured with optional parameters, for example if you want to install FA$\mu$ST library 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.
The Cmake Graphical User Interface \texttt{ccmake} allows you to select option input. When using the \texttt{ccmake} command in your build directory, the Cmake GUI appears in the console (see fig. \ref{fig:ccmake}). The Cmake Graphical User Interface \texttt{ccmake} allows you to select option input. Set your current directory to your build directory and type in a terminal :
\lstset{style=customBash}
\begin{lstlisting}
> ccmake ..
\end{lstlisting}
The Cmake GUI appears in the console (see fig. \ref{fig:ccmake}).
\begin{figure}[H] %%[!htbp] \begin{figure}[H] %%[!htbp]
\centering \centering
......
...@@ -375,6 +375,10 @@ For more detail about cmake commands, refer to Section \ref{sec:ANNEXEInfoBuildI ...@@ -375,6 +375,10 @@ For more detail about cmake commands, refer to Section \ref{sec:ANNEXEInfoBuildI
\section{Custom - Advanced Installation}\label{sec:WinCustomInstall} \section{Custom - Advanced Installation}\label{sec:WinCustomInstall}
The project FA$\mu$ST can be configured with optional parameters, for example if you want to install FA$\mu$ST library 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.
The Cmake Graphical User Interface allows you to select option input.
\begin{enumerate} \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: \item Open application \texttt{cmake-GUI.exe} from the program menu or from your cmake install binaries directory to launch the CMake configuration application:
...@@ -409,6 +413,24 @@ When clicking for the first time on the [Configure] button, CMake will ask for t ...@@ -409,6 +413,24 @@ When clicking for the first time on the [Configure] button, CMake will ask for t
\end{enumerate} \end{enumerate}
Here is the list of available options:
\begin{itemize}
\item CMAKE\_INSTALL\_PREFIX : Install directory
\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 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\_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}
%%%%AUTRESS %%%%AUTRESS
...@@ -21,12 +21,12 @@ For more information on the FAuST project, please visit the website of the proje ...@@ -21,12 +21,12 @@ For more information on the FAuST project, please visit the website of the proje
The FAuST Toolbox is distributed under the terms of the GNU Affero General Public License. This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see \url{http://www.gnu.org/licenses/}. The FAuST Toolbox is distributed under the terms of the GNU Affero General Public License. This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see \url{http://www.gnu.org/licenses/}.
\paragraph{FA$\mu$ST Structure:} \paragraph{FA$\mu$ST Structure:}
The Figure \ref{fig:faustStructure} presents an brief structure of the FA$\mu$ST toolbox. The principal C++ library called "libfaust" includes the "Factorization algorithms" used to generate a FA$\mu$ST core, the solvers and the FA$\mu$ST matrix multiplication. It can be employ using different types of wrappers. In the second version of FA$\mu$ST package (Version 2.0), only Matlab wrapper is proposed. The Figure \ref{fig:faustStructure} presents an brief structure of the FA$\mu$ST toolbox. The principal C++ library called "libfaust" includes two components: the "Factorization algorithms" is used to generate a FA$\mu$ST core from a dense matrix and the "FA$\mu$ST matrix multiplication" provides the linear operator to manipulate your data. It can be employ using different types of wrappers but in the second version of FA$\mu$ST package (Version 2.0), only Matlab wrapper is provided.
\begin{figure}[H] %%[!htbp] \begin{figure}[H] %%[!htbp]
\centering \centering
\includegraphics[scale=0.4,trim = 0cm 5cm 0cm 4cm, clip]{images/FaustStructure.pdf} \includegraphics[scale=0.45,trim = 0cm 5cm 0cm 4cm, clip]{images/FaustStructure.pdf}
\caption{FAuST Structure} \caption{Brief structure of FAuST version 2.0.0}
\label{fig:faustStructure} \label{fig:faustStructure}
\end{figure} \end{figure}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment