LSC Matlab Applications
A collection of MATLAB based applications for use in LIGO data analysis
Automated MATLAB documentation made using:m2html
Laura Cadonati
Szabolcs Márka
Reinhard Prix
Peter Shawhan
Amber Stuver
Keith Thorne
John Whelan
Project Librarian
Amber Stuver can be reached at:
a m b e r . s t u v e r @ l i g o. o r g
Programmatics
- Mailing List: M a t A p p s - D i s c u s s @ L I G O . O r g (subscribe)
- Wiki: https://wiki.ligo.org/MatApps/
- Request Tracking/Bug Reporting:
- By Mail: M a t A p p s @ L I G O . O r g
MatApps user discussion takes place on the MatApps Mailing
list M a t A p p s - D i s c u s s @ L I G O . O r g (subscribe). While
major MatApps announcements will be made in many places, including
DASWG, details and announcements of more limited interest will be made only on the MatApps mailing list.
Download
You may download matapps packages remotely from the SVN repository.
Instructions on accessing the repository can be found in the
MatApps Quickstart Guide pages
SVN Repository Organization
The SVN repository is organized into generic upper-level directories of related software routines. In each such directory, there can be individual packages. There is also an upper-level 'utilities' directory for software packages of general use. The current upper-level directories are- detchar - for Detector Characterization
- searches - for search packages
- simulations - for simulation packages
- utilities - for packages with wide application
Tagging
Please make sure to tag any files that are being used in production running or as part of a code-review. Tags should generally follow the form NAME-X-Y ...etc. Where NAME is your name. If you are the manager for a particular package and wish to make official releases, you may use the package name instead. People should feel free to tag often. Deleting/moving tags is strongly frowned upon and should be discussed with the Project Librarian first.Documentation
Much of the information below is out-of-date. As updated information becomes available it will be posted to the MatApps Wiki and these links removed.- How To compile MATLAB for grid work
- MATAPPS HOW TO: How to set up your environment and use the Makefile scheme
- Tricks And Tips: an assorted compilation of random matlab wisdom.
- Using Matlab for LIGO data analysis presentations from the LSC Detector BootCamp
- FAQ: nothing yet.
Suggested Coding Practices
Much of the information below is out-of-date. As updated information becomes available it will be posted to the MatApps Wiki and these links removed.- Use matapps wide unique names for files.
- Functions with project-wide applicability should be placed in the utilities directory.
- Functions and variables should have meaninful names.
- Explicit numbers ('magic numbers') should be used sparingly. If unavoidable, such numbers should be defined in a variable at the begining of the file and the variable used throughout the rest of the file.
- header comments should be used for all functions and kept up to date. This will enable the use of help within matlab. This header should include a description of what the function does as well as all input and output parameters.
- "%$Id:$" (withouth the quotes) should be in the header to enable tracking of the CVS version.
- "If you must read the source code more than once or twice to figure it out, include a comment. Comments complement the source code, not parrot it." from the Taligent guidelines
- A full list of guidelines can be found in Keith Thorne's proposed coding guidelines
links
Contributors
$Id$