21-25 May 2012
New York City, NY, USA
US/Eastern timezone

Developing CMS software documentation system

24 May 2012, 13:30
4h 45m
Rosenthal Pavilion (10th floor) (Kimmel Center)

Rosenthal Pavilion (10th floor)

Kimmel Center

Poster Collaborative tools (track 6) Poster Session

Speaker

Mantas Stankevicius (Vilnius University (LT))

Description

CMSSW (CMS SoftWare) is the overall collection of software and services needed by the simulation, calibration and alignment, and reconstruction modules that process data so that physicists can perform their analysie. It is a long term project, with a large amount of source code. In large scale and complex projects is important to have as up-to-date and automated software documentation as possible. The core of the documentation should be version-based and available online with the source code. CMS uses Doxygen and Twiki as main tools to provide automated and non-automated documentation. Both of them are heavily cross-linked to prevent duplication of information. Doxygen is used to generate functional documentation and dependency graphs from the source code. Twiki is divided into two parts: WorkBook and Software guide. WorkBook contains tutorial-type instructions on accessing computing resources and using the software to perform analysis within the CMS collaboration and Software guide gives further details. This note describes the design principles, the basic functionalities and the technical implementations of the CMSSW documentation.

Primary author

Mantas Stankevicius (Vilnius University (LT))

Co-authors

Kati Lassila-Perini (Helsinki Institute of Physics (FI)) Prof. Sudhir Malik (University of Nebraska-Lincoln)

Presentation Materials

There are no materials yet.