Development Setup

Introduction

This is a brief guide to getting started with making modifications to Prunt and testing them in the simulator.

Requirements

Prunt requires any modern Linux system with NPM installed (used for building the web UI). The simulator requires Python 3 with numpy and matplotlib for plotting.

Install Alire

Alire is the build system and package manager used by Prunt. It can be downloaded from https://alire.ada.dev/.

Clone the repositories

Use git to clone the Prunt repository from https://github.com/Prunt3D/prunt.git and the simulator repository from https://github.com/Prunt3D/prunt_simulator.git.

The simulator assumes that the path to the local Prunt version is ../prunt. If you would like to change this you can do so in prunt_simulator/alire.toml.

Build and run the simulator

The simulator can be built by running alr build. You can then run the simulator and the plotter with the following command:

stdbuf -oL -eL ./bin/prunt_simulator | stdbuf -oL -eL awk '/DATA OUTPUT,/ {print > "/dev/stdout"} !/DATA OUTPUT,/ {print > "/dev/stderr"}' | stdbuf -oL -eL python3 ./continuous_plot.py