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. A Python wrapper is also available. 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: FAµST website
Dependencies
- libxml2 (Optional, needed with CMake BUILD_READ_XML_FILE).
- TODO
Cloning the project
The project git binary objects are heavy (it can take up to ~ 1.5 Gio of data). If your connection is unstable don't download the whole history (using the --depth
option -- issue #294).
git clone git@gitlab.inria.fr:faustgrp/faust.git --depth=1 --single-branch faust
NOTE: you can also use the https://gitlab.inria.fr/faustgrp/faust.git URL.
Then if you really need the full git history to work on the project, fetch it (preferably when your Internet connection is good) :
git fetch --unshallow
Quick build on UNIX
Unpack the directory.
mkdir ./build
cd ./build
cmake .. OR ccmake .. (with Graphical User Interface)
make
make install
Warning 1: The Matlab interface of FAuST requires compiling mex files. The mex compiler compatible with specific versions of gcc depending on the platform used. For more information, please refer to the Mathworks website.
Warning 2: Many CMake build options are available (cf. CMakeLists.txt). It might be quite complicated to deal with them at start (refer to gitlab ci building scripts in ./misc/continuous_integration/jobs/ or the .gitlab-ci.yml root script to get some insight).
Quickest Install on Linux, Windows and macOS (pre-built pakages)
Please refer to the document Installation guides to install the FAUST toolbox. The FAUST toolbox has been tested on the following environments:
- LINUX (fedora 35 - 37 / centos 7, 8 / Ubuntu)
- MACOS X
- WINDOWS (windows 10)
Pre-compiled packages from Gitlab Continuous Integration are also available. Except of course PIP packages, all packages include matlab and python wrappers, below are the latest release links.
- macOS (.pkg) installer
- Windows (.exe) NSI installer
- Linux (.rpm, .deb) packages
- Linux (.rpm, .deb) packages with embedded static matio library
- Python PIP (pre-compiled) packages: for Linux, macOS and Windows 10. Or preferably, refer to pypi pyfaust or anaconda pyfaust. ============
License
Cf. license.txt
Contacts
Rémi Gribonval: remi.gribonval@inria.fr
Hakim: hakim.hadj-djilani@inria.fr
Credits
Luc Le Magoarou
Remi Gribonval
Nicolas Bellot
Adrien Leman
Thomas Gautrais
Hakim Hadj-Djilani