Mentions légales du service

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

maj latex doc

parent ba072329
Branches
Tags
No related merge requests found
\documentclass[a4paper,10pt]{article}
\documentclass[a4paper,11pt]{report}
\author{Adrien Leman; Nicolas Bellot}
\title{Documentation of the project FA$\mu$ST \smallbreak "Flexible Approximate Multi-Layer Sparse Transform"}
......@@ -89,13 +89,23 @@
\newpage
\section{Introduction}\label{sec:intro}
\chapter{Introduction}\label{sec:intro}
\paragraph{Presentation} FA$\mu$ST is a C++ toolbox, useful to decompose a given dense matrix into a product of sparse matrices in order to reduce its computational complexity (both for storage and manipulation). (see. \cite{LeMagoarou2016} ).
FA$\mu$ST can be used to speed up iterative algorithms commonly used for solving high dimensional linear inverse problems.
\paragraph{Presentation} FA$\mu$ST is a C++ toolbox, useful to decompose a given dense matrix into a product of sparse matrices in order to reduce its computational complexity (both for storage and manipulation).
FA$\mu$ST can be used to speed up iterative algorithms commonly used for solving high dimensional linear inverse problems. The algorithms implemented in the toolbox are described in details in Le Magoarou \cite{LeMagoarou2016}.
The FA$\mu$ST toolbox is delivered with a Matlab wrapper.
For more information on the FAuST Project, please visit the website of the project: \url{http://faust.gforge.inria.fr}.
\paragraph{Organization} The section \ref{sec:install} present the installation of the library FA$\mu$ST, the \ref{sec:firstUse} section show quickly how to used this library and finally an example is proposed in section \ref{sec:example}.
\paragraph{License}
Copyright (2016) Luc Le Magoarou, Remi Gribonval INRIA Rennes, FRANCE
\begin{center}
\url{http://www.inria.fr/}
\end{center}
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{Organization} The section \ref{sec:install} present the installation of the library FA$\mu$ST, the section \ref{sec:firstUse} show quickly how to used this library and finally an example is proposed in section \ref{sec:example}.
\include{chapInstall}
......
\section{Example}\label{sec:example}
\chapter{Example}\label{sec:example}
\subsection{Brain Sources Localization}\label{sec:BSL_example}
\section{Brain Sources Localization}\label{sec:BSL_example}
%\lstinputlisting{../../misc/demo/Brain_source_localization/BSL.m}
\ No newline at end of file
\section{QuickStart}\label{sec:firstUse}
\chapter{QuickStart}\label{sec:firstUse}
A matlab wrapper is delivered with the FAUST C++ library.
......@@ -36,10 +36,10 @@ As much as possible, a \textbf{matlab{\_}faust} object is handled as a normal ma
\subsection{construct a faust}\label{sec:firstUseBuild}
\section{construct a faust}\label{sec:firstUseBuild}
A \textbf{matlab{\_}faust} object can be constructed from several ways.
\subsubsection{construct a faust from a cell-array}\label{sec:firstUseBuildFromCellArray}
\subsection{construct a faust from a cell-array}\label{sec:firstUseBuildFromCellArray}
First, you can build a faust from a cell-array of matlab matrix (sparse or dense) representing its factors.
\newline
\newline
......@@ -79,7 +79,7 @@ This functionality allows you to build a faust from the factorization algorithm
>> A=Faust(factors,lambda);
\end{lstlisting}
\subsubsection{construct a faust from a saved one}\label{sec:firstUseBuildFromSave}
\subsection{construct a faust from a saved one}\label{sec:firstUseBuildFromSave}
You can also build a faust from a previously one which is saved into a mat file :
\begin{lstlisting}
......
\section{Installation}\label{sec:install}
\chapter{Installation}\label{sec:install}
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 (cf. website on \url{https://cmake.org/}).
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 (cf. website \url{https://cmake.org/}).
First subsection \ref{sec:UnixInstall} gives information about Unix installation and second subsection \ref{sec:WinInstall} corresponds to the Windows installation.
First section \ref{sec:UnixInstall} gives information about Unix installation and second section \ref{sec:WinInstall} corresponds to the Windows installation.
\subsection{Unix environment}\label{sec:UnixInstall}
\section{Unix platform}\label{sec:UnixInstall}
\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 FAUST directory, and tape the following command :
\item Place you in the FA$\mu$ST directory, and type the following commands :
\begin{lstlisting}
mkdir build
cd build
......@@ -22,14 +21,48 @@ make install
\end{itemize}
\section{Windows platform}\label{sec:WinInstall}
\subsection{Windows environment}\label{sec:WinInstall}
\subsection{Prerequisities for installation}\label{sec:WinPrerequisitiesInstall}
The installation of the FA$\mu$ST project depend on other components to be installed in order to run properly.
\begin{enumerate}
\item \textbf{Install MinGW} "Minimalist GNU for Windows" \url{http://www.mingw.org/}
\url{https://sourceforge.net/projects/mingw/files/latest/download?source=files}
Launch install file and choose MINGW version 4.9.2 for mexFunction compatibility
The directory of binary must be add to the environment PATH.
\item \textbf{Install CMake} for building the FAUST project.
In \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.
Note for Cmake tool : In a terminal command, type "make". if it doesn't exist, please check if make.exe is present in cmake-3.6.0-win64-x64$\setminus$bin$\setminus$cmake.exe
if not, you can copy and rename mingw32-make.exe to make.exe
\item \textbf{Install Matlab} if not already done (MATLAB R2015b in our case).
\item In Matlab, you must install MinGW version 4.9.2 from MATLAB using the ADDON menu. For more detail, please follow the instruction give 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 7-Zip} \url{http://www.7-zip.org/} . 7-Zip is a file archiver used for external library
\item In your environment PATH, please add following components :
\begin{itemize}
\item matlab.exe (example: "C:$\setminus$Program Files$\setminus$MATLAB$\setminus$R2015b$\setminus$bin")
\item gcc.exe (example: "C:$\setminus$mingw-w64$\setminus$mingw64$\setminus$bin")
\item 7z.exe (example: "C:$\setminus$prog$\setminus$7-Zip")
\item cmake.exe (example: "C:$\setminus$Users$\setminus$ci$\setminus$Documents$\setminus$library$\setminus$cmake-3.6.0-win64-x64$\setminus$bin")
\end{itemize}
\end{enumerate}
\subsection{FAUST installation}\label{sec:WinFaustInstall}
When prerequisities listed in precedent section \ref{sec:WinPrerequisitiesInstall} 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 FAUST directory, and tape the following command :
\item Place you in the FAUST directory, and type the following commands :
\begin{lstlisting}
mkdir build
cd build
......@@ -39,7 +72,4 @@ make install
\end{lstlisting}
\end{itemize}
Warning :
compatibility between Matlab and MinGW :
MinGW version 4.9.2 pour les mex functions..
sous windows on utilise MinGW pour le compilateur GCC G++ au lieu de visual studio plous lourd à installer. MinGW version 4.9.2 pour les mex functions..
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment