cetz

CeTZ

CeTZ (CeTZ, ein Typst Zeichenpaket) is a library for drawing with Typst with an API inspired by TikZ and Processing.

Examples

Karl's Picture	Pacioli's construction of the icosahedron	Plate Capacitor
Tree Layout	Periodic Table of Elements	Waves
Torus

Click on the example image to jump to the code.

You can explore an example gallery of scientific diagrams at janosh.github.io/diagrams.

Usage

For information, see the API Reference (PDF) or the online manual.

To use this package, simply add the following code to your document:

#import "@preview/cetz:0.5.3"

#cetz.canvas({
  import cetz.draw: *
  // Your drawing code goes here
})

CeTZ Libraries

• cetz-plot - Plotting and Charts Library
• cetz-venn - Simple two- or three-set Venn diagrams

Installing

To install the CeTZ package under your local typst package dir you can use the install script from the repository.

Make sure to first perform a recursive git clone

# to fetch a clean clone:
git clone --recursive https://github.com/cetz-package/cetz.git
# or if you forgot the `--recursive` flag before:
git submodule update --init

and also ensure you have just and cargo installed.

nix --extra-experimental-features 'nix-command flakes' develop

Now use the installation script:

just install

The installed version can be imported by prefixing the package name with @local.

#import "@local/cetz:0.5.3"

#cetz.canvas({
  import cetz.draw: *
  // Your drawing code goes here
})

Just

This project uses just, a handy command runner.

You can run all commands without having just installed, just have a look into the justfile. To install just on your system, use your systems package manager. On Windows, Cargo (cargo install just), Chocolatey (choco install just) and some other sources can be used. You need to run it from a sh compatible shell on Windows (e.g git-bash).

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 tytanic in your PATH: cargo install tytanic.

Projects using CeTZ

• finite Finite is a Typst package for rendering finite automata.
• fletcher Package for drawing commutative diagrams and figures with arrows.
• chronos Package for drawing sequence diagrams.
• circuiteria Package for drawing circuits.
• zap Package for drawing standard electronic circuits.
• bone Package to draw structural analysis and kinematic diagrams
• rivet Package for drawing instruction / register diagrams.
• plotsy-3d Package for rendering 3D objects & plots.
• alchemist A package to render skeletal formulae using a human-readable format using cetz.
• deckz Render Poker-Style playing cards.
• neural-netz Visualize neural network architectures.
• energy-dia Library for creating professional energy diagrams in chemistry and physics.
• conchord Package for writing lyrics with chords that generates fretboard diagrams.
• gribouille Create elegant graphics with the Grammar of Graphics for Typst.
• magic-cubes Package for drawing Rubik’s cubes of arbitrary size.
• VisualCeTZ An adoption of VisualTikZ to cetz.