Mentions légales du service

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

modif doc latex

parent c1770c4a
No related branches found
No related tags found
No related merge requests found
......@@ -9,7 +9,7 @@ Here is a list of packages used in the FA$\mu$ST project. The installation of th
% \item Library \textbf{matio} \url{https://sourceforge.net/projects/matio}
\end{itemize}
\section{Compatibility between MATLAB and gcc compiler}\label{sec:ANNEXECompatibilityMatlabCompiler}
\section{Compatibility between MATLAB and GCC compiler}\label{sec:ANNEXECompatibilityMatlabCompiler}
Adjust your version of GCC compiler in order to run the installation properly. 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).
To temporally change your version of cc and cxx compiler, you can modify the environment variable CC and CXX. For that, export your CC and CXX variables corresponding to gcc and g++ binaries path :
......@@ -100,7 +100,7 @@ C:\Program Files;C:\Winnt;C:\Winnt\System32
\section{FAUST Install on MAC OS X platform, using Xcode IDE with terminal command}\label{sec:ANNEXEInstallMACXcodeTerminal}
\section{FAuST Install on MAC OS X platform, using Xcode from terminal command}\label{sec:ANNEXEInstallMACXcodeTerminal}
You can generated the target using the terminal command \texttt{xcodebuild} :
\lstset{style=customBash}
\begin{lstlisting}
......
......@@ -78,7 +78,7 @@ This is in order to illustrate the speed-up induced by the FA$\mu$ST. This speed
\section{Construct a FAuST from its factor}\label{sec:firstUseBuildFactors}
To see an example of building a FA$\mu$ST from its factors, you can run construct\_Faust\_from\_factors.m in the Matlab Command Window by typing :
To see an example of building a FA$\mu$ST from its factors, you can run \texttt{construct\_Faust\_from\_factors.m} in the Matlab Command Window by typing :
\lstset{style=customMatlab}
\begin{lstlisting}
>> construct_Faust_from_factors
......
......@@ -10,8 +10,8 @@ The FA$\mu$ST project is available for Linux, MAC OS X and Windows platforms. Th
\item Refer to the appropriate section following the use (or not) of an IDE (Integrated Development Environment):
\begin{itemize}
\item Basic installation using \textbf{the command line terminal}, refer to Section \ref{sec:UnixBuildInstall}.
\item Basic installation using \textbf{the IDE "Code::Blocks"}, refer to Section \ref{sec:UnixInstallCodeBlock}.
\item Basic installation using \textbf{the IDE "Xcode"} only for MAC OS X platform, refer to Section \ref{sec:MacInstallXcode}.
\item Basic installation using \textbf{the Code::Blocks IDE}, refer to Section \ref{sec:UnixInstallCodeBlock}.
\item Basic installation using \textbf{the Xcode IDE } only for MAC OS X platform, refer to Section \ref{sec:MacInstallXcode}.
\end{itemize}
\end{enumerate}
......@@ -46,7 +46,7 @@ Matlab Command Window.
\section{Required components}\label{sec:RequiredTools}
This Section lists the required components you must install before to begin the FA$\mu$ST installation.
\begin{itemize}
\item \textbf{Install CMake}. The minimum version required is Cmake version 3.0.2. Visit the website \url{https://cmake.org/} to process to the installation.
\item \textbf{Install CMake}. The minimum version required is Cmake version 3.0.2. Download binary distribution of CMake from their website \url{https://cmake.org/download/}.
\item \textbf{Verify Cmake install} by typing in a command terminal :
......@@ -199,8 +199,8 @@ For more detail about \texttt{cmake} command, refer to Section \ref{sec:ANNEXEIn
% Xcode
\section{Basic Build \& Install using Xcode IDE (for MAC OS)}\label{sec:MacInstallXcode}
FA$\mu$ST install using the IDE Xcode concerns only MAC OS X environment.
\paragraph{}When you have done the step in section \ref{sec:UnixBuildDownload} (i.e download FA$\mu$ST package and launch the terminal in the right directory), the FA$\mu$ST installation can start. This Build \& Install section requires that you have the IDE Xcode installed on your system. If you are administrator of your machine (root access), follow instructions given in Section \ref{sec:XcodeUnixBuildInstallAdmin}. Otherwise, for local installation, refer to Section \ref{sec:XcodeUnixBuildInstallNOAdmin}.
FA$\mu$ST install using the Xcode IDE concerns only MAC OS X environment.
\paragraph{}When you have done the step in section \ref{sec:UnixBuildDownload} (i.e download FA$\mu$ST package and launch the terminal in the right directory), the FA$\mu$ST installation can start. This Build \& Install section requires that you have the Xcode IDE installed on your system. If you are administrator of your machine (root access), follow instructions given in Section \ref{sec:XcodeUnixBuildInstallAdmin}. Otherwise, for local installation, refer to Section \ref{sec:XcodeUnixBuildInstallNOAdmin}.
\paragraph{NOTE: }For a command line install using Xcode IDE, refer to Annex \ref{sec:ANNEXEInstallMACXcodeTerminal}.
......@@ -296,8 +296,8 @@ Instead the ccmake GUI, an other possibility to configure and generate the proje
\texttt{cmake\ ..\ -D<BUILD\_NAME>=<value>}
\begin{itemize}
\item CMAKE\_INSTALL\_PREFIX : Install directory for the FA$\mu$ST library
\item CMAKE\_INSTALL\_MATLAB\_PREFIX : Install path directory for the Matlab wrapper
\item CMAKE\_INSTALL\_PREFIX : Install directory path for the FA$\mu$ST library
\item CMAKE\_INSTALL\_MATLAB\_PREFIX : Install directory path for the Matlab wrapper
\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)
......@@ -310,7 +310,7 @@ Instead the ccmake GUI, an other possibility to configure and generate the proje
%\item BUILD\_READ\_MAT\_FILE : Using matio library to read mat files (default value is OFF)
\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).
%\section{Optional dependent tools}\label{sec:OptionalRequiredTools}
......
......@@ -42,7 +42,7 @@ Matlab Command Window.
The installation of the FA$\mu$ST tool depends on other components to be installed in order to run properly.
\begin{itemize}
\item \textbf{Install CMake}. The minimum version required is Cmake version 3.0.2. Download Binary distributions correspond to your environment from \url{https://cmake.org/download/}.
\item \textbf{Install CMake}. The minimum version required is Cmake version 3.0.2. Download binary distribution of CMake from their website \url{https://cmake.org/download/}.
\item \textbf{Verify CMake install} : Open a terminal and type the following command:
\lstset{style=customBash}
\begin{lstlisting}
......@@ -110,13 +110,13 @@ When prerequisitie components listed in precedent section \ref{sec:WinRequired}
\end{itemize}
\section{Install using GCC-MinGW compiler}\label{sec:WinInstallMinGW}
\section{Install using GCC compiler}\label{sec:WinInstallMinGW}
When prerequisite components listed in previous section \ref{sec:WinRequired} are checked, you must install \textbf{MinGW containing the C++ Compiler}.
Then, the FA$\mu$ST installation can be done using Command prompt, following instructions given in Section \ref{sec:WinMinGWBasicInstall} or using CodeBlocks IDE, following instructions given in Section \ref{sec:WinCodeBlocksBasicInstall}.
\subsection{Install GCC from MinGW}
\subsection{Install GCC compiler from MinGW}
\label{sec:WinInstallCompilerMinGW}
\begin{itemize}
......@@ -209,7 +209,7 @@ FA$\mu$ST Toolbox should be installed. Now, refer to Quick-Start Chapter \ref{se
The basic install described in this section requires the GCC compiler from MinGW (see precedent Section \ref{sec:WinInstallCompilerMinGW}).
If you have administrator privilege, follow instructions in Section \ref{sec:WinMinGWCodeBlocksAdminBasicInstall}, otherwise follow instructions given in Section \ref{sec:WinMinGWCodeBlocksNoAdminBasicInstall}.
You must select the gcc compiler in the IDE code::Blocks in the \\ \texttt{Settings menu --> Compiler... --> Selected Compiler }
You must select the gcc compiler in the code::Blocks IDE in the \\ \texttt{Settings menu --> Compiler... --> Selected Compiler }
Then, the FA$\mu$ST installation can be done.
......@@ -436,8 +436,8 @@ When clicking for the first time on the [Configure] button, CMake will ask for t
Here is the list of available options:
\begin{itemize}
\item CMAKE\_INSTALL\_PREFIX : Install directory for the FA$\mu$ST library
\item CMAKE\_INSTALL\_MATLAB\_PREFIX : Install path directory for the Matlab wrapper
\item CMAKE\_INSTALL\_PREFIX : Install directory path for the FA$\mu$ST library
\item CMAKE\_INSTALL\_MATLAB\_PREFIX : Install directory path for the Matlab wrapper
\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)
......
......@@ -29,7 +29,7 @@ Choose among this Figure \ref{fig:recapInstall} the adapted platform and IDE fol
\end{figure}
\paragraph{How FA$\mu$ST is structured?}
The Figure \ref{fig:faustStructure} presents a 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.
The Figure \ref{fig:faustStructure} presents a 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. Command-line, Python and A||GO wrapper are planned in the next version of FA$\mu$ST (see Section \ref{sec:WorkingProgress}).
\begin{figure}[H] %%[!htbp]
......@@ -45,7 +45,7 @@ The Figure \ref{fig:faustStructure} presents a brief structure of the FA$\mu$ST
\item The use of the \textbf{mex function} from Matlab requires that you have a third-party compiler installed on your system. Warning: Following your version of Matlab (2016a in our case) mex function only supports up to GCC 4.7 (see \url{http://fr.mathworks.com/support/compilers/R2016a/index.html?sec=glnxa64} for more detail).
\item The "Factorization algorithms" module represented on Figure \ref{fig:faustStructure} is actually in progress (see Section).
\item The "Factorization algorithms" module represented on Figure \ref{fig:faustStructure} is actually in progress (see Section \ref{sec:WorkingProgress}).
\end{enumerate}
......
......@@ -8,9 +8,11 @@ from user-friendly approach (cf. Section \ref{sec:WorkingProgressBuildFromMatrix
that stable. In the sense that they are not fitted to all types of matrices.
\item \textbf{Graphics Processing Unit (GPU) :} (cf. Section \ref{sec:OptionalGPU})\\
A GPU version of the code is under development, it already shows
some time saving compared to the CPU code but is not enough user-friendly and not easy to install to be in this release. However, you can try the installation described in Section \ref{sec:OptionalGPU}, 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/}.
some time saving compared to the CPU code but is not enough user-friendly and not easy to install to be in this release. However, the Linux configuration is already in operation then you can try the installation described in Section \ref{sec:OptionalGPU}, 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/}.
\item \textbf{Python wrapper :} A Python wrapper is also planned, it will used Cython module.
\item \textbf{Command line wrapper :} A command line wrapper is also planned. It will integrated the externals Libraries "XML" and "MATIO" to manipulate the data (configuration and matrix).
\item \textbf{A||GO wrapper :} A A||GO wrapper is also planned to propose a demonstration on website \url{https://allgo.inria.fr/}.
\item \textbf{Image denoising experiment :} (cf. \cite[chapter VI.]{LeMagoarou2016}) \\
This experiment was in the previous release (FA$\mu$ST version 1.0) but is not in the current one because our C++ wrapper is not yet fitted to the algorithm used in this experiment.
\end{itemize}
......
......@@ -63,7 +63,7 @@
\lstdefinestyle{customBash}{
language=bash,%
backgroundcolor=\color{myBlack}, % choose the background color; you must add
stringstyle=\color{mylilas},%
stringstyle=\color{white},%
%identifierstyle=\bfseries\color{white},%
keywordstyle=\color{white},%
basicstyle=\ttfamily\color{white},
......
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