Share Email Print

Proceedings Paper

Open-source framework for documentation of scientific software written on MATLAB-compatible programming languages
Author(s): Mikhail V. Konnik; James Welsh
Format Member Price Non-Member Price
PDF $17.00 $21.00

Paper Abstract

Numerical simulators for adaptive optics systems have become an essential tool for the research and development of the future advanced astronomical instruments. However, growing software code of the numerical simulator makes it difficult to continue to support the code itself. The problem of adequate documentation of the astronomical software for adaptive optics simulators may complicate the development since the documentation must contain up-to-date schemes and mathematical descriptions implemented in the software code. Although most modern programming environments like MATLAB or Octave have in-built documentation abilities, they are often insufficient for the description of a typical adaptive optics simulator code. This paper describes a general cross-platform framework for the documentation of scientific software using open-source tools such as LATEX, mercurial, Doxygen, and Perl. Using the Perl script that translates M-files MATLAB comments into C-like, one can use Doxygen to generate and update the documentation for the scientific source code. The documentation generated by this framework contains the current code description with mathematical formulas, images, and bibliographical references. A detailed description of the framework components is presented as well as the guidelines for the framework deployment. Examples of the code documentation for the scripts and functions of a MATLAB-based adaptive optics simulator are provided.

Paper Details

Date Published: 24 September 2012
PDF: 11 pages
Proc. SPIE 8451, Software and Cyberinfrastructure for Astronomy II, 84512N (24 September 2012); doi: 10.1117/12.924952
Show Author Affiliations
Mikhail V. Konnik, The Univ. of Newcastle (Australia)
James Welsh, The Univ. of Newcastle (Australia)

Published in SPIE Proceedings Vol. 8451:
Software and Cyberinfrastructure for Astronomy II
Nicole M. Radziwill; Gianluca Chiozzi, Editor(s)

© SPIE. Terms of Use
Back to Top
Sign in to read the full article
Create a free SPIE account to get access to
premium articles and original research
Forgot your username?