Skip to content

Installation

Install texer using pip:

pip install texer

From Source

Clone the repository and install in development mode:

git clone https://github.com/yourusername/texer.git
cd texer
pip install -e .

Optional Dependencies

For Development

To install development dependencies (testing, type checking):

pip install -e ".[dev]"

For Documentation

To build the documentation locally:

pip install -e ".[docs]"

Then serve the docs:

mkdocs serve

LaTeX Requirements

For PDF Compilation

If you want to compile LaTeX to PDF using compile_to_pdf(), you need a LaTeX distribution installed:

sudo apt-get install texlive-latex-base texlive-pictures

brew install --cask mactex

Download and install either:

Required LaTeX Packages

texer generates LaTeX that requires these packages. They're typically included in standard LaTeX distributions:

  • For tables with rules: booktabs
  • For colored text: xcolor
  • For plots: pgfplots (with compat=1.18)
  • For multiple subplots: pgfplots with groupplots library
  • For multirow cells: multirow

Verify Installation

Check that texer is installed correctly:

import texer
print(texer.__version__)

You should see the version number printed without errors.

Next Steps

Now that you have texer installed, learn about: