naviz-python

Crates.ionaviz-python
lib.rsnaviz-python
version0.1.0
created_at2025-10-19 22:46:31.199981+00
updated_at2025-10-19 22:46:31.199981+00
descriptionPython-interface for naviz
homepage
repositoryhttps://github.com/cda-tum/mqt-naviz
max_upload_size
id1891095
size70,720
(FloezeTv)

documentation

README

Python-Package for NAViz

Building the wheel

This package uses maturin to export this crate as a python wheel. The wheel can be built using maturin build or alternatively maturin develop for faster development-build. For more information on maturin and the difference between the build commands, see maturin's README.

Usage

The python-library currently only exports a simple functionality to export a visualization as a video. An example can be seen below:

from naviz import *

# Get machine and style from repository:
machine = Repository.machines().get('example')
style = Repository.machines().get('tum')

# Alternatively, you can also use manual configurations:
machine = "<...>"
style = "<...>"

# Render `naviz` instructions to `out.mp4` at 1080p60:
export_video("<naviz instructions>", "out.mp4", (1920, 1080), 60, machine, style)

# Render mqt na output to `out.mp4` at 1080p60 with the default import options:
export_video("<mqt na instructions>", "out.mp4", (1920, 1080), 60, machine, style, default_import_settings("MqtNa")) # Alternatively substitute the call to `default_import_settings` with your custom import settings
Commit count: 0

cargo fmt