https://github.com/avitase/feynmaker

Docker container that helps to create Feynman diagrams as PDF files with the Feynmf LaTeX package.
https://github.com/avitase/feynmaker

docker-container feynman-diagrams feynmf

Last synced: 4 days ago
JSON representation

Docker container that helps to create Feynman diagrams as PDF files with the Feynmf LaTeX package.

• Host: GitHub
• URL: https://github.com/avitase/feynmaker
• Owner: avitase
• Created: 2018-10-02T12:12:44.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-14T15:42:44.000Z (over 6 years ago)
• Last Synced: 2025-04-06T07:39:52.447Z (2 months ago)
• Topics: docker-container, feynman-diagrams, feynmf
• Language: TeX
• Homepage:
• Size: 23.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Feynmaker

![Docker Build Status](https://img.shields.io/docker/build/avitase/feynmaker.svg)

The container exposes a way to create Feynman diagrams as PDF files using the famous [Feynmf package](https://arxiv.org/abs/hep-ph/9505351). The idea is to mount your current directory to `/input` (read-only) and the desired output directory for the PDF file to `/output`. Say you want to generate a Feynman diagram from [example.tex](example.tex):

```

> cat example.tex

\begin{fmfgraph*}(35,25)

    \fmfbottom{i1,d1,o1}

    \fmftop{i2,d2,o2}

    \fmf{fermion}{i1,v1}

    \fmf{fermion,label=$\uquark,,\cquark,,\tquark$,label.side=left}{v1,v2}

    \fmf{fermion}{v2,o1}

    \fmf{fermion}{v3,i2}

    \fmf{fermion,label=$\uquarkbar,,\cquarkbar,,\tquarkbar$,label.side=left}{v4,v3}

    \fmf{fermion}{o2,v4}

    \fmfv{l=$\bquarkbar$,l.a=180}{i2}

    \fmfv{l=$\dquark$,l.a=180}{i1}

    \fmfv{l=$\bquark$,l.a=0}{o1}

    \fmfv{l=$\dquarkbar$,l.a=0}{o2}

    \fmffreeze

    \fmf{photon,label=$W$}{v3,v1}

    \fmf{photon,label=$W$}{v2,v4}

    \fmfdotn{v}{4}

\end{fmfgraph*}

```

by calling `./feynmaker.sh example.tex`.

This will wrap the content of [example.tex](example.tex) with the template defined in [template.tex](template.tex) and run the necessary `latex`, `mpost` and `pdflatex` commands for you and eventually exports the resulting PDF file to your current working directory (this is the default for the mount point of `/output`, defined in [feynmaker.sh](feynmaker.sh).)

```

> rm -f exmaple.pdf

> ./feynmaker.sh example.tex > /dev/null && ls -1t | head -n1

example.pdf

```

You can specify a dedicated build directory by passing `--output-dir=my-fancy-build-directory` to `./feynmaker.sh`. This directory will be mounted to `/output/` and inhabit your desired PDF file.

## Docker Pull Command

The container is accessible via the [Docker Hub](https://hub.docker.com/r/avitase/feynmaker/): `docker pull avitase/feynmaker`.

You can create your own `Dockerfile` and install additional dependencies of your project via `apt-get` or define your own template file.