open-dis-python

open-dis-python copied to clipboard

open-dis-python

A Python 3 implementation of the Distributed Interactive Simulation (DIS) 7 standard. Initially generated by xmlpg.

Library installation

From source:

pip install .

For developers of this library (This installs a symlink to the sources so they can be edited and referenced in tests and examples without a reinstall):

pip install -e .

Run examples

Run a receiver:

cd examples
python3 dis_receiver.py

In another terminal, run the sender:

python3 dis_sender.py

You should also see the traffic on the net in Wireshark on your localhost interface.

Press Ctrl+\ to stop the process.

Documentation

You can auto generate API docs from the project source code:

pip install pdoc
pdoc --html --html-dir docs opendis

The docs will be generated in the docs/opendis folder.

Poetry setup

1. poetry install or poetry update
2. poetry run python examples/dis_receiver.py or poetry shell && python examples/dis_receiver.py