##########################################################################
######## README for developer ##########
######## FAuST Toolbox ##########
######## Flexible Approximate Multi-Layer Sparse Transform ##########
##########################################################################
##########################################################################
General purpose:
The FAuST toolbox contains a C++ code implementing a general framework
designed to factorize matrices of interest into multiple sparse factors.
It contains a template CPU/GPU C++ code and a Matlab wrapper.
The algorithms implemented here are described in details in [1]- Le Magoarou
For more information on the FAuST Project, please visit the website of the
project: <http://faust.gforge.inria.fr>
##########################################################################
##########################################################################
Installation:
Please refer to the document "./gettingStartedFAuST-version2_0.pdf"
##########################################################################
##########################################################################
FAuST structure directory:
./CMake/
--> contains ".cmake" files used to execute some internal cmake
command as find the path of the externals library, Matlab Path,
Python Path, ...
./externals/
--> contains the externals Library like Eigen, Openblas...
./gen_doc/
--> contains both user and developer documentation:
- Doxygen for developer
- Installation in a LaTeX format in ./gen_doc/LaTeX for
the getting Started intituled
"gettingStartedFAuST-versionX.pdf"
./misc/
--> contains the tests (Ctest), the demonstrations, the data and the
configuration files, and the CTest_nightly tools for Continuous
Integration.
./src/
--> contains the C++ sources of the project
./wrapper/
--> contains the wrapper of the project (Matlab, Python, ...)
##########################################################################
##########################################################################
documentation for developer: Doxygen
The Doxygen documentation is available in following directory:
./gen_doc/
to build Doxygen documentation, build the project with following option:
cmake .. -DBUILD_DOCUMENTATION="ON"
The configuration of Doxygen are defined in the file ./gen_doc/Doxyfile.in
##########################################################################
##########################################################################
Web site of FAuST project:
To modify and/or update the web site of the project FAuST, refer to
following README.txt file :
../website/README.txt
##########################################################################
##########################################################################
Integration Continue:
The Continuous Integration for the project FAUST is based on the CDASH tool
(see. http://www.cdash.org/). The building and test are available on the
public link:
http://cdash.inria.fr/CDash/index.php?project=faust
For more detail concerning C.I. (Virtual Machine, CDash, etc...), refer
to README.txt file in the following directory:
"./devcpp/misc/Ctest_nightly/README.txt"
##########################################################################
##########################################################################
License:
Copyright (2016): Luc Le Magoarou, Remi Gribonval,
Nicolas Bellot, Adrien Leman, Thomas Gautrais
INRIA Rennes, FRANCE
http://www.inria.fr/
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 <http://www.gnu.org/licenses/>.
##########################################################################
##########################################################################
Contacts:
Luc Le Magoarou: luc.le-magoarou@inria.fr
Remi Gribonval : remi.gribonval@inria.fr
Nicolas Bellot : nicolas.bellot@inria.fr
Adrien Leman : adrien.leman@inria.fr
Thomas Gautrais : thomas.gautrais@inria.fr
##########################################################################
##########################################################################
References:
[1] Le Magoarou L. and Gribonval R., "Flexible multi-layer sparse
approximations of matrices and applications", Journal of Selected
Topics in Signal Processing, 2016.
<https://hal.archives-ouvertes.fr/hal-01167948v1>
##########################################################################
