Reproducible computational experiments using SCons

Creating reproducible documentation

You are done with computational experiments and want to communicate them in a paper. SCons helps us create high-quality papers, where computational results (figures) are integrated with papers written in L^ATEXThe corresponding SCons extension is defined in $RSFROOT/lib/rsftex.py where RSFROOT is the environmental variable to the Madagascar installation directory. The source of this file is in python/rsftex.py. We summarize the basic methods and commands in Tables 3 and 4.

Paper($<$paper_name$>$,[,lclass][,use][,include][,options])

A rule to compile $<$paper_name$>$.tex L^ATEX document using the L^ATEX2e class specified in lclass (default is geophysics.cls from the SEGTeX package) with additional options specified in options, additional packages specified in use, and additional preamble specified in include

End()

A rule to collect default targets (referring to paper.tex document).

Table 3. Basic methods of an rsf.tex object.

scons

Generate the default target (usually the PDF file paper.pdf from the source L^ATEX file paper.tex.)

scons pdf or scons $<$paper_name$>$.pdf

Generate PDF files from L^ATEX sources paper.tex or $<$paper_name$>$.tex.

scons read or scons $<$paper_name$>$.read

Generate PDF files from L^ATEX sources paper.tex or $<$paper_name$>$.tex and display them on the screen.

scons print or scons $<$paper_name$>$.print

Generate PDF files from L^ATEX sources paper.tex or $<$paper_name$>$.tex and print them.

scons html or scons $<$paper_name$>$.html

Generate HTML files from L^ATEX sources paper.tex or $<$paper_name$>$.tex using L^ATEXtoHTML. The directory $<$paper_name$>$_html gets created.

scons install or scons $<$paper_name$>$.install

Generate PDF and HTML files from L^ATEX sources paper.tex or $<$paper_name$>$.tex and install them in a separate location (used for publishing on a web site).

scons wiki or scons $<$paper_name$>$.wiki

Convert L^ATEX sources paper.tex or $<$paper_name$>$.tex to the MediaWiki format (used for publishing on a Wiki web site).

Table 4. SCons commands defined in rsf.tex.

Reproducible computational experiments using SCons