Lepton : An automaton for Literate Executable Papers - Archive ouverte HAL Accéder directement au contenu
Article Dans Une Revue Journal of Open Source Software Année : 2019

Lepton : An automaton for Literate Executable Papers

Résumé

Source code is very hard to maintain when the documentation is missing. Recognizing this fact, Knuth (1984) proposed the literate programming paradigm, i.e., that source code and documentation should be written at the same time, inside the same file, and in a format designed for human understanding. ‘’Lepton” is a tool for writing reproducible research papers and similar documents by extending literate programming to data analysis reports. ‘’Lepton” makes it easy to include scripts or complete programs, compilation and execution instructions, as well as execution results in the same file. Offloading execution to ‘’Lepton” makes the analysis operator-independent and easy to reproduce. In the spirit of literate programming, the plain text file format used by ‘’Lepton” is intended to be human-understandable as opposed to machine-readable, and simple enough to be usable without the software. Among the current approaches proposed for reproducible research, ‘’Lepton” focuses on: • offline execution so that results are operator independent, • long-term maintainability of ‘’Lepton” itself and the documents produced with it through a plain text format and a well documented reference implementation • adaptability: users are not tied to a single data analysis environment such as R, C or Python but can use them concurrently, and users can document freely regardless of the constraints of the programming language. ‘’Lepton” consists in a standalone executable that processes plain text files written in a documentation format such as HTML or LaTeX with optional blocks that can contain files to be written to disk, source code or executable instructions. It is distributed as a ‘’Lepton” file containing the full source code, manual, and a tutorial (Li-Thiao-Té, 2018). The package contains an extracted copy of the source code that can be compiled without ‘’Lepton’‘. The public repository is hosted on Github.’‘Lepton” has been used in research publications related to teaching computational science and reproducible research (Li-Thiao-Té, 2012a, 2012b).
Fichier principal
Vignette du fichier
10.21105.joss.01005.pdf (112.64 Ko) Télécharger le fichier
Origine : Fichiers produits par l'(les) auteur(s)

Dates et versions

hal-03943612 , version 1 (17-01-2023)

Licence

Paternité

Identifiants

Citer

Sébastien Li-Thiao-Té. Lepton : An automaton for Literate Executable Papers. Journal of Open Source Software, 2019, 4 (42), pp.1005. ⟨10.21105/joss.01005⟩. ⟨hal-03943612⟩
18 Consultations
11 Téléchargements

Altmetric

Partager

Gmail Facebook X LinkedIn More