naviz-python 0.1.0

Python-interface for naviz
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# Python-Package for NAViz

## Building the wheel

This package uses [`maturin`](https://github.com/PyO3/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`](https://github.com/PyO3/maturin) and the difference between the build commands,
see [`maturin`'s README](https://github.com/PyO3/maturin?tab=readme-ov-file#maturin).

## Usage

The python-library currently only exports a simple functionality to export a visualization as a video.
An example can be seen below:
```python
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
```