Instructions for Contributors


SparseLab is an amalgamation of work from several authors and we welcome contributions. If you believe your work would be a good fit with SparseLab, email us at sparselab@AT@stanford.edu (with only one @ sign).

Guidelines for submitted code packages:
  • Each article gets one subdirectory of /Sparselab100/Papers/.
  • Each subdirectory contains: (a) the paper itself, (b) a subdirectory housing a demo.
  • The files in a subdirectory have stylized names, so that the name indicates the function of the file.
  • Stylized names are based on a name and a short prefix. The name should be short but descriptive, for example, ExtCSDemo for scripts associated with the paper Extensions of Compressed Sensing and the prefix should be a related tag, for example ExtCS.
  • The subdirectory name reflects the name you have chosen, for example Sparselab100/Papers/ExtCSDemo.
Guidelines for script submissions for demos:
  • One script creates one complete figure, not a series of figures, and not just a subplot of a figure.
  • If several scripts need to work with the same variables -- for example, if you want a variable to be created in one script and then used in later scripts -- these variables should be made global.
  • No pause's, print's, or figure calls in a script.
  • As far as possible try to use the tools in the SparseLab Utilities directory to perform actions like setting axes.
Inspection of existing scripts will help in following these rules. The idea is that these scripts and those of future contributors to SparseLab should be upwardly compatible with script-running engines making more sophisticated use of the Matlab user interface.

Documenting individual figures:
    Each .m file for an individual figure contains a help header which is displayed in the command window at the time the figure is generated in the plot window. This provides a kind of on-line narrative, or caption. Here is an example from ExtCSDemo:

    % GenFig1 -- ExtCSDemo Figure 1: Error of reconstruction versus
    % number of samples for signals with a controlled number of nonzeros.
    %
    % Data files used: DataL0_20.mat, DataL0_50.mat, DataL0_100.mat
    %
    % See also: GenDataL0.m






supported in part by NSF DMS-05-05303.
last updated 12-08-2006 by VCS