A Typst package for reading and exporting Jupyter notebooks. It covers various use cases:
- Rendering: Convert a notebook to PDF using Typst styles.
- Extraction: Use the outputs of notebook cells in your document.
- Execution: Execute code from Typst raw blocks and include the results in the document.
Render a full notebook:
#import "@preview/callisto:0.3.0"
#set text(font: "Pennstander")
#show math.equation: set text(
font: "Pennstander Math",
)
#set heading(numbering: "I.")
#callisto.render(
nb: path("notebook.ipynb"),
(0, 1), // first two cells
) |
|
Or include the notebook as a section of a larger document:
#import "@preview/callisto:0.3.0"
#set heading(numbering: "1.")
= Introduction
Some text.
#callisto.render(
nb: path("notebook.ipynb"),
theme: "neat",
cmarker: (h1-level: 2), // subsection
(0, 1),
) |
|
For each kind of item there's a function to extract it:
#import "@preview/callisto:0.3.0"
#let (source, output, errors) = callisto.config(
nb: path("example.ipynb"),
)
The source of the "plot1" cell:
#source("plot1", keep-cell-header: true)
And its output:
#output("plot1")
#if errors().len() > 0 [
There are errors in this notebook...
] |
|
Export code blocks to a Jupyter notebook and render the results:
#import "@preview/callisto:0.3.0"
#let (output, execute, evaluate,
stage-notebook) = callisto.config(
nb: path("export.ipynb"),
kernel: "python3",
theme: "neat",
)
#show raw.where(lang: "py-x"): it => {
set text(1em/0.8)
execute(it)
}
#stage-notebook()
Here is a plot of $y = x^2$ :
```py-x
import matplotlib.pyplot as plt
plt.rcParams['figure.figsize'] = (3, 2)
x = [1, 2, 3, 4]
y = [1, 4, 9, 16]
plt.plot(x, y);
```
The plot uses #evaluate(`len(x)`) data points.
Here is how to expand $(a+b)^2$ with SymPy:
```py-x
#| output: false
import sympy as sp
a, b = sp.symbols('a b')
sp.expand((a+b)**2)
```<sympy-calc>
The result is: #output(<sympy-calc>) |
|
The export is done with typst eval, the execution with jupyter-nbconvert (see Export and Execution tutorial below).
You can share the exported notebook together with your Typst file, it's all one needs to recompile the document.
The following tutorials are meant to be read in order:
See the reference manual for all functions, available settings and additional examples.
Here are some alternatives for the "execution" use case:
-
Quarto: An amazing system for producing PDF, HTML and more from Markdown sources that include executable code blocks. Can use Typst as PDF backend.
-
Calepin: A tool that works like a mini Quarto, where you write input files in Typst instead of Markdown.
-
Jlyfish: Typst and Julia packages that work together to execute Julia code blocks from Typst documents.
-
Prequery A more generic approach to getting data out of a Typst document and back in after some processing. Can be used for executing code blocks.