https://github.com/wifasoi/WaveDromTikZ

An implementation of WaveDrom which outputs TikZ for use in LaTeX documents.
https://github.com/wifasoi/WaveDromTikZ

Last synced: 2 months ago
JSON representation

An implementation of WaveDrom which outputs TikZ for use in LaTeX documents.

• Host: GitHub
• URL: https://github.com/wifasoi/WaveDromTikZ
• Owner: wifasoi
• License: mit
• Created: 2014-07-08T08:53:57.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2021-12-05T22:19:53.000Z (about 3 years ago)
• Last Synced: 2024-08-03T01:38:28.856Z (6 months ago)
• Language: Python
• Size: 252 KB
• Stars: 41
• Watchers: 4
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
WaveDrom TikZ

=============

This simple (unofficial) tool is a translator from the language used by the

excellent [WaveDrom](http://wavedrom.github.io/) waveform drawing tool to TikZ

allowing for professional looking waveforms in LaTeX documents. By producing

TikZ, diagrams are typeset in native LaTeX and lines and shapes are drawn

consistently with other TikZ figures in a document. Further, more sophisticated

annotations are possible by referencing parts of the wavefrom from custom TikZ

code.

This tool is currently in an incomplete and largely undocumented state. All

drawing of waveforms should be supported correctly but arrows and annotations

are not.

## Example

A simple example waveform.

```

{

  signal: [

    { name : "clk",  wave : "p....|.." },

    { name : "data", wave : "x===.|.x", data: "a b c" },

    { name : "vld",  wave : "01...|.0" },

    { name : "rdy",  wave : "1..0.|1." },

  ]

}

```

Which can be built from within LaTeX source:

```

\begin{tikzpicture}[thick]

	\input{|"wavedromtikz.py wavedrom figures/rdyvld-protocol.drom"}

\end{tikzpicture}

```

Producing:

![WaveDromTikZ example waveform](http://jhnet.co.uk/misc/waveDromTikZ.png)

For comparison, the original WaveDrom image:

![Regular WaveDrom example waveform](http://jhnet.co.uk/misc/waveDrom.png)

### More Examples

Make the example pdf file from project root using

    ./make.sh