Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/smimram/satex

String diagrams in LaTeX.
https://github.com/smimram/satex

latex ocaml string-diagram

Last synced: about 2 months ago
JSON representation

String diagrams in LaTeX.

Awesome Lists containing this project

README 

        
Satex is a [string diagram](https://en.wikipedia.org/wiki/String_diagram)

generator for LaTeX. It takes as input a formula such as

```

(1 * delta) * (mu * 1)

```

(appropriately written in the LaTeX file) and produces a diagram such as



![](fig/frobl.svg)



generated using TikZ.



It is inspired from [Catex](https://webusers.imj-prg.fr/~yves.guiraud/) (see

also the

[documentation](https://webusers.imj-prg.fr/~yves.guiraud/catex/catex.pdf)) for

which the sources were unfortunately not available.



In case you have a problem, please file a bug report at the following url:

.



# Installation



Installing with [opam](https://opam.ocaml.org/) is as simple as



```bash

opam install satex

```



# General usage



In order to use satex in your LaTeX file, you should first include the style

file:



```

\usepackage{satex}

```



You should then declare the operators you want to use in the format



```

\deftwocell[options]{name : m -> n}

```



which declares an operator named `name` with `m` inputs and `n` outputs. The

options in `options` allow changing the way the operator is displayed and so

on. For instance,



```

\deftwocell[triangle]{mu : 2 -> 1}

```



will declare the following operator:



![](fig/mu.svg)



One can then generate diagrams by using commands of the form



```

\twocell{expr}

```



where `expr` is a categorical expression involving operators and identities. The

identity on _n_ wires is simply written as the corresponding number and

compositions are noted `*`: toplevel compositions are vertical ones and those

inside parenthesis are horizontal. For instance



```

\twocell{(2 * mu) * (1 * mu) * mu}

```



will typeset



![](fig/rcomb4.svg)



A run of `pdflatex` on your file, say `file.tex`, will generate a file named

`file.satex`. You should then run



```

satex file.satex

```



which will generate a file `file.satix` containing the generated TikZ figures,

which are automatically included in the next run of `pdflatex` on your file.



# Options for operators



## Shapes



Various shapes are available for operators:



- `circle` (default one): ![](fig/circle.svg)

- `triangle`: ![](fig/mu.svg)

- `rectangle`: ![](fig/rectangle.svg)

- `mergeleft` / `mergeright`: ![](fig/mergeleft.svg) / ![](fig/mergeright.svg)

- `cup` / `cap`: ![](fig/cup.svg) / ![](fig/cap.svg)

- `crossing` / `crossingr`: ![](fig/crossing.svg) / ![](fig/crossingr.svg)

- `braid` / `braidl`: ![](fig/braid.svg) / ![](fig/braid2.svg)

- `crossing'` / `braid'`:  ![](fig/crossing2.svg) / ![](fig/braid2.svg)

- `blank`: ![](fig/blank.svg)



The dimension of the shape can be adjusted with the `labelwidth` and

`labelheight` parameters.



## Labels on operators



Labels are indicated between double quotes. For instance



```

\deftwocell[triangle,"\mu"]{mu : 2 -> 1}

```



typesets



![](fig/mu-label.svg)



Their vertical position can be adjusted with the `position` parameter (between

`0` and `1`).



## Colors on operators



The color of operators and wires can be changed with `color=...` options, e.g.



```

\twocell{((1->1)["\alpha",color=red] * 1) * (1[color=red] * (1->1)["\beta"])}

```



typesets



![](fig/color.svg)



Filling colors can also be specified with `fill=color` option, e.g.



![](fig/fill.svg)



## Labels on wires



The special operator `label` allows adding labels to wires. The option `d` or

`u` indicates whether the labels should be put down or up, and the above syntax

is used for labels. For instance



```

\twocell{label[d,"x","y"] * mu * label[u,"z"]}

```



typesets



![](fig/mu-lwires.svg)



## Inline operators



You can use operators which have not been declared beforehand: the syntax is `(m

-> n)[options]` to use an operator with `m` inputs, `n` outputs and given

options. For instance,



```

(1 * (1 -> 2)[rectangle,"f"]) * ((2 -> 1)["g"] * 1)

```



typesets



![](fig/inline.svg)



## Spacing



Horizontal space can be adjusted by using operators of the form `space2.8` which

adds an horizontal space of `2.8` (formally this is an operator with no inputs

and outputs).



Vertical space can be adjusted by changing the `height` parameter of one of the

operators on the line.