def py2tex(
expr,
print_latex=True,
print_formula=True,
dummy_var="u",
output="tex",
simplify_output=True,
upperscript="ˆ",
lowerscript="_",
verbose=False,
simplify_fractions=False,
simplify_ints=True,
simplify_multipliers=True,
):
"""Return the LaTeX expression of a Python formula
Parameters
----------
expr: string
a Python expression
print_latex: boolean
if True, prints the latex expression in the console
dummy_var: string
dummy variable displayed in integrals
output: 'tex' / 'word'
if 'tex', output latex formula. If word, output a Word MathTex formula
(may be a little different)
Other Parameters
----------------
simplify_output: boolean
if ``True``, simplify output. Ex::
1x10^-5 --> 10^-5.
See :func:`~pytexit.core.core.simplify` for more information.
Default ``True``
simplify_ints: boolean
if ``True``, simplify integers (useful for Python 2 expressions). Ex::
1. --> 1.
See :class:`~pytexit.core.core.LatexVisitor` for more information.
Default ``True``
simplify_fractions: boolean
if ``True``, simplify common fractions. Ex::
0.5 --> 1/2.
See :class:`~pytexit.core.core.LatexVisitor` for more information.
Default ``False``
simplify_multipliers: boolean
if ``True``, simplify float multipliers during parsing. Ex::
2*a -> 2a
See :class:`~pytexit.core.core.LatexVisitor` for more information.
Default ``True``
Returns
-------
returns the latex expression in raw text, to be used in your reports or
to display in an IPython notebook
Notes
-----
Will return ``'\\\\'`` instead of ``'\\'`` because we don't want those to be
interpreted as regular expressions. Use ``print(result)`` to get the correct
LaTex formula.
See Also
--------
:func:`~pytexit.pytexit.for2tex`
References
----------
Initial work from Geoff Reedy on StackOverflow: https://stackoverflow.com/a/3874621/5622825 . Kudos.
Similar projects:
- https://github.com/iogf/lax : "A pythonic way of writting latex."
- https://github.com/JelteF/PyLaTeX : "A Python library for creating LaTeX files"
- sympy can also write LaTeX output.
"""
# Check inputs
try:
if sys.version_info > (3, ):
assert isinstance(expr, str)
else:
assert isinstance(expr, (str, six.text_type))
except AssertionError:
raise ValueError("Input must be a string")
expr = preprocessing(expr) # removes unicode, module calls, etc.
# Parse
pt = ast.parse(expr)
if output == "tex": # LaTex output
Visitor = LatexVisitor(
dummy_var=dummy_var,
upperscript=upperscript,
lowerscript=lowerscript,
verbose=verbose,
simplify_multipliers=simplify_multipliers,
simplify_fractions=simplify_fractions,
simplify_ints=simplify_ints,
)
elif output == "word": # Word output
Visitor = WordVisitor(
dummy_var=dummy_var,
upperscript=upperscript,
lowerscript=lowerscript,
verbose=verbose,
simplify_multipliers=simplify_multipliers,
simplify_fractions=simplify_fractions,
simplify_ints=simplify_ints,
)
else:
raise ValueError("Unexpected output: {0}".format(output))
if isinstance(pt.body[0], ast.Expr):
# To deal with cases such as 'x=something'
# TODO : one single command to start the visit?
s = Visitor.visit(pt.body[0].value)
else: # For Compare / Assign expressions
s = Visitor.visit(pt.body[0])
# Simplify if asked for
if simplify_output:
s = simplify(s)
if output == "tex":
s = "$$" + s + "$$"
# Output
if print_latex and output == "tex":
try:
IPython.display.display(IPython.display.Latex(s))
except:
pass
if print_formula:
uprint(s)
return s
----------------
kwargs: dict
forwarded to :func:`~pytexit.py2tex` function. See :func:`~pytexit.py2tex`
doc.
Examples
--------
convert FORTRAN formula to LaTeX with for2tex::
for2tex(r'2.8d-11 * exp(-(26500 - 0.5 * 1.97 * 11600 )/Tgas)')
See Also
--------
:func:`~pytexit.core.fortran.for2py`, :func:`~pytexit.pytexit.py2tex`
"""
from pytexit import py2tex
return py2tex(for2py(a), **kwargs)
if __name__ == "__main__":
from test.test_functions import run_all_tests
uprint("Test completed: ", bool(run_all_tests(True)))
Other Parameters
----------------
kwargs: dict
forwarded to :func:`~pytexit.py2tex` function. See :func:`~pytexit.py2tex`
doc.
Examples
--------
convert FORTRAN formula to LaTeX with for2tex:
for2tex(r'2.8d-11 * exp(-(26500 - 0.5 * 1.97 * 11600 )/Tgas)')
See Also
--------
:func:`~pytexit.core.fortran.for2py`, :func:`~pytexit.pytexit.py2tex`
'''
from pytexit import py2tex
return py2tex(for2py(a), **kwargs)
if __name__ == '__main__':
from test.test_functions import run_all_tests
uprint('Test =', bool(run_all_tests(True)))
def py2tex(expr,
print_latex=True,
print_formula=True,
dummy_var='u',
output='tex',
simplify_output=True,
upperscript='ˆ',
lowerscript='_',
verbose=False,
simplify_fractions=False,
simplify_ints=False):
''' Return the LaTeX expression of a Python formula
Parameters
----------
expr: string
a Python expression
print_latex: boolean
if True, prints the latex expression in the console
dummy_var: string
dummy variable displayed in integrals
output: 'tex' / 'word'
if 'tex', output latex formula. If word, output a Word MathTex formula
(may be a little different)
simplify_output: boolean
if True, simplify output. Ex: 1x10^-5 --> 10^-5. Default True
simplify_ints: boolean
if True, simplify integers. Ex: 1.0 --> 1. Default False
simplify_fractions: boolean
if True, simplify common fractions. Ex: 0.5 --> 1/2. Default False
Output
------
returns the latex expression in raw text, to be used in your reports or
to display in an IPython notebook
Notes
-----
Will return '\\' instead of '\' because we don't want those to be
interpreted as regular expressions. Use print(result) to get the correct
LaTex formula.
See Also
--------
:func:`~pytexit.pytexit.for2tex`
'''
try:
if sys.version_info > (3, ):
assert (isinstance(expr, str))
else:
assert (isinstance(expr, (str, six.text_type)))
except AssertionError:
raise ValueError('Input must be a string')
expr = clean(expr) # removes module calls, etc.
# Parse
pt = ast.parse(expr)
if output == 'tex': # LaTex output
Visitor = LatexVisitor(dummy_var=dummy_var,
upperscript=upperscript,
lowerscript=lowerscript,
verbose=verbose,
simplify=simplify_output,
simplify_fractions=simplify_fractions,
simplify_ints=simplify_ints)
elif output == 'word': # Word output
Visitor = WordVisitor(dummy_var=dummy_var,
upperscript=upperscript,
lowerscript=lowerscript,
verbose=verbose,
simplify=simplify_output)
else:
raise ValueError('Unexpected output: {0}'.format(output))
if isinstance(pt.body[0], ast.Expr):
# To deal with cases such as 'x=something'
# TODO : one single command to start the visit?
s = Visitor.visit(pt.body[0].value)
else: # For Compare / Assign expressions
s = Visitor.visit(pt.body[0])
# Simplify if asked for
if simplify_output:
s = simplify(s)
if output == 'tex':
s = '$$' + s + '$$'
# Output
if print_latex and output == 'tex':
try:
IPython.display.display(IPython.display.Latex(s))
except:
pass
if print_formula:
uprint(s)
return s
----------------
kwargs: dict
forwarded to :func:`~pytexit.py2tex` function. See :func:`~pytexit.py2tex`
doc.
Examples
--------
convert FORTRAN formula to LaTeX with for2tex::
for2tex(r'2.8d-11 * exp(-(26500 - 0.5 * 1.97 * 11600 )/Tgas)')
See Also
--------
:func:`~pytexit.core.fortran.for2py`, :func:`~pytexit.pytexit.py2tex`
'''
from pytexit import py2tex
return py2tex(for2py(a), **kwargs)
if __name__ == '__main__':
from test.test_functions import run_all_tests
uprint('Test completed: ', bool(run_all_tests(True)))
