latex_variables.to_latex¶
-
latex_variables.to_latex(variable, name, unit=None, fmt=None)[source]¶ Converts a variable to a LaTeX variable definition
- Parameters
variable (float or int) – Variable to convert to a LaTeX variable definition.
name (str) – Variable name for the LaTeX variable. Must be a valid name for a LaTeX variable (no underscores, no dashes, only alphabetic characters).
unit (str (optional)) – Units of the variable. Default to None.
fmt (str (optional)) – Format to use for printing the variable. If None, no formatting will be done, the variable will be shown with full precision. Default to None.
- Returns
latex_variable (str) – String used to define a LaTeX variable.
Example
>>> height = 30 >>> to_latex(height, name="Height", unit="m") '\\newcommand{\\Height}{$30 \\, \\text{m}$}'
>>> density = 2670 >>> unit = "kg m-3" >>> to_latex(density, name="Density", unit="kg m-3") '\\newcommand{\\Density}{$2670 \\, \\text{kg} \\text{m}^{-3}$}'
