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
Keith Thorne can be reached at:
k e i t h . t h o r n e @ l i g o. o r g
Download
You may download the matapps packages remotely from CVS repository. Instructions may be found in the DASWG HOWTO pagesCVS Repository Organization
The CVS 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.Bug Reporting, Testing, and Quality Assurance
Before you file a bug, please read through the list of
current and previous bugs for MatAPPS to determine if your bug has already
been filed. If your bug does not exist,
enter a bug report using the gnats bug entry page. If your bug
exists and has not been fixed, add additional information to the
existing bug. If your bug exists and has been fixed, upgrade to the
version in the bug report to determine if the bug was properly
fixed. If it was not, reopen the bug.
Some other interesting gnats queries:
Mailing Lists
Documentation
- Automated Documentation built nightly from the CVS repository. You will need the standard lsc user name and password to access the documentation.
- 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
- 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
Open tasks
- Filling the CVS Repository!
links
Contributors
$Id: matapps.html,v 1.50 2007/07/26 14:08:42 whelan Exp $