Visit the documentation at kima.science

Local development

The documentation is built using Zensical:

$ # pip install zensical

$ zensical serve
Serving .../kima-docs/site on http://localhost:8000

Examples

Each individual example can be found in the docs/docs/examples folder. Most examples are Marimo notebooks, which can be edited with

$ marimo edit [example_name].py

These marimo notebooks are automatically exported to Jupyter notebooks, ending up in the docs/docs/examples/__marimo__ folder. Then, the Jupyter notebooks are converted to Markdown using the make notebooks command.

.PHONY: notebooks

NOTEBOOK_PATH := docs/docs/examples/__marimo__
NOTEBOOK_OUT_DIR := --output-dir=docs/docs/examples/
JUPYTER = --from jupyter-core jupyter

notebooks:
	uvx $(JUPYTER) nbconvert.exe --to markdown $(NOTEBOOK_PATH)/51Peg.ipynb $(NOTEBOOK_OUT_DIR)
	...

$ make notebooks

Native Jupyter notebooks can also be added and converted in the same way.

Caution

The output from a kima run may not display correctly in a Jupyter notebook, so using a native Jupyter notebook for the examples is not recommended.