Cargando…

Developing CMS software documentation system

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 analyses. It is a long term project, with a large amount of source code. In large scale and c...

Descripción completa

Detalles Bibliográficos
Autor principal: Stankevicius, Mantas
Lenguaje:eng
Publicado: 2012
Materias:
Acceso en línea:https://dx.doi.org/10.1088/1742-6596/396/6/062020
http://cds.cern.ch/record/1457413
_version_ 1780925112191549440
author Stankevicius, Mantas
author_facet Stankevicius, Mantas
author_sort Stankevicius, Mantas
collection CERN
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 analyses. 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 the 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 functionality and the technical implementations of the CMSSW documentation.
id cern-1457413
institution Organización Europea para la Investigación Nuclear
language eng
publishDate 2012
record_format invenio
spelling cern-14574132019-09-30T06:29:59Zdoi:10.1088/1742-6596/396/6/062020http://cds.cern.ch/record/1457413engStankevicius, MantasDeveloping CMS software documentation systemDetectors and Experimental TechniquesCMSSW (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 analyses. 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 the 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 functionality and the technical implementations of the CMSSW documentation.CMS-CR-2012-060oai:cds.cern.ch:14574132012-05-09
spellingShingle Detectors and Experimental Techniques
Stankevicius, Mantas
Developing CMS software documentation system
title Developing CMS software documentation system
title_full Developing CMS software documentation system
title_fullStr Developing CMS software documentation system
title_full_unstemmed Developing CMS software documentation system
title_short Developing CMS software documentation system
title_sort developing cms software documentation system
topic Detectors and Experimental Techniques
url https://dx.doi.org/10.1088/1742-6596/396/6/062020
http://cds.cern.ch/record/1457413
work_keys_str_mv AT stankeviciusmantas developingcmssoftwaredocumentationsystem