Open-source framework for documentation of scientific software written on MATLAB-compatible programming languages

Mikhail V. Konnik; James Welsh

doi:10.1117/12.924952

24 September 2012 Open-source framework for documentation of scientific software written on MATLAB-compatible programming languages

Mikhail V. Konnik, James Welsh

Author Affiliations +

Proceedings Volume 8451, Software and Cyberinfrastructure for Astronomy II; 84512N (2012) https://doi.org/10.1117/12.924952
Event: SPIE Astronomical Telescopes + Instrumentation, 2012, Amsterdam, Netherlands

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.

Citation Download Citation

Mikhail V. Konnik and James Welsh "Open-source framework for documentation of scientific software written on MATLAB-compatible programming languages", Proc. SPIE 8451, Software and Cyberinfrastructure for Astronomy II, 84512N (24 September 2012); https://doi.org/10.1117/12.924952

ACCESS THE FULL ARTICLE

INSTITUTIONAL
Select your institution to access the SPIE Digital Library.

SELECT YOUR INSTITUTION

PERSONAL
Sign in with your SPIE account to access your personal subscriptions or to use specific features such as save to my library, sign up for alerts, save searches, etc.

PERSONAL SIGN IN

No SPIE Account? Create one

PURCHASE THIS CONTENT

SUBSCRIBE TO DIGITAL LIBRARY

50 downloads per 1-year subscription

Members: $195

Non-members: $335 ADD TO CART

25 downloads per 1 - year subscription

Members: $145

Non-members: $250 ADD TO CART

PURCHASE SINGLE ARTICLE

Includes PDF, HTML & Video, when available

Members: $17.00

Non-members: $21.00 ADD TO CART

PROCEEDINGS
11 PAGES

DOWNLOAD PAPER SAVE TO MY LIBRARY

GET CITATION

RIGHTS & PERMISSIONS

Get copyright permission Get copyright permission on Copyright Marketplace

KEYWORDS

MATLAB

Latex

Optical simulations

Adaptive optics

Software development

Control systems

Computer programming

Show All Keywords

Keywords/Phrases

Search In:

Publication Years