Installation

tikz-feyn can be installed in several ways, depending on your needs.

Quick Install (Single Project)

For use in a single LaTeX project:

  1. Download tikz-feyn.sty from the releases page

  2. Place the file in your project directory (same directory as your .tex file)

  3. Add to your LaTeX document:

    \usepackage{tikz-feyn}
    

System-Wide Installation

For system-wide installation on Linux/macOS/Windows:

Linux and macOS

  1. Download the latest release archive from the releases page

  2. Extract the archive

  3. Copy tikz-feyn.sty to your local texmf tree:

    • Linux: ~/texmf/tex/latex/tikz-feyn/

    • macOS: ~/Library/texmf/tex/latex/tikz-feyn/

  4. Update the TeX filename database:

    texhash
    

    or

    mktexlsr
    

Windows

  1. Download the latest release archive from the releases page

  2. Extract the archive

  3. Copy tikz-feyn.sty to: %USERPROFILE%\texmf\tex\latex\tikz-feyn\

  4. Update the TeX filename database using your TeX distribution’s package manager

Installing from Source

To install from the Git repository:

git clone https://github.com/transientlunatic/tikz-feyn.git
cd tikz-feyn
# Copy tikz-feyn.sty to your texmf tree as described above

Verifying Installation

Create a test document:

\documentclass{article}
\usepackage{tikz-feyn}
\begin{document}

\begin{tfeyn}
  \tfcol{i}
  \tfcol{o}
  \tf[f]{i,o}
\end{tfeyn}

\end{document}

Compile with:

pdflatex test.tex

If the document compiles without errors, tikz-feyn is correctly installed.

Requirements

tikz-feyn requires the following LaTeX packages:

  • tikz - The PGF/TikZ graphics package

  • xparse - For advanced command parsing

  • ifthen - For conditional logic

All of these are included in standard LaTeX distributions such as TeXLive and MiKTeX.

Troubleshooting

Package Not Found

If you get an error like ! LaTeX Error: File 'tikz-feyn.sty' not found:

  • Verify the file is in your project directory or texmf tree

  • Run texhash or mktexlsr after system-wide installation

  • Check file permissions

Missing Dependencies

If you get errors about missing packages:

  • Install the required packages using your TeX distribution’s package manager

  • For TeXLive: tlmgr install tikz xparse ifthen

  • For MiKTeX: Use the MiKTeX Package Manager GUI

TikZ Library Errors

If you encounter errors about missing TikZ libraries:

  • Ensure you have a recent version of PGF/TikZ (version 3.0 or later recommended)

  • Update your LaTeX distribution if necessary