diff README.txt @ 1:7750624e0c73 version0.5

(none)
author idamnjanovic
date Thu, 05 Nov 2009 16:36:01 +0000
parents
children a07585dff65c
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.txt	Thu Nov 05 16:36:01 2009 +0000
@@ -0,0 +1,99 @@
+
+SMALLbox Version 0.5
+
+31st July, 2009
+
+
+---------------------------------------------------------------------------
+
+Copyright (2009): Ivan Damnjanovic, Matthew Davies
+
+SMALLbox is distributed under the terms of the GNU General Public License 3
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+---------------------------------------------------------------------------
+
+SMALLbox is a MATLAB Evaluation Framework for the EU FET-OPEN Project, no: 225913:
+Sparse Models, Algorithms, and Learning for Large-scale data (SMALL). 
+
+The project team includes researchers from the following institutions:
+
+INRIA:                            http://www.irisa.fr/metiss/gribonval/
+University of Edinburgh:          http://www.see.ed.ac.uk/~mdavies4/
+Queen Mary, University of London: http://www.elec.qmul.ac.uk/people/markp/
+EPFL:                             http://people.epfl.ch/pierre.vandergheynst
+Technion:                         http://www.cs.technion.ac.il/~elad/
+
+---------------------------------------------------------------------------
+
+Version 0.5 of SMALLbox will download and install the following existing toolboxes 
+related to Sparse Representations, Compressed Sensing and Dictionary Learning:
+
+
+Sparco:               http://www.cs.ubc.ca/labs/scl/sparco/
+
+SPGL1:                http://www.cs.ubc.ca/labs/scl/spgl1/
+
+SparseLab:            http://sparselab.stanford.edu/  
+
+Sparsify:             http://www.see.ed.ac.uk/~tblumens/sparsify/sparsify.html
+
+GPSR:                 http://www.lx.it.pt/~mtf/GPSR/
+
+OMPbox and KSVDBox:   http://www.cs.technion.ac.il/~ronrubin/
+
+IMPORTANT:
+In order to use SparseLab please register at
+http://cgi.stanford.edu/group/sparselab/cgi-bin/register.pl
+
+IMPORTANT:
+To successfully install all toolboxes you will need to have MEX setup to compile C files.
+If this is not already setup, run "mex -setup" or type "help mex" in the MATLAB command prompt.
+
+IMPORTANT:
+Because the toolboxes are downloaded automatically, you must have an internet connection
+to successfully install SMALLbox.
+
+IMPORTANT:
+If you are running Matlab on MAC OSX or Linux, you must start Matlab with the jvm enabled.
+Not doing so, will prevent you being able to unzip the downloaded toolboxes.
+
+To install the toolbox run the command "SMALLboxsetup" from the MATLAB command prompt.
+
+Once installed, there are two optional demo functions that can be run,
+
+SMALL_solver_test.m :
+
+Example test of solvers from different toolboxes on Sparco compressed sensing problems
+
+and 
+
+SMALL_solver_test_Audio.m :
+
+Example test of solvers on Sparco audio source separation problems
+
+---------------------------------------------------------------------------
+
+For more information on the SMALL Project, please visit the following website:
+
+http://small.inria.fr
+
+
+Contacts: ivan.damnjanovic@elec.qmul.ac.uk
+          matthew.davies@elec.qmul.ac.uk
+
+
+This code is in experimental stage; any comments or bug reports are 
+very welcome.