naviz-python 0.1.0

Python-interface for naviz
docs.rs failed to build naviz-python-0.1.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

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