circuitypst

A port of circuitikz to Typst using typst-canvas. Due to the size of circuitikz features will be ported as I need them for my own work, if theres a feature you need feel free to make an issue, PR or contact me through Typst's discord (same username)!

"Installation"

Because of Typst's current lack of package management the library expects to be placed in the same folder as typst-canvas.

typst-canvas/
circuitypst/

You can either clone the repository or download it as a .zip and extract it to the required location.

Usage

To get started node and to should be imported from circuitypst.typ, ideally inside typst-canvas's canvas function.

Here is a template:

#import "typst-canvas/canvas.typ": canvas

#canvas(length: 1cm, debug: false, {
  import "typst-canvas/draw.typ": *
  import "circuitypst/circuitypst.typ": node, to
  ...
})

Also see examples/ for some examples.

Testing

This package comes with some unit tests under the tests directory. To run all tests you can run the just test target.

You need to have ImageMagick installed on your system, which is needed for image comparison.

Windows

If you are using the Chocolatey package manager, you can install imagemagick using choco install imagemagick. Otherwise download and install a matching package from the ImageMagick website.

Requirements for First Stable Release