cape.filecntl.tex: Interface to LaTeX files

This is a module built off of the cape.filecntl.FileCntl class customized for manipulating Cape’s automated reports. In addition to containing methods for reading, writing, and organizing lines of text, it contains a Compile() method for compiling the PDF and sparing the user from constructing the system command to do so.

See the cape.cfdx.report module or the JSON report page page for more information.

class cape.filecntl.tex.Tex(fname='report.tex')

File control class for LaTeX files

Call:

>>> TX = cape.tex.Tex()
>>> TX = cape.tex.Tex(fname='report.tex')

Inputs:

fname: str

Name of LaTex report file to read/write

Outputs:

TX: cape.tex.Tex

Instance of LaTeX report interface

Versions:

• 2015-03-07 @ddalle: Started

• 2015-03-10 @ddalle: First version

Compile(check=True)

Compile the LaTeX file

Call:

>>> TX.Compile(check=True)

Inputs:

TX: cape.tex.Tex

Instance of LaTeX report interface

check: {True} | False

Whether or not to fail if there is a nonzero compile status

Versions:

• 2015-03-07 @ddalle: First version

• 2017-03-07 @ddalle: Added check